Get Process Definition Overview

Overview of the user deployment process.

Method

GET /enhancement/process-definition/overview

Parameters

Query Parameters

Name Description
tenant The tenant of the process definition.
firstResult Pagination of results. Specifies the index of the first result to return.
maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
finishedCount The instance count of finished,default true.
noticeIncidentCount The notice incident count, default true.

Result

A JSON object with the following properties:

Name Type Description
key String The key of the process definition.
name String The name of the process definition.
instancesCount Number The instancesCount of the process definition.
incidentsCount Number The incidentsCount of the process definition.
noticeCount Number The noticeCount of the process definition.
instancesFinishedCount Number The instancesFinishedCount of the process definition.
latestProcessDefinitionId String The latestProcessDefinitionId of the process definition.
tenant String The tenant of the process definition.

* For further information, please see the documentation.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json Historic external task log with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /enhancement/process-definition/overview

Response

Status 200.

[
    {
        "key": "Process_1u8yirb",
        "name": null,
        "instancesCount": 1,
        "incidentsCount": 0,
        "noticeCount": 0,
        "instancesFinishedCount": 0,
        "latestProcessDefinitionId": "Process_1u8yirb:2:cefd1c5b-aab9-11ee-ad4d-6e60771577e7",
        "tenant": null
    }
]

On this Page: