Chapter 54. Process Service
54.1. Process Service Copy linkLink copied to clipboard!
54.1.1. CountProcesses Copy linkLink copied to clipboard!
GET /v1/processcount
CountProcesses returns the count of processes.
54.1.1.1. Description Copy linkLink copied to clipboard!
54.1.1.2. Parameters Copy linkLink copied to clipboard!
54.1.1.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
54.1.1.3. Return Type Copy linkLink copied to clipboard!
54.1.1.4. Content Type Copy linkLink copied to clipboard!
- application/json
54.1.1.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.1.6. Samples Copy linkLink copied to clipboard!
54.1.2. GetGroupedProcessByDeployment Copy linkLink copied to clipboard!
GET /v1/processes/deployment/{deploymentId}/grouped
GetGroupedProcessByDeployment returns all the processes executed grouped by deployment.
54.1.2.1. Description Copy linkLink copied to clipboard!
54.1.2.2. Parameters Copy linkLink copied to clipboard!
54.1.2.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
54.1.2.3. Return Type Copy linkLink copied to clipboard!
54.1.2.4. Content Type Copy linkLink copied to clipboard!
- application/json
54.1.2.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.2.6. Samples Copy linkLink copied to clipboard!
54.1.3. GetGroupedProcessByDeploymentAndContainer Copy linkLink copied to clipboard!
GET /v1/processes/deployment/{deploymentId}/grouped/container
GetGroupedProcessByDeploymentAndContainer returns all the processes executed grouped by deployment and container.
54.1.3.1. Description Copy linkLink copied to clipboard!
54.1.3.2. Parameters Copy linkLink copied to clipboard!
54.1.3.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
54.1.3.3. Return Type Copy linkLink copied to clipboard!
54.1.3.4. Content Type Copy linkLink copied to clipboard!
- application/json
54.1.3.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.3.6. Samples Copy linkLink copied to clipboard!
54.1.4. GetProcessesByDeployment Copy linkLink copied to clipboard!
GET /v1/processes/deployment/{deploymentId}
GetProcessesByDeployment returns the processes executed in the given deployment.
54.1.4.1. Description Copy linkLink copied to clipboard!
54.1.4.2. Parameters Copy linkLink copied to clipboard!
54.1.4.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
54.1.4.3. Return Type Copy linkLink copied to clipboard!
54.1.4.4. Content Type Copy linkLink copied to clipboard!
- application/json
54.1.4.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |