Jump to

• Request
• Response
• Examples

Retrieve an Errored Integration Instance

get

/ic/api/integration/v1/monitoring/errors/{id}

Retrieves details about the errored integration instance with the specified errored instance identifier.

Request

Path Parameters

• id(required): string
  Errored integration instance identifier.

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
• return: string
  Controls the response data. Valid value is minimal. For example, return=minimal. When this value is specified, minimal information of the instance data is added in the response thus making the response time quicker than the default API call. Response does not contain connection details like appTypeDisplayName, appTypeName, and appTypeVersion and in this response, the attributes integration.name and integrationDeleted are set to their default and should not be relied upon. This URL parameter is recommended if performance is preferred instead of the availability of complete instance data.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : ErrorsRs

Type: object

Show Source

• data-fetch-time: string (date-time)
  Date Fetch Time
• instanceReportingLevel: string
  Instance Reporting Level
• isPurged: boolean
  Purged Instances
• items: array items
  List of Errors
• opcRequestId: string
  opc Request Id
• time-window: string
  Time Window
• total-records-count: integer (int64)
  Total Records Count
• total-results: integer (int64)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Errors",
            "items":{
                "$ref":"#/components/schemas/ErrorRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int64"
        },
        "time-window":{
            "type":"string",
            "description":"Time Window"
        },
        "data-fetch-time":{
            "type":"string",
            "description":"Date Fetch Time",
            "format":"date-time"
        },
        "total-records-count":{
            "type":"integer",
            "description":"Total Records Count",
            "format":"int64"
        },
        "opcRequestId":{
            "type":"string",
            "description":"opc Request Id"
        },
        "instanceReportingLevel":{
            "type":"string",
            "description":"Instance Reporting Level"
        },
        "isPurged":{
            "type":"boolean",
            "description":"Purged Instances"
        }
    }
}

Nested Schema : items

Type: array

List of Errors

Show Source

• Array of: ErrorRs

{
    "type":"array",
    "description":"List of Errors",
    "items":{
        "$ref":"#/components/schemas/ErrorRs"
    }
}

Nested Schema : ErrorRs

Match All

Show Source

• allOf ErrorBaseRs
• allOf TrackingBaseRs
• allOf IdRs
• object GenericRestRs
• object ErrorRs-allOf[4]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorBaseRs"
        },
        {
            "$ref":"#/components/schemas/TrackingBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "recoveryMinTime":{
                    "type":"string",
                    "format":"date-time"
                },
                "isDataAccurate":{
                    "type":"boolean"
                },
                "runId":{
                    "type":"string"
                },
                "recoverable":{
                    "type":"boolean"
                },
                "integrationDeleted":{
                    "type":"boolean"
                }
            }
        }
    ]
}

Nested Schema : ErrorBaseRs

Match All

Show Source

• allOf TrackingBaseRs
• allOf IdRs
• object GenericRestRs
• object ErrorBaseRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TrackingBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "projectCode":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "errorMessage":{
                    "type":"string"
                },
                "errorDetails":{
                    "type":"string"
                },
                "instanceId":{
                    "type":"string"
                },
                "faultId":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "retryCount":{
                    "type":"integer",
                    "format":"int32"
                },
                "errorLocation":{
                    "type":"string"
                },
                "invokedBy":{
                    "type":"string"
                },
                "endPointName":{
                    "type":"string"
                },
                "endPointType":{
                    "type":"string"
                },
                "endPointOperation":{
                    "type":"string"
                },
                "errorActionName":{
                    "type":"string"
                },
                "errorActionType":{
                    "type":"string"
                },
                "milestone":{
                    "type":"string"
                },
                "integration":{
                    "$ref":"#/components/schemas/IntegrationBaseRs"
                },
                "connection":{
                    "$ref":"#/components/schemas/ConnectionErrorRs"
                },
                "opcRequestId":{
                    "type":"string"
                },
                "isPurged":{
                    "type":"boolean"
                },
                "instanceReportingLevel":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : TrackingBaseRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object TrackingBaseRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "creationDate":{
                    "type":"string",
                    "format":"date-time"
                },
                "lastTrackedTime":{
                    "type":"string",
                    "format":"date-time"
                },
                "status":{
                    "$ref":"#/components/schemas/FlowStatus"
                },
                "primaryName":{
                    "type":"string"
                },
                "primaryValue":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingBaseRs-allOf[2]

Type: object

Show Source

• creationDate: string (date-time)
• lastTrackedTime: string (date-time)
• primaryName: string
• primaryValue: string
• status: string
  Allowed Values: [ "IN_PROGRESS", "SCHEDULE_WAITING", "QUEUED", "SCHEDULE_PAUSED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "UNKNOWN", "RESUBMITTED", "BLOCKED" ]

{
    "type":"object",
    "properties":{
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastTrackedTime":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "$ref":"#/components/schemas/FlowStatus"
        },
        "primaryName":{
            "type":"string"
        },
        "primaryValue":{
            "type":"string"
        }
    }
}

Nested Schema : ErrorBaseRs-allOf[3]

Type: object

Show Source

• connection: ConnectionErrorRs
• endPointName: string
• endPointOperation: string
• endPointType: string
• errorActionName: string
• errorActionType: string
• errorCode: string
• errorDetails: string
• errorLocation: string
• errorMessage: string
• faultId: string
• instanceId: string
• instanceReportingLevel: string
• integration: IntegrationBaseRs
• invokedBy: string
• isPurged: boolean
• milestone: string
• opcRequestId: string
• projectCode: string
• projectName: string
• retryCount: integer (int32)

{
    "type":"object",
    "properties":{
        "projectCode":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        },
        "instanceId":{
            "type":"string"
        },
        "faultId":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "retryCount":{
            "type":"integer",
            "format":"int32"
        },
        "errorLocation":{
            "type":"string"
        },
        "invokedBy":{
            "type":"string"
        },
        "endPointName":{
            "type":"string"
        },
        "endPointType":{
            "type":"string"
        },
        "endPointOperation":{
            "type":"string"
        },
        "errorActionName":{
            "type":"string"
        },
        "errorActionType":{
            "type":"string"
        },
        "milestone":{
            "type":"string"
        },
        "integration":{
            "$ref":"#/components/schemas/IntegrationBaseRs"
        },
        "connection":{
            "$ref":"#/components/schemas/ConnectionErrorRs"
        },
        "opcRequestId":{
            "type":"string"
        },
        "isPurged":{
            "type":"boolean"
        },
        "instanceReportingLevel":{
            "type":"string"
        }
    }
}

Nested Schema : ErrorRs-allOf[4]

Type: object

Show Source

• integrationDeleted: boolean
• isDataAccurate: boolean
• recoverable: boolean
• recoveryMinTime: string (date-time)
• runId: string

{
    "type":"object",
    "properties":{
        "recoveryMinTime":{
            "type":"string",
            "format":"date-time"
        },
        "isDataAccurate":{
            "type":"boolean"
        },
        "runId":{
            "type":"string"
        },
        "recoverable":{
            "type":"boolean"
        },
        "integrationDeleted":{
            "type":"boolean"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : ConnectionErrorRs

Match All

Show Source

• object allOf ConnectionBaseRs
• allOf IdResource
• object GenericRestResource
• object ConnectionErrorRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "displayName":{
                    "type":"string"
                },
                "majorVersion":{
                    "type":"string"
                },
                "appTypeDisplayName":{
                    "type":"string"
                },
                "appTypeName":{
                    "type":"string"
                },
                "appTypeVersion":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IntegrationBaseRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object IntegrationBaseRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "version":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "projectCode":{
                    "type":"string"
                },
                "code":{
                    "type":"string"
                },
                "mepType":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : ConnectionBaseRs

Type: object

Match All

Show Source

• allOf IdResource
• object GenericRestResource

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        }
    ]
}

Nested Schema : IdResource

Match All

Show Source

• object GenericRestResource
• object IdResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "projectId":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestResource

Type: object

Show Source

• links: array links
• processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

Nested Schema : IdResource-allOf[1]

Type: object

Show Source

• id: string
• projectId: string
• projectName: string

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ConnectionErrorRs-allOf[3]

Type: object

Show Source

• appTypeDisplayName: string
• appTypeName: string
• appTypeVersion: string
• displayName: string
• majorVersion: string

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "majorVersion":{
            "type":"string"
        },
        "appTypeDisplayName":{
            "type":"string"
        },
        "appTypeName":{
            "type":"string"
        },
        "appTypeVersion":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
• media-type: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationBaseRs-allOf[2]

Type: object

Show Source

• code: string
• mepType: string
• name: string
• projectCode: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "projectCode":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "mepType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

400 Response

Malformed parameters

404 Response

Integration not found

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve details about a specific error integration instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Get the details of an error integration instance

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors/28800004?integrationInstance=service-instance

Back to Top