Jump to

• Request
• Response

List Process Executions

get

/process/api/v1/process-executions

List process executions for the current user. You can use this API function only on structured processes.

Request

Query Parameters

• createdAfter(required): string
  Restrict to instances that were created after the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
• createdBefore(required): string
  Restrict to instances that were created before the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
• limit(required): integer
  Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

  Default Value: 25
• offset(required): integer
  Pagination of results. Specifies the index of the first result to return.

  Default Value: 0
• processActivityId(required): string
  The ID of the process activity that this object is an instance of.
• processActivityInstanceId(required): string
  Filter by process activity instance Id.
• processActivityName(required): string
  The name of the process activity that this object is an instance of.
• processActivityType(required): string
  The type of the activity this process execution belongs to.
• processDefinitionId(required): string
  Filter by process definition ID. Exact match
• processExecutionId(required): string
  Filter by the ID of the process execution that executed the process activity instance.
• processInstanceId(required): string
  Filter by process instance Id
• sortBy(required): string
  Sort the results by a given criterion. Must be used in conjunction with the sortOrder parameter.

  Allowed Values: [ "executionId", "instanceId" ]
• sortOrder(required): string
  Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• oci-original-url:
  Actual endpoint which customer requested

There's no request body for this operation.

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
• object ProcessExecutions-allOf[1]
• object PaginationResponse
  Pagination details

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

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : ProcessExecutions-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : PaginationResponse

Type: object

Pagination details

Show Source

• count: integer
  count of items returned in current result
• hasMore: boolean
  whether there are more pages to fetch
• limit: integer
  max size for the paginated response
• offset: integer
  offset for the paginated response
• totalResults: integer
  total count with the applied filter criteria

{
    "description":"Pagination details",
    "properties":{
        "count":{
            "type":"integer",
            "description":"count of items returned in current result"
        },
        "totalResults":{
            "type":"integer",
            "description":"total count with the applied filter criteria"
        },
        "limit":{
            "type":"integer",
            "description":"max size for the paginated response"
        },
        "offset":{
            "type":"integer",
            "description":"offset for the paginated response"
        },
        "hasMore":{
            "type":"boolean",
            "description":"whether there are more pages to fetch"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ProcessExecution

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

Nested Schema : ProcessExecution

Match All

Show Source

• object CommonModel
• object ProcessExecution-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "processExecutionId":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this execution instance belongs to."
                },
                "assignee":{
                    "type":"string",
                    "description":"The assignee incase the activity is a user task."
                },
                "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."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution."
                },
                "taskId":{
                    "type":"string",
                    "description":"Task Id"
                },
                "taskTitle":{
                    "type":"string",
                    "description":"Task Title"
                },
                "bpmnProcessTitle":{
                    "type":"string",
                    "description":"Sructured Process Title"
                },
                "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"
                },
                "calledProcessInstance":{
                    "type":"string",
                    "description":"The name of the calledProcessInsatnce"
                },
                "state":{
                    "type":"string",
                    "description":"state of the process activity instance",
                    "default":"ACTIVE",
                    "enum":[
                        "AVAILABLE",
                        "ENABLED",
                        "DISABLED",
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "FAILED",
                        "SUSPENDED"
                    ]
                },
                "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"
                },
                "faultData":{
                    "$ref":"#/components/schemas/FaultData"
                }
            }
        }
    ]
}

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.
• assignee: string
  The assignee incase the activity is a user task.
• availableActions: array availableActions
• availablePermissions: array availablePermissions
• bpmnProcessTitle: string
  Sructured Process Title
• calledProcessInstance: string
  The name of the calledProcessInsatnce
• 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
• faultData: object FaultData
• 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.
• processExecutionId: string
  The ID of the process execution instance.
• processInstanceId: string
  The ID of the process instance that this execution instance belongs to.
• required: boolean
  If this activity is required
• state: string
  Default Value: ACTIVE

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

  state of the process activity instance
• taskId: string
  Task Id
• taskTitle: string
  Task Title
• userId: string
  The ID of the user this activty instance is assigned to.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "processExecutionId":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this execution instance belongs to."
        },
        "assignee":{
            "type":"string",
            "description":"The assignee incase the activity is a user task."
        },
        "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."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution."
        },
        "taskId":{
            "type":"string",
            "description":"Task Id"
        },
        "taskTitle":{
            "type":"string",
            "description":"Task Title"
        },
        "bpmnProcessTitle":{
            "type":"string",
            "description":"Sructured Process Title"
        },
        "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"
        },
        "calledProcessInstance":{
            "type":"string",
            "description":"The name of the calledProcessInsatnce"
        },
        "state":{
            "type":"string",
            "description":"state of the process activity instance",
            "default":"ACTIVE",
            "enum":[
                "AVAILABLE",
                "ENABLED",
                "DISABLED",
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "FAILED",
                "SUSPENDED"
            ]
        },
        "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"
        },
        "faultData":{
            "$ref":"#/components/schemas/FaultData"
        }
    }
}

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"
    }
}

Nested Schema : FaultData

Type: object

Show Source

• errorCause: string
  Error Cause
• errorCode: string
  Error Code
• errorMessage: string
  Error Message
• errorStatus: integer
  Error Status

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "description":"Error Message"
        },
        "errorCause":{
            "type":"string",
            "description":"Error Cause"
        },
        "errorStatus":{
            "type":"integer",
            "description":"Error Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        }
    }
}

401 Response

Unauthorized

404 Response

Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top