Jump to

• Request
• Response

Get a Process Instance Job

get

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

Retrieves the details of a process instance Job job using the Instance ID.

Note:

You can use this API only on structured processes.

Request

Path Parameters

• id(required): string
  Process Instance Id
• jobId(required): string
  Job Id

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

Type: object

Show Source

• links: array links

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

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

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

401 Response

Unauthorized

404 Response

Job with given 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