Jump to

• Request
• Response

List Process Instance Jobs

get

/process/api/v1/process-instances/{id}/jobs

Retrieves the list of process instance jobs for a given instance ID.

Note:

You can use this API only on structured processes.

Request

Path Parameters

• id(required): string
  Process Instance ID

Query Parameters

• 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
• sortBy(required): string
  Sort the results by a given criterion. Valid values are JOBID, RETRIES, DUEDATE. Must be used in conjunction with the sortOrder parameter.

  Allowed Values: [ "JOBID", "RETRIES", "DUEDATE" ]
• 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.

  Allowed Values: [ "ASC", "DESC" ]
• state(required): string
  Job states: * `ALL` - All jobs for the process instance * `SCHEDULED` - Jobs with due dates in the future. Can include FAULTED jobs too which are scheduled for retry. * `READY` - Jobs with due dates in the past which might be executing currently or are stuck. Can include FAULTED jobs too which are executing or stuck. * `FAULTED` - Jobs which have faulted with exception. * `EXHAUSTED` - Jobs which have faulted and exhausted all retries.

  Default Value: ALL

  Allowed Values: [ "ALL", "SCHEDULED", "READY", "FAULTED", "EXHAUSTED" ]
• totalResults(required): boolean
  Specifies if total number of results need to be returned

  Default Value: false

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 : ProcessInstanceJobs

Match All

Show Source

• object CommonModel
• object ProcessInstanceJobs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "instanceId":{
                    "type":"string",
                    "description":"Instance Id"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProcessInstanceJobItem"
                    }
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual page size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Total number of records in the current response."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count with the applied filter criteria.",
                    "format":"int64"
                },
                "offset":{
                    "type":"integer",
                    "description":"The actual index from which the singular resources are returned."
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : ProcessInstanceJobs-allOf[1]

Type: object

Show Source

• count: integer
  Total number of records in the current response.
• instanceId: string
  Instance Id
• items: array items
• limit: integer
  Actual page size used by the server.
• offset: integer
  The actual index from which the singular resources are returned.
• totalResults: integer (int64)
  Total count with the applied filter criteria.

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessInstanceJobItem"
            }
        },
        "limit":{
            "type":"integer",
            "description":"Actual page size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count with the applied filter criteria.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the singular resources are returned."
        }
    }
}

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: ProcessInstanceJobItem

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

Nested Schema : ProcessInstanceJobItem

Match All

Show Source

• object CommonModel
• object ProcessInstanceJobItem-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the job instance."
                },
                "state":{
                    "type":"string",
                    "description":"State of the job- SCHEDULED,READY,FAULTED,EXHAUSTED.",
                    "enum":[
                        "SCHEDULED",
                        "READY",
                        "FAULTED",
                        "EXHAUSTED"
                    ]
                },
                "createdTime":{
                    "type":"string",
                    "description":"The date and time of job creation.Has the format yyyy-MM-dd'T'HH:mm:ss.",
                    "format":"date"
                },
                "dueDate":{
                    "type":"string",
                    "description":"The due date of the job.Has the format yyyy-MM-dd'T'HH:mm:ss.",
                    "format":"date"
                },
                "retries":{
                    "type":"integer",
                    "description":"The number of retries left for the job"
                },
                "processDefinitionKey":{
                    "type":"string",
                    "description":"The key of the process definition that this job instance belongs to."
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The ID of the process definition that this job instance belongs to."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this job instance belongs to."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution that created this job instance."
                },
                "isRetryAllowed":{
                    "type":"boolean",
                    "description":"Is job retry allowed for the user."
                },
                "exceptionMessage":{
                    "type":"string",
                    "description":"The message of the exception that occurred, the last time the job was executed. Is null when no exception occurred."
                },
                "isExecuting":{
                    "type":"boolean",
                    "description":"Flag to indicate whether the job is currently executing."
                },
                "activityName":{
                    "type":"string",
                    "description":"The display name of the activity for whuch the job is created."
                },
                "exceptionTrace":{
                    "type":"string",
                    "description":"The stack trace of the exception corresponding to an EXHAUSTED job."
                }
            }
        }
    ]
}

Nested Schema : ProcessInstanceJobItem-allOf[1]

Type: object

Show Source

• activityName: string
  The display name of the activity for whuch the job is created.
• createdTime: string (date)
  The date and time of job creation.Has the format yyyy-MM-dd'T'HH:mm:ss.
• dueDate: string (date)
  The due date of the job.Has the format yyyy-MM-dd'T'HH:mm:ss.
• exceptionMessage: string
  The message of the exception that occurred, the last time the job was executed. Is null when no exception occurred.
• exceptionTrace: string
  The stack trace of the exception corresponding to an EXHAUSTED job.
• executionId: string
  The ID of the execution that created this job instance.
• id: string
  The ID of the job instance.
• isExecuting: boolean
  Flag to indicate whether the job is currently executing.
• isRetryAllowed: boolean
  Is job retry allowed for the user.
• processDefinitionId: string
  The ID of the process definition that this job instance belongs to.
• processDefinitionKey: string
  The key of the process definition that this job instance belongs to.
• processInstanceId: string
  The ID of the process instance that this job instance belongs to.
• retries: integer
  The number of retries left for the job
• state: string
  Allowed Values: [ "SCHEDULED", "READY", "FAULTED", "EXHAUSTED" ]

  State of the job- SCHEDULED,READY,FAULTED,EXHAUSTED.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the job instance."
        },
        "state":{
            "type":"string",
            "description":"State of the job- SCHEDULED,READY,FAULTED,EXHAUSTED.",
            "enum":[
                "SCHEDULED",
                "READY",
                "FAULTED",
                "EXHAUSTED"
            ]
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time of job creation.Has the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "dueDate":{
            "type":"string",
            "description":"The due date of the job.Has the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "retries":{
            "type":"integer",
            "description":"The number of retries left for the job"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"The key of the process definition that this job instance belongs to."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this job instance belongs to."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this job instance belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution that created this job instance."
        },
        "isRetryAllowed":{
            "type":"boolean",
            "description":"Is job retry allowed for the user."
        },
        "exceptionMessage":{
            "type":"string",
            "description":"The message of the exception that occurred, the last time the job was executed. Is null when no exception occurred."
        },
        "isExecuting":{
            "type":"boolean",
            "description":"Flag to indicate whether the job is currently executing."
        },
        "activityName":{
            "type":"string",
            "description":"The display name of the activity for whuch the job is created."
        },
        "exceptionTrace":{
            "type":"string",
            "description":"The stack trace of the exception corresponding to an EXHAUSTED job."
        }
    }
}

401 Response

Unauthorized

404 Response

Process instance id does not exist.

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top