1. REST API for Oracle Integration 3
  2. Tasks
  3. Integrations
  4. Monitoring

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. You can perform multi-word value search using the businessIDValue, primaryValue, secondaryValue, and tertiaryValue attributes in query filter parameters. To perform multi-word searches, encapsulate the search values in double quotation marks followed by single quotation marks. Search includes error messages and detailed error messages. For example, '"Test-instance1"', and '"Testing instance2"'. You can also search primaryValue, secondaryValue, and tertiaryValue values against the specified primaryName, secondaryName, and tertiaryName variable names.

Request

Query Parameters

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

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

  • 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.
  • 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 instances starting at the 4th item, and the list will contain 16 items.
  • 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 starting at the 4th item, and the list will contain 16 items.

  • Filter parameters.

    • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h. Oracle recommends to use the time window and date range values as close as possible to the required time period.
    • code: Integration identifier.
    • orderBy: Sorts by creation date and last updated date. Valid values are lastupdateddate and creationdate. Default value is lastupdateddate.
    • version: Integration version.
    • startdate: Custom time range start date/time in UTC format for filtering instances. You can select any date within the 32 days range of Oracle Integration Instance data retention period. Oracle recommends to use the time window and date range values as close as possible to the required time period.
    • enddate: Custom time range end date/time in UTC format for filtering instances. You can select any date within the 32 days range of Oracle Integration Instance data retention period. Oracle recommends to use the time window and date range values as close as possible to the required time period.
    • id: Integration instance identifier.
    • instanceId: Integration instance identifier
    • primaryValue: Searches across primary variable values. To perform multi-word searches, encapsulate the search values in double quotation marks. To perform exact match searches, encapsulate the search values in square brackets followed by single quotation marks. For example, '[test-instance1]', and '[testinginstance2]'. If a variable value contains an underscore character, for example test_instance, then you must search using the complete word test_instance. Search does not show matching responses if you search using a part of the the variable value word that contains underscore character.
    • secondaryValue: Searches across secondary and tertiary variable values. To perform multi-word searches, encapsulate the search values in double quotation marks. To perform exact match searches, encapsulate the search values in square brackets followed by single quotation marks. For example, '[test-instance1]', and '[testinginstance2]'. To search for an exact secondary tracking variable value, use the secondaryName in addition to the secondaryValue. If a variable value contains an underscore character, for example test_instance, then you must search using the complete word test_instance. Search does not show matching responses if you search using a part of the the variable value word that contains underscore character.
    • tertiaryValue: Searches across secondary and tertiary variable values. To perform multi-word searches, encapsulate the search values in double quotation marks. To perform exact match searches, encapsulate the search values in square brackets followed by single quotation marks. For example, '[test-instance1]', and '[testinginstance2]'. To search for an exact tertiary tracking variable value, use the tertiaryName in addition to the tertiaryValue. If a variable value contains an underscore character, for example test_instance, then you must search using the complete word test_instance. Search does not show matching responses if you search using a part of the the variable value word that contains underscore character.
    • primaryName: Primary variable name.
    • secondaryName: Secondary variable name.
    • tertiaryName: Tertiary variable name.
    • businessIDValue: Searches across the primary, secondary and tertiary variables values. To perform multi-word searches, encapsulate the search values in double quotation marks followed by single quotation marks. For example, '"uyt-atz"'. To perform exact match searches, encapsulate the search values in square brackets followed by single quotation marks. For example, '[test-instance1]', and '[testinginstance2]'. If a variable value contains an underscore character, for example test_instance, then you must search using the complete word test_instance. Search does not show matching responses if you search using a part of the the variable value word that contains underscore character.
    • errorMessage: Searches all the errored instances and matches with the given short error message words. To perform multi-word searches, encapsulate the search values in double quotation marks followed by single quotation marks. For example, '"uyt-atz"'. To perform exact match searches, encapsulate the search values in square brackets followed by single quotation marks. For example, '[test-instance1]', and '[testinginstance2]'.
    • errorDetails: Searches all the errored instances and matches with the given error message words. To perform multi-word searches, encapsulate the search values in double quotation marks followed by single quotation marks. For example, '"uyt-atz"'. To perform exact match searches, encapsulate the search values in square brackets followed by single quotation marks. For example, '[test-instance1]', and '[testinginstance2]'.
    • recoverable: Indicates whether to fetch recoverable or non-recoverable instances. Valid values are true/false.
    • includePurged: Indicates whether to fetch purged instances. Valid values are yes, no, and onlyPurged.
    • projectCode: Project identifier.
    • connectionCode: Connection identifier.
    • integration-style: Integration style identifier. Valid values are appdriven/scheduled.

    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'}
  • 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. 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

200 Response

Successful operation
Body ()
Root Schema : ErrorsRs
Type: object
Show Source
Nested Schema : items
Type: array
List of Errors
Show Source
Nested Schema : ErrorRs
Match All
Show Source
Nested Schema : ErrorBaseRs
Match All
Show Source
Nested Schema : TrackingBaseRs
Match All
Show Source
Nested Schema : IdRs
Match All
Show Source
Nested Schema : GenericRestRs
Type: object
Show Source
Nested Schema : IdRs-allOf[1]
Type: object
Show Source
Nested Schema : TrackingBaseRs-allOf[2]
Type: object
Show Source
Nested Schema : ErrorBaseRs-allOf[3]
Type: object
Show Source
Nested Schema : ErrorRs-allOf[4]
Type: object
Show Source
Nested Schema : ConnectionErrorRs
Match All
Show Source
Nested Schema : IntegrationBaseRs
Match All
Show Source
Nested Schema : ConnectionBaseRs
Type: object
Match All
Show Source
Nested Schema : IdResource
Match All
Show Source
Nested Schema : GenericRestResource
Type: object
Show Source
Nested Schema : IdResource-allOf[1]
Type: object
Show Source
Nested Schema : ConnectionErrorRs-allOf[3]
Type: object
Show Source
Nested Schema : IntegrationBaseRs-allOf[2]
Type: object
Show Source

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors?integrationInstance=service-instance
Back to Top