iGRPIGRP 3.0Documentation

Definições de processo

Definições publicadas, artefactos das tarefas, numeração e prioridades.

Listar definições publicadas

GET
/process-definitions

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de query

applicationBase?string
processName?string
page?integer
Formatoint32
Predefinido0
size?integer
Formatoint32
Predefinido20
filterByCurrentUser?boolean
candidateGroups?string

Corpo da resposta

List of deployments

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/process-definitions'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "id": "string",      "processKey": "string",      "name": "string",      "description": "string",      "version": "string",      "deploymentId": "string",      "applicationBase": "string",      "candidateGroups": "string"    }  ]}
POST
/process-definitions/deploy

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo do pedido

application/json
  1. body
name?string
description?string
key*string
Comprimento1 <= length
resourceName*string
Comprimento1 <= length
bpmnXml*string
Comprimento1 <= length
applicationBase?string

Corpo da resposta

Process deploymeny

application/json
  1. response
key?string
name?string
description?string
version?string
bpmnXml?string
bpmnUrl?string
bpmnSourceType?string
resourceName?string
deployed?boolean
deploymentId?string
deployedAt?string
Formatodate-time
applicationBase?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/deploy' \  -H 'Content-Type: application/json' \  -d '{  "key": "string",  "resourceName": "string",  "bpmnXml": "string"}'
{  "key": "string",  "name": "string",  "description": "string",  "version": "string",  "bpmnXml": "string",  "bpmnUrl": "string",  "bpmnSourceType": "string",  "resourceName": "string",  "deployed": true,  "deploymentId": "string",  "deployedAt": "2019-08-24T14:15:22Z",  "applicationBase": "string"}

Importar definição exportada

POST
/process-definitions/import

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo do pedido

application/json
  1. body
processKey*string
Comprimento1 <= length
processName*string
Comprimento1 <= length
processVersion?string
processDescription?string
bpmnXml*string
Comprimento1 <= length
applicationBase*string
Comprimento1 <= length
artifacts?array<>
sequence?
candidateGroups?string

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/import' \  -H 'Content-Type: application/json' \  -d '{  "processKey": "string",  "processName": "string",  "bpmnXml": "string",  "applicationBase": "string"}'
"string"

Exportar definição

GET
/process-definitions/{id}/export

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

OK

application/json
  1. response
processKey*string
Comprimento1 <= length
processName*string
Comprimento1 <= length
processVersion?string
processDescription?string
bpmnXml*string
Comprimento1 <= length
applicationBase*string
Comprimento1 <= length
artifacts?array<>
sequence?
candidateGroups?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/export'
{  "processKey": "string",  "processName": "string",  "processVersion": "string",  "processDescription": "string",  "bpmnXml": "string",  "applicationBase": "string",  "artifacts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "key": "string",      "processDefinitionId": "string",      "formKey": "string",      "candidateGroups": "string",      "dueDate": "string",      "priority": 0    }  ],  "sequence": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "prefix": "string",    "checkDigitSize": 0,    "padding": 0,    "dateFormat": "string",    "nextNumber": 0,    "numberIncrement": 0,    "processDefinitionKey": "string",    "separator": "string"  },  "candidateGroups": "string"}

Arquivar definição

DELETE
/process-definitions/{id}/archive

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/archive'
"string"

Desarquivar definição

POST
/process-definitions/{id}/unarchive

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/unarchive'
"string"
POST
/process-definitions/{id}/assign

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
candidateGroups*string
Comprimento1 <= length

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/assign' \  -H 'Content-Type: application/json' \  -d '{  "candidateGroups": "string"}'
"string"
POST
/process-definitions/{id}/unassign

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
candidateGroups*string
Comprimento1 <= length

Corpo da resposta

No Content

response?stringapplication/json
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/unassign' \  -H 'Content-Type: application/json' \  -d '{  "candidateGroups": "string"}'
"string"
GET
/process-definitions/{id}/artifacts

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

List of Process Artifacts

application/json
  1. response
id?string
Formatouuid
name?string
key?string
processDefinitionId?string
formKey?string
candidateGroups?string
dueDate?string
priority?integer
Formatoint32
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/artifacts'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "key": "string",  "processDefinitionId": "string",  "formKey": "string",  "candidateGroups": "string",  "dueDate": "string",  "priority": 0}

Artefactos da versão publicada

GET
/process-definitions/{id}/deployed-artifacts

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

List of Deployed Process Artifact

application/json
  1. response
id?string
Formatouuid
name?string
key?string
processDefinitionId?string
formKey?string
candidateGroups?string
dueDate?string
priority?integer
Formatoint32
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/deployed-artifacts'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "key": "string",  "processDefinitionId": "string",  "formKey": "string",  "candidateGroups": "string",  "dueDate": "string",  "priority": 0}

Configurar uma tarefa

PUT
/process-definitions/{id}/artifacts/{taskKey}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string
taskKey*string

Corpo do pedido

application/json
  1. body
name*string
Comprimento1 <= length
formKey*string
Comprimento1 <= length
candidateGroups?string
dueDate?string
priority?integer
Formatoint32

Corpo da resposta

Persisted Project Artifact

application/json
  1. response
id?string
Formatouuid
name?string
key?string
processDefinitionId?string
formKey?string
candidateGroups?string
dueDate?string
priority?integer
Formatoint32
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/artifacts/string' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "formKey": "string"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "key": "string",  "processDefinitionId": "string",  "formKey": "string",  "candidateGroups": "string",  "dueDate": "string",  "priority": 0}

Remover configuração de tarefa

DELETE
/process-definitions/artifacts/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/artifacts/string'
"string"

Obter numeração das instâncias

GET
/process-definitions/{processDefinitionKey}/sequence

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

processDefinitionKey*string

Corpo da resposta

OK

application/json
  1. response
id?string
Formatouuid
name?string
prefix?string
checkDigitSize?integer
Formatoint32
padding?integer
Formatoint32
dateFormat?string
nextNumber?integer
Formatoint64
numberIncrement?integer
Formatoint32
processDefinitionKey?string
separator?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/sequence'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "prefix": "string",  "checkDigitSize": 0,  "padding": 0,  "dateFormat": "string",  "nextNumber": 0,  "numberIncrement": 0,  "processDefinitionKey": "string",  "separator": "string"}
POST
/process-definitions/{processDefinitionKey}/sequence

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

processDefinitionKey*string

Corpo do pedido

application/json
  1. body
name*string
Comprimento1 <= length
prefix*string
Comprimento1 <= length
dateFormat*string
Comprimento1 <= length
checkDigitSize*integer
Formatoint32
padding*integer
Formatoint32
numberIncrement?integer
Formatoint32
separator?string

Corpo da resposta

OK

application/json
  1. response
id?string
Formatouuid
name?string
prefix?string
checkDigitSize?integer
Formatoint32
padding?integer
Formatoint32
dateFormat?string
nextNumber?integer
Formatoint64
numberIncrement?integer
Formatoint32
processDefinitionKey?string
separator?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/sequence' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "prefix": "string",  "dateFormat": "string",  "checkDigitSize": 0,  "padding": 0}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "prefix": "string",  "checkDigitSize": 0,  "padding": 0,  "dateFormat": "string",  "nextNumber": 0,  "numberIncrement": 0,  "processDefinitionKey": "string",  "separator": "string"}

Opções de prioridade

GET
/process-definitions/{processKey}/priorities

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

processKey*string

Corpo da resposta

OK

application/json
  1. response
id?string
Formatouuid
code?string
label?string
weight?integer
Formatoint32
processDefinitionKey?string
color?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/priorities'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "code": "string",  "label": "string",  "weight": 0,  "processDefinitionKey": "string",  "color": "string"}

Configurar prioridades

PUT
/process-definitions/{processKey}/priorities

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

processKey*string

Corpo do pedido

application/json
  1. body
[index: integer]?

Corpo da resposta

OK

application/json
  1. response
id?string
Formatouuid
code?string
label?string
weight?integer
Formatoint32
processDefinitionKey?string
color?string
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/string/priorities' \  -H 'Content-Type: application/json' \  -d '[  {    "code": "string",    "label": "string",    "weight": 0  }]'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "code": "string",  "label": "string",  "weight": 0,  "processDefinitionKey": "string",  "color": "string"}

Remover prioridade

DELETE
/process-definitions/priorities/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

No Content

response?stringapplication/json
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-process-management-api/process-definitions/priorities/string'
"string"
How is this guide?

Última atualização: