Instâncias

Criar e arrancar instância

POST

/process-instances

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Corpo do pedido

application/json

body

processDefinitionId?string

processKey*string

Comprimento1 <= length

businessKey?string

applicationBase*string

Comprimento1 <= length

priority?integer

Formatoint32

variables?array<>

assignmentRules?array<>

Corpo da resposta

application/json

response

id?string

Formatouuid

procReleaseKey?string

procReleaseId?string

number?string

status?string

Valor em"RUNNING""CREATED""SUSPENDED""CANCELED""COMPLETED"

statusDesc?string

businessKey?string

version?string

startedAt?string

Formatodate-time

startedBy?string

endedAt?string

Formatodate-time

endedBy?string

canceledAt?string

Formatodate-time

cancelledBy?string

obsCancel?string

applicationBase?string

name?string

progress?string

priority?integer

Formatoint32

variables?array<>

userProfileStartedBy?

userProfileEndedBy?

userProfileCancelledBy?

curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances' \  -H 'Content-Type: application/json' \  -d '{  "processKey": "string",  "applicationBase": "string"}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "procReleaseKey": "string",  "procReleaseId": "string",  "number": "string",  "status": "RUNNING",  "statusDesc": "string",  "businessKey": "string",  "version": "string",  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "canceledAt": "2019-08-24T14:15:22Z",  "cancelledBy": "string",  "obsCancel": "string",  "applicationBase": "string",  "name": "string",  "progress": "string",  "priority": 0,  "variables": [    {      "name": "string",      "value": null    }  ],  "userProfileStartedBy": {    "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"  },  "userProfileCancelledBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Criar instância (sem arrancar)

POST

/process-instances/create

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Corpo do pedido

application/json

body

processDefinitionId?string

processKey*string

Comprimento1 <= length

applicationBase*string

Comprimento1 <= length

businessKey?string

priority?integer

Formatoint32

Corpo da resposta

Created

application/json

response

id?string

Formatouuid

procReleaseKey?string

procReleaseId?string

number?string

status?string

Valor em"RUNNING""CREATED""SUSPENDED""CANCELED""COMPLETED"

statusDesc?string

businessKey?string

version?string

startedAt?string

Formatodate-time

startedBy?string

endedAt?string

Formatodate-time

endedBy?string

canceledAt?string

Formatodate-time

cancelledBy?string

obsCancel?string

applicationBase?string

name?string

progress?string

priority?integer

Formatoint32

variables?array<>

userProfileStartedBy?

userProfileEndedBy?

userProfileCancelledBy?

curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/create' \  -H 'Content-Type: application/json' \  -d '{  "processKey": "string",  "applicationBase": "string"}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "procReleaseKey": "string",  "procReleaseId": "string",  "number": "string",  "status": "RUNNING",  "statusDesc": "string",  "businessKey": "string",  "version": "string",  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "canceledAt": "2019-08-24T14:15:22Z",  "cancelledBy": "string",  "obsCancel": "string",  "applicationBase": "string",  "name": "string",  "progress": "string",  "priority": 0,  "variables": [    {      "name": "string",      "value": null    }  ],  "userProfileStartedBy": {    "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"  },  "userProfileCancelledBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Arrancar instância criada

POST

/process-instances/{id}/start

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json

body

variables?array<>

assignmentRules?array<>

Corpo da resposta

application/json

response

id?string

Formatouuid

procReleaseKey?string

procReleaseId?string

number?string

status?string

Valor em"RUNNING""CREATED""SUSPENDED""CANCELED""COMPLETED"

statusDesc?string

businessKey?string

version?string

startedAt?string

Formatodate-time

startedBy?string

endedAt?string

Formatodate-time

endedBy?string

canceledAt?string

Formatodate-time

cancelledBy?string

obsCancel?string

applicationBase?string

name?string

progress?string

priority?integer

Formatoint32

variables?array<>

userProfileStartedBy?

userProfileEndedBy?

userProfileCancelledBy?

curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/string/start' \  -H 'Content-Type: application/json' \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "procReleaseKey": "string",  "procReleaseId": "string",  "number": "string",  "status": "RUNNING",  "statusDesc": "string",  "businessKey": "string",  "version": "string",  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "canceledAt": "2019-08-24T14:15:22Z",  "cancelledBy": "string",  "obsCancel": "string",  "applicationBase": "string",  "name": "string",  "progress": "string",  "priority": 0,  "variables": [    {      "name": "string",      "value": null    }  ],  "userProfileStartedBy": {    "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"  },  "userProfileCancelledBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Pesquisar instâncias

POST

/process-instances/search

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Parâmetros de query

number?string

name?string

procReleaseKey?string

procReleaseId?string

status?string

applicationBase?string

dateFrom?string

dateTo?string

page?integer

Formatoint32

size?integer

Formatoint32

Corpo do pedido

application/json

body

variables?array<>

Corpo da resposta

List of process instances

application/json

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/process-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",      "procReleaseKey": "string",      "procReleaseId": "string",      "number": "string",      "status": "RUNNING",      "statusDesc": "string",      "businessKey": "string",      "version": "string",      "startedAt": "2019-08-24T14:15:22Z",      "startedBy": "string",      "endedAt": "2019-08-24T14:15:22Z",      "endedBy": "string",      "canceledAt": "2019-08-24T14:15:22Z",      "cancelledBy": "string",      "obsCancel": "string",      "applicationBase": "string",      "name": "string",      "progress": "string",      "priority": 0,      "variables": [        {          "name": "string",          "value": null        }      ],      "userProfileStartedBy": {        "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"      },      "userProfileCancelledBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      }    }  ]}

Obter instância

GET

/process-instances/{id}

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

Process Instance Info

application/json

response

id?string

Formatouuid

procReleaseKey?string

procReleaseId?string

number?string

status?string

Valor em"RUNNING""CREATED""SUSPENDED""CANCELED""COMPLETED"

statusDesc?string

businessKey?string

version?string

startedAt?string

Formatodate-time

startedBy?string

endedAt?string

Formatodate-time

endedBy?string

canceledAt?string

Formatodate-time

cancelledBy?string

obsCancel?string

applicationBase?string

name?string

progress?string

priority?integer

Formatoint32

variables?array<>

userProfileStartedBy?

userProfileEndedBy?

userProfileCancelledBy?

curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/string'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "procReleaseKey": "string",  "procReleaseId": "string",  "number": "string",  "status": "RUNNING",  "statusDesc": "string",  "businessKey": "string",  "version": "string",  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "canceledAt": "2019-08-24T14:15:22Z",  "cancelledBy": "string",  "obsCancel": "string",  "applicationBase": "string",  "name": "string",  "progress": "string",  "priority": 0,  "variables": [    {      "name": "string",      "value": null    }  ],  "userProfileStartedBy": {    "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"  },  "userProfileCancelledBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Estado das tarefas da instância

GET

/process-instances/{id}/task-status

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

List of task status of the process instance

application/json

response

taskKey*string

Comprimento1 <= length

name?string

status?string

Valor em"CREATED""ASSIGNED""SUSPENDED""COMPLETED""CANCELED"

curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/string/task-status'

{  "taskKey": "string",  "name": "string",  "status": "CREATED"}

Cancelar instância

POST

/process-instances/{id}/cancel

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json

body

obsCancel?string

Corpo da resposta

application/json

response

id?string

Formatouuid

procReleaseKey?string

procReleaseId?string

number?string

status?string

Valor em"RUNNING""CREATED""SUSPENDED""CANCELED""COMPLETED"

statusDesc?string

businessKey?string

version?string

startedAt?string

Formatodate-time

startedBy?string

endedAt?string

Formatodate-time

endedBy?string

canceledAt?string

Formatodate-time

cancelledBy?string

obsCancel?string

applicationBase?string

name?string

progress?string

priority?integer

Formatoint32

variables?array<>

userProfileStartedBy?

userProfileEndedBy?

userProfileCancelledBy?

curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/string/cancel' \  -H 'Content-Type: application/json' \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "procReleaseKey": "string",  "procReleaseId": "string",  "number": "string",  "status": "RUNNING",  "statusDesc": "string",  "businessKey": "string",  "version": "string",  "startedAt": "2019-08-24T14:15:22Z",  "startedBy": "string",  "endedAt": "2019-08-24T14:15:22Z",  "endedBy": "string",  "canceledAt": "2019-08-24T14:15:22Z",  "cancelledBy": "string",  "obsCancel": "string",  "applicationBase": "string",  "name": "string",  "progress": "string",  "priority": 0,  "variables": [    {      "name": "string",      "value": null    }  ],  "userProfileStartedBy": {    "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"  },  "userProfileCancelledBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  }}

Enviar evento (mensagem ou sinal)

POST

/process-instances/event

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Corpo do pedido

application/json

body

messageName?string

taskId?string

businessKey?string

variables?array<>

Corpo da resposta

response?stringapplication/json

curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/event' \  -H 'Content-Type: application/json' \  -d '{}'

"string"

Reagendar timer

POST

/process-instances/{id}/timer/reschedule

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json

body

elementId?string

seconds*integer

Formatoint64

Corpo da resposta

No Content

response?stringapplication/json

curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/string/timer/reschedule' \  -H 'Content-Type: application/json' \  -d '{  "seconds": 0}'

"string"

Contadores de instâncias

GET

/process-instances/stats

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Corpo da resposta

application/json

response

totalProcessInstances?integer

Formatoint64

totalCreatedProcess?integer

Formatoint64

totalRunningProcess?integer

Formatoint64

totalCompletedProcess?integer

Formatoint64

totalSuspendedProcess?integer

Formatoint64

totalCanceledProcess?integer

Formatoint64

curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/stats'

{  "totalProcessInstances": 0,  "totalCreatedProcess": 0,  "totalRunningProcess": 0,  "totalCompletedProcess": 0,  "totalSuspendedProcess": 0,  "totalCanceledProcess": 0}

Estados possíveis de uma instância

GET

/process-instances/status

Autorização

bearerAuth

headerAutorizaçãoBearer <token>

Corpo da resposta

List of process instance status

application/json

response

label*string

Comprimento1 <= length

value*string

Comprimento1 <= length

curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-instances/status'

{  "label": "string",  "value": "string"}

Instâncias

Criar e arrancar instânciaCopiar link da secção

AutorizaçãoCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Criar instância (sem arrancar)Copiar link da secção

AutorizaçãoCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Arrancar instância criadaCopiar link da secção

AutorizaçãoCopiar link da secção

Parâmetros de caminhoCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Pesquisar instânciasCopiar link da secção

AutorizaçãoCopiar link da secção

Parâmetros de queryCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Obter instânciaCopiar link da secção

AutorizaçãoCopiar link da secção

Parâmetros de caminhoCopiar link da secção

Corpo da respostaCopiar link da secção

Estado das tarefas da instânciaCopiar link da secção

AutorizaçãoCopiar link da secção

Parâmetros de caminhoCopiar link da secção

Corpo da respostaCopiar link da secção

Cancelar instânciaCopiar link da secção

AutorizaçãoCopiar link da secção

Parâmetros de caminhoCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Enviar evento (mensagem ou sinal)Copiar link da secção

AutorizaçãoCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Reagendar timerCopiar link da secção

AutorizaçãoCopiar link da secção

Parâmetros de caminhoCopiar link da secção

Corpo do pedidoCopiar link da secção

Corpo da respostaCopiar link da secção

Contadores de instânciasCopiar link da secção

AutorizaçãoCopiar link da secção

Corpo da respostaCopiar link da secção

Estados possíveis de uma instânciaCopiar link da secção

AutorizaçãoCopiar link da secção

Corpo da respostaCopiar link da secção

Criar e arrancar instância

Autorização

Corpo do pedido

Corpo da resposta

Criar instância (sem arrancar)

Autorização

Corpo do pedido

Corpo da resposta

Arrancar instância criada

Autorização

Parâmetros de caminho

Corpo do pedido

Corpo da resposta

Pesquisar instâncias

Autorização

Parâmetros de query

Corpo do pedido

Corpo da resposta

Obter instância

Autorização

Parâmetros de caminho

Corpo da resposta

Estado das tarefas da instância

Autorização

Parâmetros de caminho

Corpo da resposta

Cancelar instância

Autorização

Parâmetros de caminho

Corpo do pedido

Corpo da resposta

Enviar evento (mensagem ou sinal)

Autorização

Corpo do pedido

Corpo da resposta

Reagendar timer

Autorização

Parâmetros de caminho

Corpo do pedido

Corpo da resposta

Contadores de instâncias

Autorização

Corpo da resposta

Estados possíveis de uma instância

Autorização

Corpo da resposta