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. 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. 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

• fields: string
  Limit query results to a few fields. Valid values are runId, id and all.
• groupBy: string

  • Groups results by integration name. Valid values: integration.

• 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.
• limit: 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: 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: string

  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 execution time, creation date, and last updated date. Valid values are lastupdateddate, creationdate, and executiontime. Default value is lastupdateddate.
  • version: Integration version.
  • minDuration: Retrieve instances that ran for a minimum duration specified in milliseconds.
  • maxDuration: Retrieve instances that ran for a maximum duration specified in milliseconds .
  • 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. 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.
  • 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 followed by single 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 followed by single 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.
  • 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
  • instanceId: Integration instance identifier
  • includePurged: Indicates whether to fetch purged instances. Valid values are yes, no, and onlyPurged.
  • parentInstanceId: Integration instance identifier of a parent integration to search for locally invoked child integration instances.
  • projectCode: Project identifier.
  • integration-style: Integration style identifier. Valid values are appdriven/scheduled.

  Example:

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

• return: string
  Controls the response data. Valid URL parameter values are:

  • summary: Response does not contain non-primary tracking variables.
  • minimal: Response does not contain integration name and project name. When this value is specified, minimal information of the instance data is added in the response thus making the response time faster than the default API call. In this response, the attributes integrationName and projectFound 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.
  • metadata: Response contains metadata of the instance, and integration name and project name if available. Metadata comprises of details such as instanceId, integrationId, integrationVersion, and status.
  • metadataminimal: It's functionality is the same as metadata, however the response does not include integration name and project name.

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 : InstancesRs

Type: object

Show Source

• data-fetch-time: string (date-time)
  Data Fetch Time
• has-more: boolean
  Has More
• integration-items: array integration-items
  List of Integration Instances
• items: array items
  List of Instance
• limit: integer (int32)
  Limit
• 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 Instance",
            "items":{
                "$ref":"#/components/schemas/InstanceRs"
            }
        },
        "integration-items":{
            "type":"array",
            "description":"List of Integration Instances",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int64"
        },
        "time-window":{
            "type":"string",
            "description":"Time Window"
        },
        "data-fetch-time":{
            "type":"string",
            "description":"Data Fetch Time",
            "format":"date-time"
        },
        "total-records-count":{
            "type":"integer",
            "description":"Total Records Count",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Limit",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Has More"
        }
    }
}

Nested Schema : integration-items

Type: array

List of Integration Instances

Show Source

• Array of: object Object

{
    "type":"array",
    "description":"List of Integration Instances",
    "items":{
        "$ref":"#/components/schemas/Object"
    }
}

Nested Schema : items

Type: array

List of Instance

Show Source

• Array of: object InstanceRs

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

Nested Schema : Object

Type: object

Nested Schema : InstanceRs

Type: object

Show Source

• activity-stream: array activity-stream
  Activity Streams
• audit-trail: array audit-trail
  Audit Trails
• creation-date: string (date-time)
  Creation Date
• date: string (date-time)
  Date
• duration: integer (int64)
  Duration
• error-milestones: string
  Error Milestones
• flow-milestones: string
  Flow Milestones
• has-recoverable-faults: boolean
• instance-id: string
  Instance Id
• instance-reporting-level: string
  Instance Reporting Level
• integration: string
  Integration
• integration-id: string
  Integration Id
• integration-name: string
  Integration Name
• integration-version: string
  Integration Version
• invoke-event-ids: string
  Invoke Event Ids
• invoked-by: string
  Invoked By
• is-data-accurate: boolean
  Data Accuracy
• is-litmus-flow: boolean
• is-litmus-supported: boolean
• isPurged: boolean
  Purged instances
• last-tracked-time: string (date-time)
  Last Tracked Time
• litmus-description: string
• litmus-recording-id: string
• litmus-result-status: string
• mep-type: string
  MEP Type
• non-schedule-async: boolean
• opc-request-id: string
  opc Request Id
• parent-instance-id: string
  Parent Instance Id
• pk-name: string
  Primary Key name
• pk-value: string
  Primary Key Value
• processing-end-date: string (date-time)
  Processing End Date
• project-code: string
  Project Code
• project-found: boolean
  Project Found
• received-date: string (date-time)
  Received Date
• request-id: string
  Request Id
• run-id: string
  Run Id
• scheduled-time: string (date-time)
  Scheduled Time
• secondary-tracking-name: string
  Secondary Key Name
• secondary-tracking-value: string
  Secondary Key Value
• status: string
  Allowed Values: [ "IN_PROGRESS", "SCHEDULE_WAITING", "QUEUED", "SCHEDULE_PAUSED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "UNKNOWN", "RESUBMITTED", "BLOCKED" ]
• tertiary-tracking-name: string
  Tertiary Key Name
• tertiary-tracking-value: string
  Tertiary Key Value
• tracing-level: string
  Tracing Level
• trackings: array trackings
  List of Trackings Data

{
    "type":"object",
    "properties":{
        "project-code":{
            "type":"string",
            "description":"Project Code"
        },
        "instance-reporting-level":{
            "type":"string",
            "description":"Instance Reporting Level"
        },
        "isPurged":{
            "type":"boolean",
            "description":"Purged instances"
        },
        "integration":{
            "type":"string",
            "description":"Integration"
        },
        "instance-id":{
            "type":"string",
            "description":"Instance Id"
        },
        "invoked-by":{
            "type":"string",
            "description":"Invoked By"
        },
        "integration-id":{
            "type":"string",
            "description":"Integration Id"
        },
        "integration-version":{
            "type":"string",
            "description":"Integration Version"
        },
        "status":{
            "$ref":"#/components/schemas/FlowStatus"
        },
        "pk-name":{
            "type":"string",
            "description":"Primary Key name"
        },
        "pk-value":{
            "type":"string",
            "description":"Primary Key Value"
        },
        "date":{
            "type":"string",
            "description":"Date",
            "format":"date-time"
        },
        "secondary-tracking-name":{
            "type":"string",
            "description":"Secondary Key Name"
        },
        "secondary-tracking-value":{
            "type":"string",
            "description":"Secondary Key Value"
        },
        "has-recoverable-faults":{
            "type":"boolean"
        },
        "tertiary-tracking-name":{
            "type":"string",
            "description":"Tertiary Key Name"
        },
        "tertiary-tracking-value":{
            "type":"string",
            "description":"Tertiary Key Value"
        },
        "integration-name":{
            "type":"string",
            "description":"Integration Name"
        },
        "audit-trail":{
            "type":"array",
            "description":"Audit Trails",
            "items":{
                "type":"string"
            }
        },
        "activity-stream":{
            "type":"array",
            "description":"Activity Streams",
            "items":{
                "type":"string"
            }
        },
        "trackings":{
            "type":"array",
            "description":"List of Trackings Data",
            "items":{
                "$ref":"#/components/schemas/TrackingDataRs"
            }
        },
        "run-id":{
            "type":"string",
            "description":"Run Id"
        },
        "creation-date":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time"
        },
        "last-tracked-time":{
            "type":"string",
            "description":"Last Tracked Time",
            "format":"date-time"
        },
        "mep-type":{
            "type":"string",
            "description":"MEP Type"
        },
        "is-data-accurate":{
            "type":"boolean",
            "description":"Data Accuracy"
        },
        "litmus-description":{
            "type":"string"
        },
        "litmus-recording-id":{
            "type":"string"
        },
        "is-litmus-flow":{
            "type":"boolean"
        },
        "is-litmus-supported":{
            "type":"boolean"
        },
        "litmus-result-status":{
            "type":"string"
        },
        "non-schedule-async":{
            "type":"boolean"
        },
        "project-found":{
            "type":"boolean",
            "description":"Project Found"
        },
        "parent-instance-id":{
            "type":"string",
            "description":"Parent Instance Id"
        },
        "request-id":{
            "type":"string",
            "description":"Request Id"
        },
        "flow-milestones":{
            "type":"string",
            "description":"Flow Milestones"
        },
        "invoke-event-ids":{
            "type":"string",
            "description":"Invoke Event Ids"
        },
        "error-milestones":{
            "type":"string",
            "description":"Error Milestones"
        },
        "received-date":{
            "type":"string",
            "description":"Received Date",
            "format":"date-time"
        },
        "duration":{
            "type":"integer",
            "description":"Duration",
            "format":"int64"
        },
        "scheduled-time":{
            "type":"string",
            "description":"Scheduled Time",
            "format":"date-time"
        },
        "processing-end-date":{
            "type":"string",
            "description":"Processing End Date",
            "format":"date-time"
        },
        "tracing-level":{
            "type":"string",
            "description":"Tracing Level"
        },
        "opc-request-id":{
            "type":"string",
            "description":"opc Request Id"
        }
    }
}

Nested Schema : activity-stream

Type: array

Activity Streams

Show Source

• Array of: string

{
    "type":"array",
    "description":"Activity Streams",
    "items":{
        "type":"string"
    }
}

Nested Schema : audit-trail

Type: array

Audit Trails

Show Source

• Array of: string

{
    "type":"array",
    "description":"Audit Trails",
    "items":{
        "type":"string"
    }
}

Nested Schema : trackings

Type: array

List of Trackings Data

Show Source

• Array of: object TrackingDataRs

{
    "type":"array",
    "description":"List of Trackings Data",
    "items":{
        "$ref":"#/components/schemas/TrackingDataRs"
    }
}

Nested Schema : TrackingDataRs

Type: object

Show Source

• name: string
• primary: boolean
• value: string

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

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

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

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

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

Example: Limit results to runId field only

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "fields=runId'" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?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={code : 'SC2RNSYNC', timewindow : '3d'}" -d "offset=3&limit=16" -d "fields=id" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances?integrationInstance=service-instance

Back to Top