Jump to

• Request
• Response

Get Faults for a Process Instance

get

/ic/api/process/v1/processes/{processId}/faults

Gets faults for a process instance.

Request

Path Parameters

• processId: string
  Value of process ID

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : processFault

Type: object

Show Source

• componentName(optional): string
• compositeDN(optional): string
• faultActionTypes(optional): array faultActionTypes
• faultId(optional): integer(int64)
• faultMessage(optional): string
• faultName(optional): string
• faultState(optional): string
• faultTime(optional): string
• flowId(optional): integer(int64)
• levels(optional): integer(int32)
• links(optional): array links
• retryCount(optional): integer(int32)
• title(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "faultId":{
            "type":"integer",
            "format":"int64"
        },
        "faultName":{
            "type":"string"
        },
        "flowId":{
            "type":"integer",
            "format":"int64"
        },
        "faultMessage":{
            "type":"string"
        },
        "faultState":{
            "type":"string"
        },
        "compositeDN":{
            "type":"string"
        },
        "componentName":{
            "type":"string"
        },
        "faultTime":{
            "type":"string"
        },
        "retryCount":{
            "type":"integer",
            "format":"int32"
        },
        "faultActionTypes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"processFault",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

Nested Schema : faultActionTypes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

500 Response

Something went wrong

Back to Top