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

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• id: string
  Integration instance identifier.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root 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

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://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/instances/500400209

Back to Top