iGRPIGRP 3.0Documentation

Projetos

Projetos de processos e os processos publicados de cada um.

Listar projetos

GET
/api/v1/projects

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Parâmetros de query

appCode?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'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "projectId": "string",      "code": "string",      "name": "string",      "description": "string",      "active": true,      "appCode": "string",      "processDefinitions": [        {          "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"        }      ],      "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"    }  ]}

Criar projeto

POST
/api/v1/projects

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Corpo do pedido

application/json
  1. body
code?string
name?string
description?string
appCode?string

Corpo da resposta

Created

application/json
  1. response
projectId?string
code?string
name?string
description?string
active?boolean
appCode?string
processDefinitions?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects' \  -H 'Content-Type: application/json' \  -d '{}'
{  "projectId": "string",  "code": "string",  "name": "string",  "description": "string",  "active": true,  "appCode": "string",  "processDefinitions": [    {      "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"    }  ],  "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 projeto

GET
/api/v1/projects/{projectId}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Parâmetros de caminho

projectId*string

Corpo da resposta

OK

application/json
  1. response
projectId?string
code?string
name?string
description?string
active?boolean
appCode?string
processDefinitions?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/string'
{  "projectId": "string",  "code": "string",  "name": "string",  "description": "string",  "active": true,  "appCode": "string",  "processDefinitions": [    {      "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"    }  ],  "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 projeto

PUT
/api/v1/projects/{projectId}

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
code?string
name?string
description?string
appCode?string

Corpo da resposta

OK

application/json
  1. response
projectId?string
code?string
name?string
description?string
active?boolean
appCode?string
processDefinitions?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "projectId": "string",  "code": "string",  "name": "string",  "description": "string",  "active": true,  "appCode": "string",  "processDefinitions": [    {      "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"    }  ],  "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"}

Ativar projeto

PATCH
/api/v1/projects/{projectId}/enable

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Parâmetros de caminho

projectId*string

Corpo da resposta

OK

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

Desativar projeto

PATCH
/api/v1/projects/{projectId}/disable

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Parâmetros de caminho

projectId*string

Corpo da resposta

OK

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

Processos publicados do projeto

GET
/api/v1/projects/{projectId}/deployed-process

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Parâmetros de caminho

projectId*string

Parâmetros de query

processName?string
processKey?string
pageSize?string
Predefinido"20"
pageNumber?string
Predefinido"0"

Corpo da resposta

OK

application/json
  1. response
projectId?string
code?string
name?string
description?string
active?boolean
appCode?string
processDefinitions?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/string/deployed-process'
{  "projectId": "string",  "code": "string",  "name": "string",  "description": "string",  "active": true,  "appCode": "string",  "processDefinitions": [    {      "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"    }  ],  "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"}

Histórico de versões do projeto

GET
/api/v1/projects/{projectId}/history-process

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

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

Parâmetros de caminho

projectId*string

Parâmetros de query

processName?string
processKey?string
pageSize?string
Predefinido"20"
pageNumber?string
Predefinido"0"

Corpo da resposta

OK

application/json
  1. response
projectId?string
code?string
name?string
description?string
active?boolean
appCode?string
processDefinitions?array<>
createdBy?
createdDate?string
lastModifiedBy?
lastModifiedDate?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-studio-api/api/v1/projects/string/history-process'
{  "projectId": "string",  "code": "string",  "name": "string",  "description": "string",  "active": true,  "appCode": "string",  "processDefinitions": [    {      "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"    }  ],  "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"}
How is this guide?

Última atualização: