Linha RM

Atalhos

Páginas filhas
  • API do Processo de Retornar para "Em Edição"

Sumário

Objetivo

      Esse documento tem o objetivo de exemplificar o uso da API de Retornar para "Em Edição" alterando o seu status de maneira que fique disponível novamente para edições. Mais detalhes em Fluxo de aprovação | Processos | 05. Processos

Importante

Recurso disponível a partir da release 12.1.2406.

1 - Campos e Parâmetros

      Descrição detalhada dos campos da API de Retornar para "Em Edição".

As tabelas abaixo são divididas da seguinte maneira:

  • Campo: Identificação do campo no Json.
  • Identificador: Identificação do campo no banco de dados RM correspondente ao campo Json.
  • Tipo: Tipo de valor aceito no campo, podendo ser numérico (Int, Decimal), condicionais (Boolean), texto (String, Datetime), além do tipo List, para esse último, é esperado uma nova sequência de dados (Bloco interno).
  • Descrição: Fornece uma descrição do campo.
  • Obrigatório: Especifica se a informação é obrigatória durante operações de envio (POST, PUT, PATCH). Caso a informação seja obrigatória condicionalmente essa informação será descrita no campo Observação.
  • Observação: Informações condicionais ou importantes para o funcionamento da API serão apresentadas nesse campo.

Tipo: POST

Lote
CampoTipoDescriçãoObrigatórioObservação
Lote
CampoTipoDescriçãoObservação

CompanyId

IntCódigo da Coligada-
BatchIdIntCódigo do Lote-
ListaLista com os lotes que serão processados

Sim

-
MessageStringObservação, complemento, mensagem a ser enviada junto ao e-mailNãoNo caso de aprovação este campo não é utilizado

2 - Métodos

      Métodos disponíveis na API de Retornar para "Em Edição":

POST: Retornar para "Em Edição"

Post

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/batchLancApproval/returnToEditing

Exemplo de Configuração

Domínio: localhost

Porta: 8052

Url Utilizada: http://localhost:8052/api/ctb/v1/batchLancApproval/returnToEditing

Exemplo de Entrada

O JSON abaixo contém uma lista com os lotes que serão submetidos ao processo de retornar em edição. A lista é composta dos identificadores de cada lote (chave primária) composto do código da coligada e o código do lote e a mensagem que será enviada no e-mail.

Resultado (JSON)
{
    "BatchList": [
         {
          "CompanyId": 8,
          "BatchId": 2
        },
        {
          "CompanyId": 9,
          "BatchId": 4
        }
      ],
      "Message": "Teste"
}

Exemplo de Resultado

A saída, ou retorno da API, é uma estrutura com a lista lotes processados, sua respectiva descrição e o status de seu processamento. Caso tenha ocorrido um erro no processamento então teremos um campo mensagem com o log/descrição da situação.

Resultado (JSON)
{
    "hasNext": true,
    "items": [
        {
            "codColigada": 8,
            "codLote": 2,
            "descricao": "Lote 2",
            "status": "Success"
        },
        {
            "codColigada": 9,
            "codLote": 4,
            "descricao": "inclusao receber",
            "status": "Success"
        }
    ],
    "total": 2
}

Exemplo de Resultado Negativo

500 Internal Server Error - Resultado (JSON)
{
    "hasNext": true,
    "items": [
        {
            "codColigada": 8,
            "codLote": 2,
            "descricao": "Lote 2",
            "status": "Error",
            "mensagem": "A Coligada 8 do Lote 2 não possui o Parâmetro 'Utilizar Fluxo de Aprovação' marcado. Portanto, o lote não pode ser utilizado nesse processo."
        },
        {
            "codColigada": 9,
            "codLote": 4,
            "descricao": "inclusao receber",
            "status": "Error",
            "mensagem": "O usuário 'mestre' não possui permissão para execução deste processo na Coligada 9 do Lote 4."
        }
    ],
    "total": 2
}
  • Sem rótulos