iGRPIGRP 3.0Documentation

Áreas

Áreas e os processos associados a cada uma.

Listar áreas

GET
/areas

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de query

code?string
name?string
applicationBase?string
status?string
parentId?string
page?integer
Formatoint32
size?integer
Formatoint32

Corpo da resposta

List of areas

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/areas'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "code": "string",      "name": "string",      "applicationBase": "string",      "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",      "status": "ACTIVE",      "statusDesc": "string",      "process": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "processKey": "string",          "releaseId": "string",          "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",          "status": "ACTIVE",          "statusDesc": "string",          "version": "string",          "createdAt": "2019-08-24T14:15:22Z",          "createdBy": "string",          "removedAt": "2019-08-24T14:15:22Z",          "removedBy": "string",          "name": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "updatedBy": "string",      "description": "string",      "color": "string"    }  ]}

Criar área

POST
/areas

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo do pedido

application/json
  1. body
code*string
Comprimento1 <= length
name*string
Comprimento1 <= length
description?string
applicationBase*string
Comprimento1 <= length
parentId?string
Formatouuid
color?string

Corpo da resposta

Persisted Area

application/json
  1. response
id*string
Formatouuid
code*string
Comprimento1 <= length
name*string
Comprimento1 <= length
applicationBase*string
Comprimento1 <= length
areaId*string
Formatouuid
status*string
Valor em"ACTIVE""INACTIVE"
statusDesc?string
process?array<>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
createdBy?string
updatedBy?string
description?string
color?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/areas' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "string",  "applicationBase": "string"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "code": "string",  "name": "string",  "applicationBase": "string",  "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",  "status": "ACTIVE",  "statusDesc": "string",  "process": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "processKey": "string",      "releaseId": "string",      "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",      "status": "ACTIVE",      "statusDesc": "string",      "version": "string",      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "removedAt": "2019-08-24T14:15:22Z",      "removedBy": "string",      "name": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "updatedBy": "string",  "description": "string",  "color": "string"}

Obter área

GET
/areas/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo da resposta

Area Info

application/json
  1. response
id*string
Formatouuid
code*string
Comprimento1 <= length
name*string
Comprimento1 <= length
applicationBase*string
Comprimento1 <= length
areaId*string
Formatouuid
status*string
Valor em"ACTIVE""INACTIVE"
statusDesc?string
process?array<>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
createdBy?string
updatedBy?string
description?string
color?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-process-management-api/areas/string'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "code": "string",  "name": "string",  "applicationBase": "string",  "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",  "status": "ACTIVE",  "statusDesc": "string",  "process": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "processKey": "string",      "releaseId": "string",      "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",      "status": "ACTIVE",      "statusDesc": "string",      "version": "string",      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "removedAt": "2019-08-24T14:15:22Z",      "removedBy": "string",      "name": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "updatedBy": "string",  "description": "string",  "color": "string"}

Eliminar área (e subáreas)

DELETE
/areas/{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/areas/string'
"string"

Atualizar área

PUT
/areas/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

id*string

Corpo do pedido

application/json
  1. body
code*string
Comprimento1 <= length
name*string
Comprimento1 <= length
description?string
applicationBase*string
Comprimento1 <= length
parentId?string
Formatouuid
color?string

Corpo da resposta

Updated area

application/json
  1. response
id*string
Formatouuid
code*string
Comprimento1 <= length
name*string
Comprimento1 <= length
applicationBase*string
Comprimento1 <= length
areaId*string
Formatouuid
status*string
Valor em"ACTIVE""INACTIVE"
statusDesc?string
process?array<>
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
createdBy?string
updatedBy?string
description?string
color?string
curl -X PUT 'http://localhost:2575/gateway-api/igrp-process-management-api/areas/string' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "name": "string",  "applicationBase": "string"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "code": "string",  "name": "string",  "applicationBase": "string",  "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",  "status": "ACTIVE",  "statusDesc": "string",  "process": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "processKey": "string",      "releaseId": "string",      "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",      "status": "ACTIVE",      "statusDesc": "string",      "version": "string",      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "removedAt": "2019-08-24T14:15:22Z",      "removedBy": "string",      "name": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "updatedBy": "string",  "description": "string",  "color": "string"}

Estados possíveis de uma área

GET
/areas/status

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Corpo da resposta

List of area status

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

Processos da área

GET
/areas/{areaId}/process-definitions

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

areaId*string

Parâmetros de query

processKey?string
status?string
releaseId?string
page?integer
Formatoint32
size?integer
Formatoint32

Corpo da resposta

List of process definition of an area

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/areas/string/process-definitions'
{  "pageNumber": 0,  "pageSize": 0,  "totalElements": 0,  "totalPages": 0,  "last": true,  "first": true,  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "processKey": "string",      "releaseId": "string",      "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",      "status": "ACTIVE",      "statusDesc": "string",      "version": "string",      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "removedAt": "2019-08-24T14:15:22Z",      "removedBy": "string",      "name": "string"    }  ]}

Associar processo à área

POST
/areas/{areaId}/process-definitions

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

areaId*string

Corpo do pedido

application/json
  1. body
processKey*string
Comprimento1 <= length
releaseId*string
Comprimento1 <= length
version?string
name*string
Comprimento1 <= length

Corpo da resposta

Persisted process definition

application/json
  1. response
id*string
Formatouuid
processKey*string
Comprimento1 <= length
releaseId*string
Comprimento1 <= length
areaId*string
Formatouuid
status?string
Valor em"ACTIVE""INACTIVE"
statusDesc?string
version*string
Comprimento1 <= length
createdAt?string
Formatodate-time
createdBy?string
removedAt?string
Formatodate-time
removedBy?string
name?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-process-management-api/areas/string/process-definitions' \  -H 'Content-Type: application/json' \  -d '{  "processKey": "string",  "releaseId": "string",  "name": "string"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "processKey": "string",  "releaseId": "string",  "areaId": "ebbb2a49-d827-4796-8d8a-108c229835e9",  "status": "ACTIVE",  "statusDesc": "string",  "version": "string",  "createdAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "removedAt": "2019-08-24T14:15:22Z",  "removedBy": "string",  "name": "string"}

Desassociar processo da área

DELETE
/areas/{areaId}/process-definitions/{processDefinitionId}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Parâmetros de caminho

areaId*string
processDefinitionId*string

Corpo da resposta

No Content

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

Última atualização: