Jump to

• Request
• Response

Get a List of Dynamic Process Executions

get

/ic/api/process/v1/dp-executions

Get a list of dynamic process executions that the user can access.

Request

Supported Media Types

• application/json

Query Parameters

• createdAfter: string
  Restrict to instances that were created after the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• createdBefore: string
  Restrict to instances that were created before the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• endedAfter: string
  Restrict to instances that ended after the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• endedBefore: string
  Restrict to instances that ended before the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• finished: boolean
  Only include finished process activity instances. Value may only be true, as false is the default behavior.
• firstResult: integer
  Pagination of results. Specifies the index of the first result to return.
• maxResults: integer
  Pagination of results. Specifies the maximum number of results to return. Will return fewer results if there are no more results left.
• processActivityId: string
  The ID of the process activity that this object is an instance of.
• processActivityInstanceId: string
  Filter by process activity instance ID.
• processActivityName: string
  The name of the process activity that this object is an instance of.
• processActivityType: string
  The type of activity this process execution belongs to.
• processDefinitionId: string
  Filter by process definition ID. Exact match.
• processExecutionId: string
  Filter by the ID of the process execution that executed the process activity instance.
• processInstanceId: string
  Filter by process instance ID.
• required: boolean
  Only include required process activity instances. Value may only be true, as false is the default behavior.
• sortBy: string
  Sort the results by a given criterion. Valid values are processActivityInstanceId, processInstanceId, processExecutionId, processActivityId, processActivityName, processActivityType, processDefinitionId, createTime, endTime, duration. Must be used in conjunction with the sortOrder parameter.
• sortOrder: string
  Sort the results in a specified order. Values are asc for ascending order, or desc for descending order. Must be used in conjunction with the sortBy parameter.
• state: string
  Filter by state.
• unfinished: boolean
  Only include unfinished process activity instances. Value may only be true, as false is the default behavior.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : ProcessExecutions

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessExecutions-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessExecution"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ProcessExecutions-allOf[1]

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessExecution"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProcessExecution

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProcessExecution"
    }
}

Nested Schema : ProcessExecution

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessExecution-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "parentProcessActivityInstanceId":{
                    "type":"string",
                    "description":"The ID of the parent process activity this instance belongs to."
                },
                "activityId":{
                    "type":"string",
                    "description":"The ID of the activity."
                },
                "activityName":{
                    "type":"string",
                    "description":"The name of the activity."
                },
                "activityType":{
                    "type":"string",
                    "description":"The type of the activity."
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The ID of the process definition that this process activity instance belongs to."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this  activity instance belongs to."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution."
                },
                "userId":{
                    "type":"string",
                    "description":"The ID of the user this activty instance is assigned to."
                },
                "createTime":{
                    "type":"string",
                    "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
                },
                "endTime":{
                    "type":"string",
                    "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
                },
                "durationInMillis":{
                    "type":"integer",
                    "format":"int64",
                    "description":"The time the instance took to finish, in milliseconds."
                },
                "required":{
                    "type":"boolean",
                    "description":"If this activity is required"
                },
                "state":{
                    "type":"string",
                    "description":"state of the process activity instance",
                    "default":"ACTIVE",
                    "enum":[
                        "AVAILABLE",
                        "ENABLED",
                        "DISABLED",
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "FAILED"
                    ]
                },
                "availableActions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "availablePermissions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "failureMessage":{
                    "type":"string",
                    "description":"This shows failure reasons when activity is in failed state"
                }
            }
        }
    ]
}

Nested Schema : ProcessExecution-allOf[1]

Type: object

Show Source

• activityId: string
  The ID of the activity.
• activityName: string
  The name of the activity.
• activityType: string
  The type of the activity.
• availableActions: array availableActions
• availablePermissions: array availablePermissions
• createTime: string
  The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC.
• durationInMillis: integer(int64)
  The time the instance took to finish, in milliseconds.
• endTime: string
  The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC.
• executionId: string
  The ID of the execution.
• failureMessage: string
  This shows failure reasons when activity is in failed state
• id: string
  The ID of the process execution instance.
• parentProcessActivityInstanceId: string
  The ID of the parent process activity this instance belongs to.
• processDefinitionId: string
  The ID of the process definition that this process activity instance belongs to.
• processInstanceId: string
  The ID of the process instance that this activity instance belongs to.
• required: boolean
  If this activity is required
• state: string
  Default Value: ACTIVE

  Allowed Values: [ "AVAILABLE", "ENABLED", "DISABLED", "ACTIVE", "COMPLETED", "TERMINATED", "FAILED" ]

  state of the process activity instance
• userId: string
  The ID of the user this activty instance is assigned to.

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "parentProcessActivityInstanceId":{
            "type":"string",
            "description":"The ID of the parent process activity this instance belongs to."
        },
        "activityId":{
            "type":"string",
            "description":"The ID of the activity."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity."
        },
        "activityType":{
            "type":"string",
            "description":"The type of the activity."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this process activity instance belongs to."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this  activity instance belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution."
        },
        "userId":{
            "type":"string",
            "description":"The ID of the user this activty instance is assigned to."
        },
        "createTime":{
            "type":"string",
            "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
        },
        "endTime":{
            "type":"string",
            "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
        },
        "durationInMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The time the instance took to finish, in milliseconds."
        },
        "required":{
            "type":"boolean",
            "description":"If this activity is required"
        },
        "state":{
            "type":"string",
            "description":"state of the process activity instance",
            "default":"ACTIVE",
            "enum":[
                "AVAILABLE",
                "ENABLED",
                "DISABLED",
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "FAILED"
            ]
        },
        "availableActions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "availablePermissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "failureMessage":{
            "type":"string",
            "description":"This shows failure reasons when activity is in failed state"
        }
    }
}

Nested Schema : availableActions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : availablePermissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized.

404 Response

Returned if some of the query parameters are not valid. For example, if a sortOrder parameter is supplied, but no sortBy.

500 Response

Internal Server Error.

Back to Top