REST API for Oracle Integration

機械翻訳について

統合インスタンスの取得

get

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

最終更新時間で順序付けられた過去の時間の統合インスタンスに関する情報を取得します。

リクエスト

サポートされているメディア・タイプ

application/json; charset=utf-8

問合せパラメータ

fields: string

問合せ結果をいくつかのフィールドに制限します。有効な値は、runId、idおよびallです。
limit: integer(int32)

返される結果のページ区切りには、オフセット・パラメータを使用します。この制限は、一度に返すアイテムの最大数です。たとえば、offset=3&limit=16は、4番目のアイテムから始まる結果をリストすることを示し、リストには16個のアイテムが含まれます。
offset: integer(int32)

戻される結果のページ区切りには、制限パラメータを使用します。オフセットは、レコードを返す開始ポイントです。デフォルト値は0です。たとえば、offset=3&limit=16は4番目のアイテムの結果をリストすることを示し、リストには16個のアイテムが含まれます。
q: string
フィルタ・パラメータ
- timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. デフォルト値は1hです。 Oracleでは、要件にできるだけ近い時間枠を指定することをお薦めします。
- code: 統合識別子。
- version: 統合バージョン。
- status: 統合インスタンスのステータス。有効な値はCOMPLETED、FAILEDおよびABORTEDです。
- startdate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲開始日時。 Oracleでは、要件にできるだけ近い開始日を指定することをお薦めします。
- enddate: インスタンスをフィルタリングするためのUTC形式のカスタム時間範囲終了日時。 Oracleでは、要件にできるだけ近い終了日を指定することをお薦めします。
- primaryValue: プライマリ・ビジネス識別子の値。
- secondaryValue: セカンダリ・ビジネス識別子の値。
- tertiaryValue: 第3ビジネス識別子の値。
- businessIDValue: 任意のビジネス識別子値の検索 - プライマリ、セカンダリまたは3次。
- jobid: エラーが発生した統合インスタンスの一括再発行に対応するリカバリ・ジョブ識別子。
- runId: スケジュール済統合インスタンスの実行識別子。
- requestId: スケジュール済オーケストレーションにのみ適用されます。統合インスタンスをトリガーしたリクエストのID。
- id: 統合インスタンス識別子
- parentInstanceId: ローカルで起動された子統合インスタンスを検索する親統合の統合インスタンス識別子。
例:
```
{timewindow:'1h', id:'118', status:'FAILED', code:'ERROR', version:'01.00.0000', requestId:'2432', jobid:'18'}
```

トップに戻る

レスポンス

サポートされているメディア・タイプ

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

200レスポンス

操作の成功

ルート・スキーマ : instances

型: object

ソースを表示

dataFetchTime: string(date-time)
items: array items
links: array links
timeWindow: string
totalRecordsCount: integer(int64)
totalResults: 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"
    }
}

ネストされたスキーマ: items

型: array

ソースを表示

Array of: object instance

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

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object SuiteLink

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

ネストされたスキーマ : instance

型: object

ソースを表示

activityStream: array activityStream
auditTrail: array auditTrail
creationDate: string(date-time)
date: string(date-time)
id: string
integrationId: string
integrationName: string
integrationVersion: string
isDataAccurate: boolean

デフォルト値: false
isLitmusFlow: boolean

デフォルト値: false
isLitmusSupported: boolean

デフォルト値: false
lastTrackedTime: string(date-time)
links: array links
litmusDescription: string
litmusRecordingId: string
litmusResultStatus: string
mepType: string
nonScheduleAsync: boolean

デフォルト値: false
parentInstanceId: string
pkName: string
pkValue: string
projectFound: boolean

デフォルト値: false
requestId: string
runId: string
secondaryTrackingName: string
secondaryTrackingValue: string
status: string

許容値: [ "IN_PROGRESS", "FAILED", "COMPLETED", "ABORTED", "RECOVERING", "UNKNOWN", "RESUBMITTED", "SCHEDULE_WAITING", "SCHEDULE_PAUSED" ]
tertiaryTrackingName: string
tertiaryTrackingValue: string
trackings: 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"
    }
}

ネストされたスキーマ : activityStream

型: array

ソースを表示

Array of: string

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

ネストされたスキーマ: auditTrail

型: array

ソースを表示

Array of: string

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

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object SuiteLink

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

ネストされたスキーマ : trackings

型: array

ソースを表示

Array of: object TrackingDataRs

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

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

href: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : TrackingDataRs

型: object

ソースを表示

name: string
primary: boolean

デフォルト値: false
value: string

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

400レスポンス

パラメータの形式が正しくありません

500レスポンス

サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、統合インスタンスに関するモニタリング詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: すべての統合インスタンスの詳細を取得

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

例: 過去3日間のコードSC2RNSYNCを大文字または小文字と統合するためのすべての統合インスタンスに関する詳細を取得

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

例: 指定のリクエストIDによってトリガーされた、スケジュールされたオーケストレーション・インスタンスに関する詳細を取得

スケジュール済オーケストレーションにのみ適用されます。

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

例: 戻される結果のページ番号付け

limitおよびoffsetでページ区切りが行われます。この例では、4番目のアイテムから開始して統合インスタンスをリストします。リストには16アイテムが含まれます。

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

例: 結果をrunIdフィールドのみに制限

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

例: パラメータの結合

問合せパラメータを組み合せるには、qで--data-urlencodeオプションを使用します。その他のパラメータは、-dオプションの後に追加できます。

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

先頭に戻る