Árvore de páginas

Versões comparadas

Chave

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

...

pi-reapprove-v1

Requisito

Nenhum.

Descrição

Realiza a re-aprovação de pendência(s).

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para re-aprovação de pendência(s):

pathParams:  Informar: reapprove

payload:

  • transactions: Transações de pendências que devem ser aprovadas (pode ser uma ou várias):
    • transactionNumber: Número da transação
    • approveText: Comentário da aprovação


Bloco de código
titleExemplo
{
    "pathParams": [
       "reapprove"
    ],
    "payload": {
       "transactions": [
          {
             "transactionNumber": 90390
          }
       ],
       "approveText": "Re-aprovada!"
    },
}
oOutputJsonObjectOUTPUT

Informações da re-aprovação:


Bloco de código
titleExemplo
{
  "status": 200,
  "payload": {
    "sucessProcess": true
  }
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a re-aprovação das pendências.

Retorno

Informação de sucesso ou erros ocorridos no processo de re-aprovação.

pi-query-attachments-v2

Requisito

Nenhum.

Descrição

Retorna a lista de anexos disponíveis para determinado documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para retornar a lista de anexos:

pathParams:  Informar: attachments  e o número da transação


Bloco de código
titleExemplo
{
    "pathParams": [
    "attachments",
    "19308"
  ],
}
oOutputJsonObjectOUTPUT

listagem dos anexos do documento:


Bloco de código
titleExemplo
{
    "payload": {
        "total": 3,
        "hasNext": false,
        "items": [
            {
                "internalId": "1",
                "transactionNumber": "412297",
                "name": "arquivo1.png",
                "description": "anexo de teste",
                "creationDatetime": "2020-02-01T08:00:00.000",
                "group": ""
            },
            {
                "internalId": "2",
                "transactionNumber": "412297",
                "name": "arquivo2.pdf",
                "description": "anexo de teste 2",
                "creationDatetime": "2022-02-01T08:00:00.000",
                "group": "teste"
            },
            {
                "internalId": "3",
                "transactionNumber": "412297",
                "name": "arquivo3.doc",
                "description": "anexo de teste 3",
                "creationDatetime": "2022-05-13T08:00:00.000",
                "group": "teste3"
            }
        ]
    },
    "status": 200
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos na busca dos anexos do documento.

Retorno

Informação de sucesso ou erros ocorridos no processo de criação da listagem dos anexos.

pi-get-attach-content-v2

Requisito

Nenhum.

Descrição

Retorna a lista de conteúdo dos anexos de um determinado documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para retornar a lista de anexos:

pathParams:  Informar:

  • attachmentsContent 
  • número da transação
  • número do ID do anexo


Bloco de código
titleExemplo
{
    "pathParams": [
    "attachments",
    "412297",
	"2"
  ],
}
oOutputJsonObjectOUTPUT

listagem dos anexos do documento:


Bloco de código
titleExemplo
{
    "payload": {
        "total": 3,
        "hasNext": false,
        "items": [
            {
                "internalId": "1",
                "transactionNumber": "412297",
                "name": "arquivo1.png",
                "description": "anexo de teste",
                "creationDatetime": "2020-02-01T08:00:00.000",
                "group": ""
            },
            {
                "internalId": "2",
                "transactionNumber": "412297",
                "name": "arquivo2.pdf",
                "description": "anexo de teste 2",
                "creationDatetime": "2022-02-01T08:00:00.000",
                "group": "teste"
            },
            {
                "internalId": "3",
                "transactionNumber": "412297",
                "name": "arquivo3.doc",
                "description": "anexo de teste 3",
                "creationDatetime": "2022-05-13T08:00:00.000",
                "group": "teste3"
            }
        ]
    },
    "status": 200
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos na busca dos anexos do documento.

Retorno

Informação de sucesso ou erros ocorridos no processo de criação da listagem dos anexos.

pi-process-pending-v1

Requisito

Nenhum.

Descrição

Realiza a aprovação, reprovação ou re-aprovação de pendências.

Parâmetros

Tipo

Input/Output

Descrição

iActionINTEGERINPUT

Ação 

1 - Aprovação

2 - Reprovação

3 - Reaprovação

ttTransactionsTEMP-TABLEINPUTLista de transações a serem processadas
cTextCHARACTERINPUTComentário de aprovação/reprovação
iRejectionCodeINTEIROINPUTCódigo de rejeição
sucessProcessLOGICALOUTPUTIndica o processamento com sucesso (de pelo menos uma pendência)
RowErrorsTEMP-TABLEOUTPUTInformações sobre os erros ocorridos durante o processo de aprovação/reprovação.

Retorno

Informação de sucesso ou erros ocorridos no processamento das pendências.

...