Jump to

• Request
• Response

List Process Instance Incidents

get

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

List all the process instance incidents 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

• activityId: string
  Restricts to incidents that belong to an activity with the given ID.
• limit: 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: integer
  Pagination of results. Specifies the index of the first result to return.

  Default Value: 0
• sortBy: string
  Sort the results by a given criterion. Valid values are CREATEDTIME, ACTIVITYID. Must be used in conjunction with the sortOrder parameter.

  Allowed Values: [ "CREATEDTIME", "ACTIVITYID" ]
• sortOrder: 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" ]
• totalResults: 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 : ProcessInstanceIncidents

Match All

Show Source

• object CommonModel
• object ProcessInstanceIncidents-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "instanceId":{
                    "type":"string",
                    "description":"Instance Id"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProcessInstanceIncidentItem"
                    }
                },
                "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 : ProcessInstanceIncidents-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/ProcessInstanceIncidentItem"
            }
        },
        "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: ProcessInstanceIncidentItem

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

Nested Schema : ProcessInstanceIncidentItem

Match All

Show Source

• object CommonModel
• object ProcessInstanceIncidentItem-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the incident."
                },
                "incidentType":{
                    "type":"string",
                    "description":"Type of the incident."
                },
                "createdTime":{
                    "type":"string",
                    "description":"The date and time of incident creation.Has the format yyyy-MM-dd'T'HH:mm:ss.",
                    "format":"date"
                },
                "jobDefinition":{
                    "type":"string",
                    "description":"The jobDefinitionId corresponding to the incident."
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The ID of the process definition that this incident belongs to."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this incident belongs to."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution that created this incident."
                },
                "incidentMessage":{
                    "type":"string",
                    "description":"The message of the exception corresponding to this incident."
                },
                "exceptionTrace":{
                    "type":"string",
                    "description":"The stack trace of the exception corresponding to this incident.."
                },
                "activityName":{
                    "type":"string",
                    "description":"The display name of the activity for which the incident is created."
                }
            }
        }
    ]
}

Nested Schema : ProcessInstanceIncidentItem-allOf[1]

Type: object

Show Source

• activityName: string
  The display name of the activity for which the incident is created.
• createdTime: string (date)
  The date and time of incident creation.Has the format yyyy-MM-dd'T'HH:mm:ss.
• exceptionTrace: string
  The stack trace of the exception corresponding to this incident..
• executionId: string
  The ID of the execution that created this incident.
• id: string
  The ID of the incident.
• incidentMessage: string
  The message of the exception corresponding to this incident.
• incidentType: string
  Type of the incident.
• jobDefinition: string
  The jobDefinitionId corresponding to the incident.
• processDefinitionId: string
  The ID of the process definition that this incident belongs to.
• processInstanceId: string
  The ID of the process instance that this incident belongs to.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the incident."
        },
        "incidentType":{
            "type":"string",
            "description":"Type of the incident."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time of incident creation.Has the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "jobDefinition":{
            "type":"string",
            "description":"The jobDefinitionId corresponding to the incident."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this incident belongs to."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this incident belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution that created this incident."
        },
        "incidentMessage":{
            "type":"string",
            "description":"The message of the exception corresponding to this incident."
        },
        "exceptionTrace":{
            "type":"string",
            "description":"The stack trace of the exception corresponding to this incident.."
        },
        "activityName":{
            "type":"string",
            "description":"The display name of the activity for which the incident is created."
        }
    }
}

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