APIs - Tutoriais

GetMyPendencies

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

GetMyPendencies

Obtém as pendências do usuário autenticado conforme o tipo.

Payload de entrada:

{
    "pendencyRequestParameters": {
        "start": 0,                     // a partir de qual pendência a busca começa (opcional)
        "limit": 0,                     // quantidade de pendências retornadas (opcional)
        "type": "Pending",              // tipo de pendência. Pode ser Pending, Treated ou All (opcional)
        "filterValue": "Viagem",        // filtro para buscar pelo nome da pendência ou valor das variáveis do processo (opcional)
        "processFilterType": "All"      // filtro do tipo de processo. Pode ser Embedded, NotEmbedded ou All (opcional)
    }
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getMyPendencies" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'pendencyRequestParameters': { 'start': 0, 'limit': 5, 'type': 'Pending', 'filterValue': 'string', 'processFilterType': 'All' }}"

Responses:

  • 200 OK
    {
        "pendencies": [
            {
                "serviceFlowToken": {
                    "processInstanceID": 0,
                    "step": 0,
                    "activityId": 0
                },
                "description": "string",
                "hint": "string",
                "currentSubject": {
                    "userCode": 0,
                    "name": "string",
                    "subjectKind": "User"
                },
                "delegatorSubject": {
                    "userCode": 0,
                    "name": "string",
                    "subjectKind": "User"
                },
                "startDate": "2021-06-19T16:10:31.133Z",
                "lastUpdateDate": "2021-06-19T16:10:31.133Z",
                "expirationDate": "2021-06-19T16:10:31.133Z",
                "performerId": "string",
                "processInstance": {
                    "id": 0,
                    "process": {
                        "processId": 0,
                        "currentVersion": 0,
                        "publishedVersion": 0,
                        "processName": "string",
                        "processRawName": "string",
                        "changed": true,
                        "fileName": "string",
                        "status": "Saved",
                        "description": "string",
                        "creationDate": "2021-06-19T16:10:31.134Z",
                        "active": true,
                        "embedded": true,
                        "simple": true,
                        "tag": "string",
                        "accessLevel": "EDIT_AND_START",
                        "icon": "string",
                        "serviceEventQtyByType": [
                            {
                                "type": "IN_PROGRESS",
                                "quantity": 0
                            }
                        ]
                    },
                    "startedSubject": {
                        "userCode": 0,
                        "name": "string",
                        "subjectKind": "User"
                    },
                    "cancelSubject": {
                        "userCode": 0,
                        "name": "string",
                        "subjectKind": "User"
                    },
                    "startDate": "2021-06-19T16:10:31.134Z",
                    "lastUptadeDate": "2021-06-19T16:10:31.134Z",
                    "endDate": "2021-06-19T16:10:31.134Z",
                    "flowExecutionStatus": "string",
                    "endMessage": "string",
                    "description": "string",
                    "flowToken": [
                        {
                            "processInstanceID": 0,
                            "step": 0,
                            "activityId": 0
                        }
                    ],
                    "taskExpiration": "2021-06-19T16:10:31.134Z"
                },
                "type": "Pending",
                "pool": true,
                "title": "string"
            }
        ],
        "total": 1
    }
  • 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"
    }
  • 401 Unauthorized: Usuário ou senha inválido
    {
        "error_description": "Descrição do erro",
        "error": "codigo_do_erro"
    }

Este artigo foi útil para você?