Jump to

• Request
• Response
• Examples

Retrieve Integration Instances

get

/ic/api/integration/v1/monitoring/instances

Retrieve information about integration instances for the past hour ordered by last updated time.

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• fields(optional): string
  Limit query results to a few fields. Valid values are runId, id and all.
• 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 results 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. The offset is the starting point from which to return records. Default value is 0. For example, offset=3&limit=16 indicates to list results 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.
  • status: Status of the integration instance. Valid values are COMPLETED, FAILED and ABORTED.
  • 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.
  • primaryValue: Value of the primary business identifier.
  • secondaryValue: Value of secondary business identifier.
  • tertiaryValue: Value of tertiary business identifier.
  • businessIDValue: Search for any of the business identifier values - primary, secondary or tertiary.
  • jobid: Recovery job identifier corresponding to bulk resubmission of errored integration instances.
  • runId: Run identifier of the scheduled integration instance.
  • requestId: Applies only to scheduled orchestrations. ID of the request that triggered the integration instance.
  • id: Integration instance identifier
  • parentInstanceId: Integration instance identifier of a parent integration to search for locally invoked child integration instances.

  Example:

  {timewindow:'1h', id:'118', status:'FAILED', code:'ERROR', version:'01.00.0000', requestId:'2432', jobid:'18'}

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : instances

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/InstanceRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "timeWindow":{
            "type":"string"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        },
        "totalRecordsCount":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"instances"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object instance

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : instance

Type: object

Show Source

• activityStream(optional): array activityStream
• auditTrail(optional): array auditTrail
• creationDate(optional): string(date-time)
• date(optional): string(date-time)
• id(optional): string
• integrationId(optional): string
• integrationName(optional): string
• integrationVersion(optional): string
• isDataAccurate(optional): boolean
  Default Value: false
• isLitmusFlow(optional): boolean
  Default Value: false
• isLitmusSupported(optional): boolean
  Default Value: false
• lastTrackedTime(optional): string(date-time)
• links(optional): array links
• litmusDescription(optional): string
• litmusRecordingId(optional): string
• litmusResultStatus(optional): string
• mepType(optional): string
• nonScheduleAsync(optional): boolean
  Default Value: false
• parentInstanceId(optional): string
• pkName(optional): string
• pkValue(optional): string
• projectFound(optional): boolean
  Default Value: false
• requestId(optional): string
• runId(optional): string
• secondaryTrackingName(optional): string
• secondaryTrackingValue(optional): string
• status(optional): string
  Allowed Values: [ "IN_PROGRESS", "FAILED", "COMPLETED", "ABORTED", "RECOVERING", "UNKNOWN", "RESUBMITTED", "SCHEDULE_WAITING", "SCHEDULE_PAUSED" ]
• tertiaryTrackingName(optional): string
• tertiaryTrackingValue(optional): string
• trackings(optional): array trackings

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "integrationId":{
            "type":"string"
        },
        "integrationVersion":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "RECOVERING",
                "UNKNOWN",
                "RESUBMITTED",
                "SCHEDULE_WAITING",
                "SCHEDULE_PAUSED"
            ]
        },
        "pkName":{
            "type":"string"
        },
        "pkValue":{
            "type":"string"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "trackings":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TrackingDataRs"
            }
        },
        "secondaryTrackingName":{
            "type":"string"
        },
        "secondaryTrackingValue":{
            "type":"string"
        },
        "tertiaryTrackingName":{
            "type":"string"
        },
        "tertiaryTrackingValue":{
            "type":"string"
        },
        "integrationName":{
            "type":"string"
        },
        "runId":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastTrackedTime":{
            "type":"string",
            "format":"date-time"
        },
        "requestId":{
            "type":"string"
        },
        "auditTrail":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "activityStream":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "mepType":{
            "type":"string"
        },
        "isDataAccurate":{
            "type":"boolean",
            "default":false
        },
        "litmusDescription":{
            "type":"string"
        },
        "litmusRecordingId":{
            "type":"string"
        },
        "isLitmusFlow":{
            "type":"boolean",
            "default":false
        },
        "isLitmusSupported":{
            "type":"boolean",
            "default":false
        },
        "litmusResultStatus":{
            "type":"string"
        },
        "nonScheduleAsync":{
            "type":"boolean",
            "default":false
        },
        "projectFound":{
            "type":"boolean",
            "default":false
        },
        "parentInstanceId":{
            "type":"string"
        }
    },
    "xml":{
        "name":"instance"
    }
}

Nested Schema : activityStream

Type: array

Show Source

• Array of: string

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

Nested Schema : auditTrail

Type: array

Show Source

• Array of: string

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : trackings

Type: array

Show Source

• Array of: object TrackingDataRs

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

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"
        }
    }
}

Nested Schema : TrackingDataRs

Type: object

Show Source

• name(optional): string
• primary(optional): boolean
  Default Value: false
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "primary":{
            "type":"boolean",
            "default":false
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

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

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

Example: Get details about all integration instances for the integration with the code SC2RNSYNC in uppercase or lowercase for the past 3 days

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

Example: Get details about the scheduled orchestration instance triggered by the specified request ID

Applies only to scheduled orchestrations.

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

Example: Paginate through returned results

Pagination is done with limit and offset. In this example, we list integration instances 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/instances

Example: Limit results to runId field only

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

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={code : 'SC2RNSYNC', timewindow : '3d'}" -d "offset=3&limit=16" -d "fields=id" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/instances

Back to Top