APIs - Tutoriais

GetNextSubjectFromInitialTask

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

GetNextSubjectFromInitialTask

Obtém um ou mais responsáveis possíveis da próxima tarefa em relação a tarefa inicial do processo.

Payload de entrada:

{
    "processId": 1,                 // identificador do Processo
    "processVersion": 1,            // versão do Processo
    "sequenceName": "string",       // nome da sequência do Processo Modelador
    "customParams": [               // parametros para Mecanismo Customizado (opcional)
        {
            "key": "string",
            "value": "string"
        }
    ],
    "authorization": "string"       // token de autenticação da G7 (opcional)
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getNextSubjectFromInitialTask" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'processId': 1, 'processVersion': 1, 'sequenceName': 'string', 'customParams': [{ 'key': 'string', 'value': 'string' }], 'authorization': 'string' }"

Responses:

  • 200 OK
    {
        "subjects": [                   // responsáveis que podem receber a atribuição
            {
                "userCode": 0,          // código do responsável
                "name": "string",       // nome do responsável
                "subjectKind": "User"   // tipo do responsável. Pode ser User, Group, Role ou UserApp
            }
        ],
        "dependsOnNextStep": true       // depende da execução do próxima etapa para identificar a atribuição
    }
  • 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: Nenhuma tarefa encontrada
    {
        "message": "Descrição do erro",
        "errorCode": "getNextSubjectFromInitialTaskResponse",
        "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ê?