Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


Bloco de código
languagejava
themeMidnight
titleResponse.json
collapsetrue
Content-Disposition: attachment; filename="arquivo.txt"
Content-Length: 51
Content-Type: Application/octet-stream
{
    <arquivo.txt>
}

CONTEÚDO

  1. Visão Geral
  2. Definições de Serviços
    1. GET POST - WSPfsApi/legaldesk/anexo/download/{key}JurRESTFun/wo-ts
    2. POST - WSPfsApi/legaldesk/anexo/upload JurRESTFun/wo-can
  3. Assuntos Relacionados


01. VISÃO GERAL

Os serviços especificados neste documento tem por objetivo:

  • wo_-ts  - Permitir ao usuário realizar o WO dos TimeSheets Time Sheets em lote.
  • wo-can - Permitir ao usuário enviar arquivos para o diretório spool do Protheusrealizar o cancelamento do WO em lote.

02. DEFINIÇÕES DE SERVIÇOS

 a. POST - JurRESTFun/wo-ts

Permitir ao usuário realizar o WO dos TimeSheets Time Sheets em lote.

Para enviar os Time Sheet  para Sheets 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  XMLXML).
  • aCodTs     aCodTs            - Agrupador dos Códigos de Time Sheet.
  • cCodTs     cCodTs            - Código do Time Sheet . (Utilizado apenas em arquivos em  XMLXML).
  • cCodMotv     cCodMotv       - Código de Motivo de WO.
  • cCodPart cCodPart             - Código do Participante que efetuou o WO.
  • cMsgWo     cMsgWo          - Observação do WO.


javajava.xml.json
Deck of Cards
idXML
Card
idxml
labelXML
Bloco de código
languagejava
themeMidnight
titleRequest Header Json
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/
XML
xml
Bloco de código
language
xml
themeMidnight
titleRequest Body xml
collapsetrue
<?xml version='1.0'?>
<PARAMETROS>
    <aCodTs>
         
<cCodTs>000000000082<
<cCodTs>000000000166</cCodTs>
         
<cCodTs>000000000083<
<cCodTs>000000000027</cCodTs>
         
<cCodTs>000000000084<
<cCodTs>000000000569</cCodTs>
    
</aCodTs>
    <cCodMotv>001</cCodMotv>
    
<cCodPart>000010<
<cCodPart>002215</cCodPart>
    
<cMsgWo>Teste Mensagem de WO</cMsgWo>
<cMsgWo>teste 123</cMsgWo>
</PARAMETROS>
Bloco de código
language
xml
themeMidnight
titleResponse
XML
collapsetrue
<?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>

<wo-ts>
	<wo>
		<codigoWO>00000100</codigoWO>
		<timeSheet>
			<codigoTS>000000000027</codigoTS>
			<message>
			</message>
		</timeSheet>
		<timeSheet>
			<codigoTS>000000000166</codigoTS>
			<message>
			</message>
		</timeSheet>
	</wo>
	<wo>
		<codigoWO>00000101</codigoWO>
		<timeSheet>
			<codigoTS>000000000569</codigoTS>
			<message>
			</message>
		</timeSheet>
	</wo>
</wo-ts> 
Card
idjson
labelJSON
Aviso

Para correto funcionamento do serviço rest, é necessário que as informações estejam no encoding UTF-8

Bloco de código
languagejava
themeMidnight
titleRequest Header Json
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/Json
Bloco de código
languagejava
themeMidnight
titleRequest Body Json
collapsetrue
{

  "aCodTs": ["
000000000082
000000000166", "
000000000083
000000000167", "
000000000084
000000000168"],
  
"cCodMotv": "001",
  "cCodPart": "
000010
002215",
  "cMsgWo": "
Teste
Simulacao de Mensagem 
de
do WO"
}

Bloco de código
languagejava
themeMidnight
titleResponse
Json
collapsetrue
{
"totvs_total
  "wo-ts": 
3, "hasNext": true, "return
[
    {
      "timeSheets": [
        {
"codigoTS
          "message": "
000000000082
",
"codigoWO
          "codTs": "000000000027"
, "obs": "Time Sheet já Concluído." }, { "codigoTS

        },
        {
          "message": "
000000000083
",
"codigoWO
          "codTs": "
00000130", "obs
000000000166"
        }
      ],
      "codWo": "00000102"
    },
    {
      "timeSheets": [
        {
"codigoTS
          "message": "
000000000084
",
"codigoWO
          "codTs": "
00000130", "obs
000000000569"
        }
      ],
      "codWo": "00000103"
    }
  ]
}

Obs: A transferência do arquivo é realizada via octet-stream e attachment conforme o response acima.

b. POST - WSPfsApi/legaldesk/anexo/upload

...



b. POST - JurRESTFun/wo-can

Permitir ao usuário realizar o cancelamento do WO em lote.

Para enviar os WOs para cancelamento, 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).
  • acodigoWO    - Agrupador de Códigos do WO.
  • ccodigoWO    - Código do WO (Utilizado apenas em arquivos em XML).
  • cCodMotv      - Código de Motivo de cancelamento WO.
  • cCodPart        - Código do Participante que efetuou o cancelamento de WO.
  • cMsgWo         - Observação do cancelamento de WO.


Caso ocorram problemas com os dados enviados, serão retornadas as seguintes mensagens com o códigos de erros:

No campo "errorMessage" no código de resposta http 400

01 - A observação do WO 'cMsgWo' é um campo obrigatório!
02 - O código de participante 'cCodPart' está inválido!
03 - O código do motivo de WO 'cCodMotv' está inválido!
04 - É obrigatório informar ao menos um WO! 'acodigoWO'/'ccodigoWO'!


Na tag codErr  quando a requisição retornar código http 201 (Created)

05 - WO não localizado
06 - WO já cancelado
07 - Problema para cancelar WO


Response.json
Deck of Cards
idXML
Card
idxml
labelXML
Bloco de código
languagejava
themeMidnight
titleRequest Header XML
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Accept
Content-
Encoding: gzip, deflate, br Connection: keep-alive Content-Type: multipart/form-data; boundary=--------------------------126713368602627514962789 Content-Length: 1149 ----------------------------126713368602627514962789 Content-Disposition: form-data; name=""; filename="arquivo.txt" <arquivo.txt> ----------------------------126713368602627514962789--
Type: application/XML
Bloco de código
languagexml
themeMidnight
titleRequest Body XML
collapsetrue
<?xml version='1.0'?> 
<parametros>
    <acodigoWO>
        <ccodigoWO>00000104</ccodigoWO>
        <ccodigoWO>00000105</ccodigoWO>
    </acodigoWO>
    <cCodMotv>002</cCodMotv>
    <cCodPart>002986</cCodPart>
    <cMsgWo>WO Cancelado via automacao com XML</cMsgWo>
</parametros>
Bloco de código
languagexml
themeMidnight
titleResponse XML
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<wo-can>
	<wo>
		<codigoWO>00000104</codigoWO>
		<situac>2</situac>
		<Obs>
		</Obs>
		<codErr>
		</codErr>
	</wo>
	<wo>
		<codigoWO>00000105</codigoWO>
		<situac>2</situac>
		<Obs>
		</Obs>
		<codErr>
		</codErr>
	</wo>
</wo-can> 
Card
idjson
labelJSON
Aviso

Para correto funcionamento do serviço rest, é necessário que as informações estejam no encoding UTF-8

Bloco de código
languagejava
themeMidnight
titleRequest Header Json
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/Json
Bloco de código
languagejava
themeMidnight
title
Request Body Json
collapsetrue
{
  "acodigoWO": ["00000102", "00000103"],
  "cCodMotv": "002",
 
"result
 "cCodPart": "002215",
  "cMsgWo": "
Anexo copiado
Cancelamento WO via automação com 
sucesso.
JSON"
}

Obs: A transferência do arquivo deve ser realizada via multipart/form-data conforme o header acima.

03. ASSUNTOS RELACIONADOS

...


Bloco de código
languagejava
themeMidnight
titleResponse Json
collapsetrue
{
  "wo-can": [
    {
      "codErr": "",
      "situac": "2",
      "Obs": "",
      "codWo": "00000102"
    },
    {
      "codErr": "",
      "situac": "2",
      "Obs": "",
      "codWo": "00000103"
    }
  ]
}


03. ASSUNTOS RELACIONADOS