Jump to

• Request
• Response

Get a Process Instance Incident

get

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

Retrieves the process instance incident detail using the incident ID.

Note:

You can use this API only on structured processes.

Request

Path Parameters

• id(required): string
  Process Instance Id
• incidentId(required): string
  Incident 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 : 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 : CommonModel

Type: object

Show Source

• links: array links

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

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

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

Incident 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