APIs - Tutoriais

GetThirdPartyRequestByStatus

22 views 18/06/2021 21/06/2021 alex-serodio 0

GetThirdPartyRequestByStatus

Lista as solicitações de aplicações terceiras por status.

Payload de entrada:

{
    "processKey": "string",     // nome da chave do processo
    "status": "Pending"         // status da pendência. Pode ser Pending, Treated ou All
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getThirdPartyRequestByStatus" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'processKey': 'string', 'status': 'Pending' }"

Responses:

  • 200 OK
    {
        "requests": [
            {
                "flowToken": {                  // identificador da pendência
                    "processInstanceID": 0,     // identificador da instância do processo
                    "step": 0,                  // identificador da etapa do processo
                    "activityId": 0             // identificador da atividade
                },
                "thirdpartyId": "string",       // identificador da aplicação terceira
                "processData": "string"         // dados das variáveis do processo
            }
        ]
    }
  • 400 Bad Request: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente
    {
       "message": "Descrição do erro",
       "errorCode": "codigoDoErro",
       "reason": "BAD_REQUEST",
       "domain": "platform",
       "service": "workflow"
    }
  • 404 Not Found: Não encontrou um processo com integração de solicitações habilitado com a chave informada
    {
        "message": "Descrição do erro",
        "errorCode": "getThirdPartyRequestByStatusResponse",
        "reason": "OBJECT_NOT_FOUND",
        "domain": "platform",
        "service": "workflow"
    }
  • 401 Unauthorized: Usuário ou senha inválido
    {
       "error_description": "Descrição do erro",
       "error": "codigo_do_erro"
    }

Este artigo foi útil para você?