iGRPIGRP 3.0Documentation

Tarefas

Pesquisar, assumir, atribuir, guardar e concluir tarefas, e regras de atribuição.

Pesquisar tarefas

POST
/tasks-instances/search

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de query

processInstanceId?string
processNumber?string
processReleaseKey?string
applicationBase?string
candidateGroups?string
candidateUsers?string
user?string
status?string
dateFrom?string
dateTo?string
page?integer
Formatoint32
size?integer
Formatoint32
name?string
processName?string
filterByCurrentUser?boolean
priority?integer
Formatoint32

Corpo do pedido

application/json
  1. body
variables?array<>

Corpo da resposta

List of task instances

application/json
  1. response
pageNumber?integer
Formatoint32
pageSize?integer
Formatoint32
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
last?boolean
first?boolean
content?array<>
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/search' \  -H 'Content-Type: application/json' \  -d '{}'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "taskKey": "string",      "formKey": "string",      "name": "string",      "candidateGroups": "string",      "candidateUsers": "string",      "processInstanceId": "string",      "processNumber": "string",      "processName": "string",      "processKey": "string",      "businessKey": "string",      "priority": 0,      "assignedBy": "string",      "assignedAt": "2019-08-24T14:15:22Z",      "startedBy": "string",      "startedAt": "2019-08-24T14:15:22Z",      "endedBy": "string",      "endedAt": "2019-08-24T14:15:22Z",      "status": "CREATED",      "statusDesc": "string",      "variables": [        {          "name": "string",          "value": null        }      ],      "applicationBase": "string",      "forms": [        {          "name": "string",          "value": null        }      ],      "processVariables": [        {          "name": "string",          "value": null        }      ],      "dueDate": "2019-08-24T14:15:22Z",      "userProfileEndedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      },      "userProfileAssignedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      },      "userProfileStartedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      }    }  ]}

Tarefas do utilizador autenticado

POST
/tasks-instances/me

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de query

processInstanceId?string
processNumber?string
applicationBase?string
processName?string
status?string
dateFrom?string
dateTo?string
page?integer
Formatoint32
size?integer
Formatoint32
processReleaseKey?string
name?string
priority?integer
Formatoint32

Corpo do pedido

application/json
  1. body
variables?array<>

Corpo da resposta

List All My Tasks

application/json
  1. response
pageNumber?integer
Formatoint32
pageSize?integer
Formatoint32
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
last?boolean
first?boolean
content?array<>
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/me' \  -H 'Content-Type: application/json' \  -d '{}'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "taskKey": "string",      "formKey": "string",      "name": "string",      "candidateGroups": "string",      "candidateUsers": "string",      "processInstanceId": "string",      "processNumber": "string",      "processName": "string",      "processKey": "string",      "businessKey": "string",      "priority": 0,      "assignedBy": "string",      "assignedAt": "2019-08-24T14:15:22Z",      "startedBy": "string",      "startedAt": "2019-08-24T14:15:22Z",      "endedBy": "string",      "endedAt": "2019-08-24T14:15:22Z",      "status": "CREATED",      "statusDesc": "string",      "variables": [        {          "name": "string",          "value": null        }      ],      "applicationBase": "string",      "forms": [        {          "name": "string",          "value": null        }      ],      "processVariables": [        {          "name": "string",          "value": null        }      ],      "dueDate": "2019-08-24T14:15:22Z",      "userProfileEndedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      },      "userProfileAssignedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      },      "userProfileStartedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      }    }  ]}

Obter tarefa

GET
/tasks-instances/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

Task Instance Info

application/json
  1. response
id?string
Formatouuid
taskKey?string
formKey?string
name?string
externalId?string
candidateGroups?string
candidateUsers?string
processInstanceId?string
Formatouuid
processKey?string
processNumber?string
businessKey?string
processName?string
applicationBase?string
assignedAt?string
Formatodate-time
assignedBy?string
searchTerms?string
priority?integer
Formatoint32
startedAt?string
Formatodate-time
startedBy?string
status?string
Valor em"CREATED""ASSIGNED""SUSPENDED""COMPLETED""CANCELED"
statusDesc?string
endedAt?string
Formatodate-time
endedBy?string
taskInstanceEvents?array<>
variables?array<>
forms?array<>
processVariables?array<>
dueDate?string
Formatodate-time
userProfileAssignedBy?
userProfileEndedBy?
userProfileStartedBy?
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "taskKey": "string",  "formKey": "string",  "name": "string",  "externalId": "string",  "candidateGroups": "string",  "candidateUsers": "string",  "processInstanceId": "e208d7c6-f7e3-44cc-bbfb-74c86607a4b7",  "processKey": "string",  "processNumber": "string",  "businessKey": "string",  "processName": "string",  "applicationBase": "string",  "assignedAt": "2019-08-24T14:15:22Z",  "assignedBy": "string",  "searchTerms": "string",  "priority": 0,  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "status": "CREATED",  "statusDesc": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "taskInstanceEvents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "taskInstanceId": "4b20724d-23ff-43fe-a598-7c9327b455c0",      "eventType": "string",      "performedAt": "2019-08-24T14:15:22Z",      "performedBy": "string",      "obs": "string",      "status": "CREATED",      "userProfilePerformedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      }    }  ],  "variables": [    {      "name": "string",      "value": null    }  ],  "forms": [    {      "name": "string",      "value": null    }  ],  "processVariables": [    {      "name": "string",      "value": null    }  ],  "dueDate": "2019-08-24T14:15:22Z",  "userProfileAssignedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "userProfileEndedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "userProfileStartedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Variáveis e formulários da tarefa

GET
/tasks-instances/{id}/variables

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

OK

application/json
  1. response
variables?array<>
forms?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string/variables'
{  "variables": [    {      "name": "string",      "value": null    }  ],  "forms": [    {      "name": "string",      "value": null    }  ]}

Assumir tarefa

POST
/tasks-instances/{id}/claim

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

No Content

response?string*/*
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string/claim'
"string"

Libertar tarefa

POST
/tasks-instances/{id}/unclaim

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
note?string

Corpo da resposta

No content

response?string*/*
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string/unclaim' \  -H 'Content-Type: application/json' \  -d '{}'
"string"

Atribuir tarefa a outro utilizador

POST
/tasks-instances/{id}/assign

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
user?string
Comprimento0 <= length <= 2147483647
priority?integer
Formatoint32
note?string
candidateGroups?string
candidateUsers?string

Corpo da resposta

No content

response?string*/*
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string/assign' \  -H 'Content-Type: application/json' \  -d '{}'
"string"

Guardar dados sem concluir

POST
/tasks-instances/{id}/save

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
variables?array<>
forms?array<>

Corpo da resposta

OK

application/json
  1. response
id?string
Formatouuid
taskKey?string
formKey?string
name?string
externalId?string
candidateGroups?string
candidateUsers?string
processInstanceId?string
Formatouuid
processKey?string
processNumber?string
businessKey?string
processName?string
applicationBase?string
assignedAt?string
Formatodate-time
assignedBy?string
searchTerms?string
priority?integer
Formatoint32
startedAt?string
Formatodate-time
startedBy?string
status?string
Valor em"CREATED""ASSIGNED""SUSPENDED""COMPLETED""CANCELED"
statusDesc?string
endedAt?string
Formatodate-time
endedBy?string
taskInstanceEvents?array<>
variables?array<>
forms?array<>
processVariables?array<>
dueDate?string
Formatodate-time
userProfileAssignedBy?
userProfileEndedBy?
userProfileStartedBy?
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string/save' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "taskKey": "string",  "formKey": "string",  "name": "string",  "externalId": "string",  "candidateGroups": "string",  "candidateUsers": "string",  "processInstanceId": "e208d7c6-f7e3-44cc-bbfb-74c86607a4b7",  "processKey": "string",  "processNumber": "string",  "businessKey": "string",  "processName": "string",  "applicationBase": "string",  "assignedAt": "2019-08-24T14:15:22Z",  "assignedBy": "string",  "searchTerms": "string",  "priority": 0,  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "status": "CREATED",  "statusDesc": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "taskInstanceEvents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "taskInstanceId": "4b20724d-23ff-43fe-a598-7c9327b455c0",      "eventType": "string",      "performedAt": "2019-08-24T14:15:22Z",      "performedBy": "string",      "obs": "string",      "status": "CREATED",      "userProfilePerformedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      }    }  ],  "variables": [    {      "name": "string",      "value": null    }  ],  "forms": [    {      "name": "string",      "value": null    }  ],  "processVariables": [    {      "name": "string",      "value": null    }  ],  "dueDate": "2019-08-24T14:15:22Z",  "userProfileAssignedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "userProfileEndedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "userProfileStartedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Concluir tarefa

POST
/tasks-instances/{id}/complete

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
variables?array<>
forms?array<>

Corpo da resposta

OK

application/json
  1. response
id?string
Formatouuid
taskKey?string
formKey?string
name?string
externalId?string
candidateGroups?string
candidateUsers?string
processInstanceId?string
Formatouuid
processKey?string
processNumber?string
businessKey?string
processName?string
applicationBase?string
assignedAt?string
Formatodate-time
assignedBy?string
searchTerms?string
priority?integer
Formatoint32
startedAt?string
Formatodate-time
startedBy?string
status?string
Valor em"CREATED""ASSIGNED""SUSPENDED""COMPLETED""CANCELED"
statusDesc?string
endedAt?string
Formatodate-time
endedBy?string
taskInstanceEvents?array<>
variables?array<>
forms?array<>
processVariables?array<>
dueDate?string
Formatodate-time
userProfileAssignedBy?
userProfileEndedBy?
userProfileStartedBy?
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/string/complete' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "taskKey": "string",  "formKey": "string",  "name": "string",  "externalId": "string",  "candidateGroups": "string",  "candidateUsers": "string",  "processInstanceId": "e208d7c6-f7e3-44cc-bbfb-74c86607a4b7",  "processKey": "string",  "processNumber": "string",  "businessKey": "string",  "processName": "string",  "applicationBase": "string",  "assignedAt": "2019-08-24T14:15:22Z",  "assignedBy": "string",  "searchTerms": "string",  "priority": 0,  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "status": "CREATED",  "statusDesc": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "taskInstanceEvents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "taskInstanceId": "4b20724d-23ff-43fe-a598-7c9327b455c0",      "eventType": "string",      "performedAt": "2019-08-24T14:15:22Z",      "performedBy": "string",      "obs": "string",      "status": "CREATED",      "userProfilePerformedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      }    }  ],  "variables": [    {      "name": "string",      "value": null    }  ],  "forms": [    {      "name": "string",      "value": null    }  ],  "processVariables": [    {      "name": "string",      "value": null    }  ],  "dueDate": "2019-08-24T14:15:22Z",  "userProfileAssignedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "userProfileEndedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "userProfileStartedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Contadores de tarefas

GET
/tasks-instances/stats

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo da resposta

OK

application/json
  1. response
totalTaskInstances?integer
Formatoint64
totalAvailableTasks?integer
Formatoint64
totalAssignedTasks?integer
Formatoint64
totalSuspendedTasks?integer
Formatoint64
totalCompletedTasks?integer
Formatoint64
totalCanceledTasks?integer
Formatoint64
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/stats'
{  "totalTaskInstances": 0,  "totalAvailableTasks": 0,  "totalAssignedTasks": 0,  "totalSuspendedTasks": 0,  "totalCompletedTasks": 0,  "totalCanceledTasks": 0}

Contadores das minhas tarefas

GET
/tasks-instances/stats/me

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo da resposta

OK

application/json
  1. response
totalTaskInstances?integer
Formatoint64
totalAvailableTasks?integer
Formatoint64
totalAssignedTasks?integer
Formatoint64
totalSuspendedTasks?integer
Formatoint64
totalCompletedTasks?integer
Formatoint64
totalCanceledTasks?integer
Formatoint64
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/stats/me'
{  "totalTaskInstances": 0,  "totalAvailableTasks": 0,  "totalAssignedTasks": 0,  "totalSuspendedTasks": 0,  "totalCompletedTasks": 0,  "totalCanceledTasks": 0}

Estados possíveis de uma tarefa

GET
/tasks-instances/status

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo da resposta

OK

application/json
  1. response
label*string
Comprimento1 <= length
value*string
Comprimento1 <= length
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/status'
{  "label": "string",  "value": "string"}

Tipos de evento de tarefa

GET
/tasks-instances/event_type

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo da resposta

OK

application/json
  1. response
label*string
Comprimento1 <= length
value*string
Comprimento1 <= length
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/event_type'
{  "label": "string",  "value": "string"}

Listar regras de atribuição

GET
/tasks-instances/assignment-rules

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de query

processInstanceId?string
processDefinitionKey?string
taskDefinitionKey?string
assignee?string
candidateUsers?string
candidateGroups?string
assignmentMode?string
Valor em"ALWAYS""ONE_TIME"
consumed?boolean
active?boolean
createdByTask?string
page?integer
Formatoint32
size?integer
Formatoint32

Corpo da resposta

List task assignment rules

application/json
  1. response
pageNumber?integer
Formatoint32
pageSize?integer
Formatoint32
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
last?boolean
first?boolean
content?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/assignment-rules'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "processDefinitionKey": "string",      "processInstanceId": "e208d7c6-f7e3-44cc-bbfb-74c86607a4b7",      "taskDefinitionKey": "string",      "assignee": "string",      "candidateUsers": "string",      "candidateGroups": "string",      "assignmentMode": "ALWAYS",      "priority": 0,      "consumed": true,      "active": true,      "createdByTask": "f6ddc7f1-adbe-4fe2-86e0-6dac7071ec02"    }  ]}

Eliminar regra de atribuição

DELETE
/tasks-instances/assignment-rules/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

No content

response?string*/*
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/assignment-rules/string'
"string"

Atualizar regra de atribuição

PUT
/tasks-instances/assignment-rules/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
assignee?string
candidateUsers?string
candidateGroups?string

Corpo da resposta

Task assignment rule updated

application/json
  1. response
id?string
Formatouuid
processDefinitionKey?string
processInstanceId?string
Formatouuid
taskDefinitionKey?string
assignee?string
candidateUsers?string
candidateGroups?string
assignmentMode?string
Valor em"ALWAYS""ONE_TIME"
priority?integer
Formatoint32
consumed?boolean
active?boolean
createdByTask?string
Formatouuid
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-management-api/tasks-instances/assignment-rules/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "processDefinitionKey": "string",  "processInstanceId": "e208d7c6-f7e3-44cc-bbfb-74c86607a4b7",  "taskDefinitionKey": "string",  "assignee": "string",  "candidateUsers": "string",  "candidateGroups": "string",  "assignmentMode": "ALWAYS",  "priority": 0,  "consumed": true,  "active": true,  "createdByTask": "f6ddc7f1-adbe-4fe2-86e0-6dac7071ec02"}
How is this guide?

Última atualização: