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

Supported Media Types

• application/json; charset=utf-8

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8
• application/vnd.oracle.resource+json;type=singular

200 Response

Successful operation

Body ()

Root Schema : errors

Type: object

Show Source

• dataFetchTime: string(date-time)
• items: array items
• links: array links
• timeWindow: string
• totalRecordsCount: integer(int64)
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "timeWindow":{
            "type":"string"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        },
        "totalRecordsCount":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"errors"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object error

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ErrorRs"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : error

Type: object

Show Source

• connection: object ConnectionErrorRs
• creationDate: string(date-time)
• errorDetails: string
• errorMessage: string
• faultId: string
• id: string
• integration: object IntegrationBaseRs
• integrationDeleted: boolean
  Default Value: false
• isDataAccurate: boolean
  Default Value: false
• lastTrackedTime: string(date-time)
• links: array links
• primaryName: string
• primaryValue: string
• recoverable: boolean
  Default Value: false
• retryCount: integer(int32)
• runId: string
• status: string
  Allowed Values: [ "IN_PROGRESS", "FAILED", "COMPLETED", "ABORTED", "RECOVERING", "UNKNOWN", "RESUBMITTED" ]

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastTrackedTime":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "RECOVERING",
                "UNKNOWN",
                "RESUBMITTED"
            ]
        },
        "primaryName":{
            "type":"string"
        },
        "primaryValue":{
            "type":"string"
        },
        "integration":{
            "$ref":"#/definitions/IntegrationBaseRs"
        },
        "connection":{
            "$ref":"#/definitions/ConnectionErrorRs"
        },
        "errorMessage":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        },
        "faultId":{
            "type":"string"
        },
        "retryCount":{
            "type":"integer",
            "format":"int32"
        },
        "recoverable":{
            "type":"boolean",
            "default":false
        },
        "runId":{
            "type":"string"
        },
        "integrationDeleted":{
            "type":"boolean",
            "default":false
        },
        "isDataAccurate":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"error"
    }
}

Nested Schema : ConnectionErrorRs

Type: object

Show Source

• appTypeDisplayName: string
• appTypeVersion: string
• displayName: string
• id: string
• links: array links
• majorVersion: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "majorVersion":{
            "type":"string"
        },
        "appTypeDisplayName":{
            "type":"string"
        },
        "appTypeVersion":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationBaseRs

Type: object

Show Source

• code: string
• id: string
• links: array links
• mepType: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "mepType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "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://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors/28800004

Back to Top