Jump to

• Request
• Response
• Examples

Retrieve Errored Instances

get

/ic/api/integration/v1/monitoring/errors

Retrieves information about all integration instances that have a errored status in the past hour, ordered by integration instance last updated time. Retrieves information such as integration instance identifiers, fault identifiers, integration details, error details and retry count. It includes connection information if the error occurred in the connection.

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• expand(optional): string

  • Includes additional details in the response about integrations, or about connections. Valid values: integration, connection.

  Default Value: integration
• groupBy(optional): string

  • Groups results by messages, integration name, or connection name. Valid values: messages, integration, connection.

• limit(optional): integer(int32)
  Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list error integration instances starting at the 4th item, and the list will contain 16 items.
• offset(optional): integer(int32)
  Use with the limit parameter for paginating through the returned results. Default is 0. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list connections starting at the 4th item, and the list will contain 16 items.
• q(optional): string

  Filter parameters.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
  • code: Integration identifier.
  • version: Integration version.
  • startdate: Custom time range start date/time in UTC format for filtering instances.
  • enddate: Custom time range end date/time in UTC format for filtering instances.
  • id: Integration instance identifier.
  • primaryValue: Value of primary tracking variable.
  • secondaryValue: Value of secondary tracking variable.
  • tertiaryValue: Value of tertiary tracking variable.
  • recoverable: Indicates whether to fetch recoverable or non-recoverable instances. Valid values are true/false.

  Example:

  {startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', code:'ERROR', version:'01.00.0000', recoverable:'true', id:'118'}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : errors

Type: object

Show Source

• dataFetchTime(optional): string(date-time)
• items(optional): array items
• links(optional): array links
• timeWindow(optional): string
• totalRecordsCount(optional): integer(int64)
• totalResults(optional): 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(optional): object ConnectionErrorRs
• creationDate(optional): string(date-time)
• errorDetails(optional): string
• errorMessage(optional): string
• faultId(optional): string
• id(optional): string
• integration(optional): object IntegrationBaseRs
• integrationDeleted(optional): boolean
  Default Value: false
• isDataAccurate(optional): boolean
  Default Value: false
• lastTrackedTime(optional): string(date-time)
• links(optional): array links
• primaryName(optional): string
• primaryValue(optional): string
• recoverable(optional): boolean
  Default Value: false
• retryCount(optional): integer(int32)
• runId(optional): string
• status(optional): 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(optional): string
• appTypeVersion(optional): string
• displayName(optional): string
• id(optional): string
• links(optional): array links
• majorVersion(optional): 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(optional): string
• id(optional): string
• links(optional): array links
• mepType(optional): string
• name(optional): string
• status(optional): string
• version(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): string

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

400 Response

Malformed parameters

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Server error

Back to Top

Examples

The following examples show how to retrieve monitoring details for error integration instances 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 monitoring data for all error integration instances

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

Example: Get monitoring data for all error integration instances and include additional information about integrations

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=integration"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

Example: Get monitoring data for all error integration instances grouped by integration name

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "groupBy=integration"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

Example: Get monitoring data for error instances for integration SC2RNSYNC version 01.00.0000 for the past 3 days

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '3d', code: 'SC2RNSYNC', version: '01.00.0000'}"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

Example: Paginate through returned results

Pagination is done with limit and offset. In this example, we list integrations starting at the fourth item. The list contains 16 items.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16"  https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

Example: Combine Parameters

To combine query parameters, use q with the --data-urlencode option. The other parameters can be added after the -d option.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '3d}" -d "expand=integration&offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors

Back to Top