Jump to

• Request
• Response
• Examples

Retrieve an Integration Instance

get

/ic/api/integration/v1/monitoring/instances/{id}

Retrieves detailed information about the integration instance with the specified instance ID.

Request

Path Parameters

• id(required): string
  Integration instance identifier.

Query Parameters

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

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

404 Response

Instance not found

500 Response

Server error

Back to Top

Examples

The following example shows how to get details for an 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 details about the integration instance with instance id 500400209

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/500400209?integrationInstance=service-instance

Back to Top