Árvore de páginas

WO de Time Sheet em lote via Rest

Características do Requisito

Linha de Produto:

Microsiga Protheus®

Segmento:

Jurídico

Módulo:

SIGAPFS - Pré-Faturamento de Serviços

Rotina:

Rotina

Nome Técnico

JurRESTFun
Função genérica para execução de funções via Rest

Rotina(s) envolvida(s)

Nome Técnico

JURA145

Inclusão de WO - Time Sheets

Requisito:

DJURFAT1-196

País(es):

Brasil

Banco(s) de Dados:

Todos

Tabelas Utilizadas:

RD0 - Pessoas/Participantes

NUF - WO

NUE - Lançamento de Time Sheet

NXV - Cadastro de Motivo de WO

Descrição

Implementação do serviço '/JuRRESTFun/execFun/WO_TS', que permite executar WO de Time Sheet em lote via REST.

 

Procedimento para Utilização

  • Utilize o método POST com o link exemplo: http://[Endereço Server REST]/JuRRESTFun/execFun/WO_TS .
  • No Headers, é obrigatório conter o Content-Type.
  • Para enviar os Time Sheet  para o WO, envie um arquivo em JSON ou XML com os dados abaixo (todos os campos são obrigatórios):
    • PARAMETROS - Agrupador do XML (Utilizado apenas em arquivos em  XML).
    • aCodTs               - Agrupador dos Códigos de Time Sheet.
    • cCodTs               - Código do Time Sheet. (Utilizado apenas em arquivos em  XML).
    • cCodMotv           - Código de Motivo de WO.
    • cCodPart            - Código do Participante que efetuou o WO.
    • cMsgWo             - Observação do WO.
  • Exemplo de XML a ser enviado:

<?xml version='1.0'?>
          <PARAMETROS>
                   <aCodTs>
                           <cCodTs>000000000082</cCodTs>
                           <cCodTs>000000000083</cCodTs>
                           <cCodTs>000000000084</cCodTs>
                   </aCodTs>
                   <cCodMotv>001</cCodMotv>
                   <cCodPart>000010</cCodPart>
                   <cMsgWo>Teste Mensagem de WO</cMsgWo>
          </PARAMETROS>

  • Exemplo de JSON a ser enviado:

{

      "aCodTs": ["000000000082","000000000083","000000000084"],
      "cCodMotv":"001",
      "cCodPart":"000010",
      "cMsgWo":"Teste Mensagem de WO"
}

  • O tipo de arquivo de retorno, é igual ao arquivo enviado/Content-Type
  • Exemplo de retorno em  XML:

<?xml version='1.0' encoding='UTF-8'?>
            <totvs_total>3</totvs_total>
            <hasNext>true</hasNext>
            <result>
                        <return>
                                    <codigoTS>000000000082</codigoTS>
                                    <codigoWO></codigoWO>
                                    <obs>Time Sheet já Concluído.</obs>
                        </return>
                        <return>
                                    <codigoTS>000000000083</codigoTS>
                                    <codigoWO>00000130</codigoWO>
                                    <obs></obs>
                        </return>
                        <return>
                                    <codigoTS>000000000084</codigoTS>
                                    <codigoWO>00000130</codigoWO>
                                    <obs></obs>
                        </return>
            </result>

 

  • Exemplo de retorno em  JSON:

{
            "totvs_total": 3,
            "hasNext": true,
            "return": [
                        {
                                    "codigoTS": "000000000082",
                                    "codigoWO": "",
                                    "obs": "Time Sheet já Concluído."
                        },
                        {
                                    "codigoTS": "000000000083",
                                    "codigoWO": "00000130",
                                    "obs": ""
                        },
                        {
                                    "codigoTS": "000000000084",
                                    "codigoWO": "00000130",
                                    "obs": ""
                        }
                        ]
}