iGRPIGRP 3.0Documentation

Definições de processo

Criar processos, guardar o diagrama, declarar variáveis e publicar no Process Management.

Criar processo no projeto

POST
/api/v1/projects/{projectId}/process-definitions

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

projectId*string

Corpo do pedido

application/json
  1. body
title?string
processKey?string
description?string
projectId?string
status?string
Valor em"DRAFT""VALIDATED""PUBLISHED""DEPRECATED""ARCHIVED""DISABLED""ERROR""DELETED"

Corpo da resposta

Created

application/json
  1. response
processDefinitionId?string
projectId?string
processKey?string
bpmnDiagramUrl?string
bpmFileContent?string
title?string
description?string
version?integer
Formatoint32
status?string
statusDesc?string
deploymentId?string
deploymentDate?string
Formatodate-time
processArtifacts?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/string/process-definitions' \  -H 'Content-Type: application/json' \  -d '{}'
{  "processDefinitionId": "string",  "projectId": "string",  "processKey": "string",  "bpmnDiagramUrl": "string",  "bpmFileContent": "string",  "title": "string",  "description": "string",  "version": 0,  "status": "string",  "statusDesc": "string",  "deploymentId": "string",  "deploymentDate": "2019-08-24T14:15:22Z",  "processArtifacts": [    {      "projectArtifactId": "string",      "taskKey": "string",      "name": "string",      "formKey": "string",      "subProcessId": "string",      "subProcessName": "string",      "artifactVariables": [        {          "artifactVariableId": "string",          "key": "string",          "name": "string",          "type": "string",          "defaultValue": "string",          "required": true        }      ],      "subProcessTask": true    }  ],  "createdBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "createdDate": "string",  "lastModifiedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "lastModifiedDate": "string"}

Listar processos

GET
/api/v1/projects/process-definitions

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de query

appCode?string
processKey?string
processName?string
projectCode?string
projectName?string
state?string
pageNumber?string
Predefinido"0"
pageSize?string
Predefinido"20"

Corpo da resposta

OK

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-studio-api/api/v1/projects/process-definitions'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "processDefinitionId": "string",      "projectId": "string",      "processKey": "string",      "bpmnDiagramUrl": "string",      "title": "string",      "description": "string",      "version": 0,      "status": "string",      "statusDesc": "string",      "deploymentId": "string",      "deploymentDate": "2019-08-24T14:15:22Z",      "createdBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      },      "createdDate": "string",      "lastModifiedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "fullName": "string",        "sub": "string"      },      "lastModifiedDate": "string"    }  ]}

Obter processo (inclui o XML)

GET
/api/v1/projects/process-definitions/{processId}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processId*string

Corpo da resposta

OK

application/json
  1. response
processDefinitionId?string
projectId?string
processKey?string
bpmnDiagramUrl?string
bpmFileContent?string
title?string
description?string
version?integer
Formatoint32
status?string
statusDesc?string
deploymentId?string
deploymentDate?string
Formatodate-time
processArtifacts?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string'
{  "processDefinitionId": "string",  "projectId": "string",  "processKey": "string",  "bpmnDiagramUrl": "string",  "bpmFileContent": "string",  "title": "string",  "description": "string",  "version": 0,  "status": "string",  "statusDesc": "string",  "deploymentId": "string",  "deploymentDate": "2019-08-24T14:15:22Z",  "processArtifacts": [    {      "projectArtifactId": "string",      "taskKey": "string",      "name": "string",      "formKey": "string",      "subProcessId": "string",      "subProcessName": "string",      "artifactVariables": [        {          "artifactVariableId": "string",          "key": "string",          "name": "string",          "type": "string",          "defaultValue": "string",          "required": true        }      ],      "subProcessTask": true    }  ],  "createdBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "createdDate": "string",  "lastModifiedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "lastModifiedDate": "string"}

Atualizar dados do processo

PUT
/api/v1/projects/process-definitions/{processId}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processId*string

Corpo do pedido

application/json
  1. body
title?string
processKey?string
description?string
projectId?string
status?string
Valor em"DRAFT""VALIDATED""PUBLISHED""DEPRECATED""ARCHIVED""DISABLED""ERROR""DELETED"

Corpo da resposta

OK

application/json
  1. response
processDefinitionId?string
projectId?string
processKey?string
bpmnDiagramUrl?string
bpmFileContent?string
title?string
description?string
version?integer
Formatoint32
status?string
statusDesc?string
deploymentId?string
deploymentDate?string
Formatodate-time
processArtifacts?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "processDefinitionId": "string",  "projectId": "string",  "processKey": "string",  "bpmnDiagramUrl": "string",  "bpmFileContent": "string",  "title": "string",  "description": "string",  "version": 0,  "status": "string",  "statusDesc": "string",  "deploymentId": "string",  "deploymentDate": "2019-08-24T14:15:22Z",  "processArtifacts": [    {      "projectArtifactId": "string",      "taskKey": "string",      "name": "string",      "formKey": "string",      "subProcessId": "string",      "subProcessName": "string",      "artifactVariables": [        {          "artifactVariableId": "string",          "key": "string",          "name": "string",          "type": "string",          "defaultValue": "string",          "required": true        }      ],      "subProcessTask": true    }  ],  "createdBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "createdDate": "string",  "lastModifiedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "lastModifiedDate": "string"}

Guardar rascunho do diagrama

PUT
/api/v1/projects/process-definitions/{processKey}/diagram

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processKey*string

Corpo do pedido

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

Corpo da resposta

OK

application/json
  1. response
processDefinitionId?string
projectId?string
processKey?string
bpmnDiagramUrl?string
bpmFileContent?string
title?string
description?string
version?integer
Formatoint32
status?string
statusDesc?string
deploymentId?string
deploymentDate?string
Formatodate-time
processArtifacts?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string/diagram' \  -H 'Content-Type: application/json' \  -d '{  "content": "string"}'
{  "processDefinitionId": "string",  "projectId": "string",  "processKey": "string",  "bpmnDiagramUrl": "string",  "bpmFileContent": "string",  "title": "string",  "description": "string",  "version": 0,  "status": "string",  "statusDesc": "string",  "deploymentId": "string",  "deploymentDate": "2019-08-24T14:15:22Z",  "processArtifacts": [    {      "projectArtifactId": "string",      "taskKey": "string",      "name": "string",      "formKey": "string",      "subProcessId": "string",      "subProcessName": "string",      "artifactVariables": [        {          "artifactVariableId": "string",          "key": "string",          "name": "string",          "type": "string",          "defaultValue": "string",          "required": true        }      ],      "subProcessTask": true    }  ],  "createdBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "createdDate": "string",  "lastModifiedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "lastModifiedDate": "string"}

Publicar no Process Management

POST
/api/v1/projects/process-definitions/{processKey}/deploy

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processKey*string

Corpo do pedido

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

Corpo da resposta

OK

application/json
  1. response
processDefinitionId?string
projectId?string
processKey?string
bpmnDiagramUrl?string
bpmFileContent?string
title?string
description?string
version?integer
Formatoint32
status?string
statusDesc?string
deploymentId?string
deploymentDate?string
Formatodate-time
processArtifacts?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string/deploy' \  -H 'Content-Type: application/json' \  -d '{  "content": "string"}'
{  "processDefinitionId": "string",  "projectId": "string",  "processKey": "string",  "bpmnDiagramUrl": "string",  "bpmFileContent": "string",  "title": "string",  "description": "string",  "version": 0,  "status": "string",  "statusDesc": "string",  "deploymentId": "string",  "deploymentDate": "2019-08-24T14:15:22Z",  "processArtifacts": [    {      "projectArtifactId": "string",      "taskKey": "string",      "name": "string",      "formKey": "string",      "subProcessId": "string",      "subProcessName": "string",      "artifactVariables": [        {          "artifactVariableId": "string",          "key": "string",          "name": "string",          "type": "string",          "defaultValue": "string",          "required": true        }      ],      "subProcessTask": true    }  ],  "createdBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "createdDate": "string",  "lastModifiedBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "username": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "fullName": "string",    "sub": "string"  },  "lastModifiedDate": "string"}

Variáveis declaradas do processo

GET
/api/v1/projects/process-definitions/{processId}/variables

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processId*string

Corpo da resposta

OK

application/json
  1. response
id?string
name?string
type?string
defaultValue?string
required?boolean
processDefinitionId?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string/variables'
{  "id": "string",  "name": "string",  "type": "string",  "defaultValue": "string",  "required": true,  "processDefinitionId": "string"}

Declarar variáveis do processo

POST
/api/v1/projects/process-definitions/{processId}/variables

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processId*string

Corpo do pedido

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

Corpo da resposta

OK

application/json
  1. response
id?string
name?string
type?string
defaultValue?string
required?boolean
processDefinitionId?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string/variables' \  -H 'Content-Type: application/json' \  -d '[  {}]'
{  "id": "string",  "name": "string",  "type": "string",  "defaultValue": "string",  "required": true,  "processDefinitionId": "string"}

Apagar processo

PATCH
/api/v1/projects/process-definitions/{processId}/delete

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processId*string

Corpo da resposta

OK

response?stringapplication/json
curl -X PATCH 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string/delete'
"string"

Restaurar processo

PATCH
/api/v1/projects/process-definitions/{processId}/restore

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token do utilizador (Access Management). Ao publicar, é reencaminhado ao Process Management.

Parâmetros de caminho

processId*string

Corpo da resposta

OK

response?stringapplication/json
curl -X PATCH 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/process-definitions/string/restore'
"string"
How is this guide?

Última atualização: