Oracle Public Cloud Machine Oracle Integration Cloud Service REST API

URLの構造

ICS on OPCMのRESTリソースには、次のURL構造を使用してアクセスします。

https://example.com/icsapis/v1/

説明:

example.com - ICS on OPCMを実行しているホスト。

試用またはサブスクリプションの購入の際に受け取ったようこそ電子メールに記載されたサービスURLにこのホストが含まれています。サービスURLの例を次に示します。
```
https://icssvc-acme.ics.dc1.dn1.oraclecorp.com/ics
```
この例の場合、ホストはicssvc-acme.ics.dc1.dn1.oraclecorp.comです。ICS on OPCM自体へのアクセスに使用するものと同じホストを使用して、ICS on OPCM REST APIにアクセスします。

このドキュメントの例では簡略化してすべてexample.comをホストとして使用します。
/icsapis/v1/ - ICS on OPCM RESTリソースの固定接頭辞。リソースの完全なリストは、「RESTエンドポイント」を参照してください。

共通のパス・パラメータ

次の表では、共通のパス・パラメータのそれぞれについて説明します。パス・パラメータでは、一部のAPI操作がサポートされていますが、すべてではありません。

この表では、ICS on OPCM REST APIの一般的なパス・パラメータについて説明します。

名前	説明
`code`	識別子とも呼ばれるcodeは、接続または統合の名前と同じですが、大文字です。
`version`	バージョン番号は`xx.yy.zzzz`という形式で、`xx`がメジャー・バージョン、`yy.zzzz`がマイナー・バージョンです。バージョン番号がわからない場合は、デフォルトのバージョン番号(`01.00.0000`)を試してみることができます。 codeが同じでも、メジャー・バージョンの異なる統合は、同時にアクティブにできます。

名前

説明

code

識別子とも呼ばれるcodeは、接続または統合の名前と同じですが、大文字です。

version

バージョン番号はxx.yy.zzzzという形式で、xxがメジャー・バージョン、yy.zzzzがマイナー・バージョンです。

バージョン番号がわからない場合は、デフォルトのバージョン番号(01.00.0000)を試してみることができます。

codeが同じでも、メジャー・バージョンの異なる統合は、同時にアクティブにできます。

共通の問合せパラメータ

次の表では、共通の問合せパラメータについてそれぞれ説明します。URLエンコード形式のパラメータを渡します。問合せパラメータは一部のAPI操作でサポートされていますが、すべてではありません。

この表では、ICS on OPCM REST APIの一般的な問合せパラメータについて説明します。

名前	説明
`q`	{name like 'QUERY'} & {status like 'STATUS'} & {type like 'TYPE'} 説明: `QUERY`は、テキスト問合せ文字列です。 `STATUS`は、次のいずれかです。 `ALL` `INPROGRESS` `CONFIGURED` `ACTIVATED` `FAILEDACTIVATION` `TYPE`は、次のいずれかです。 `developed` `custom` `prebuilt` このパラメータを使用するすべてのエンドポイントで、名前、ステータスおよびタイプがサポートされるわけではありません。一部のエンドポイントでは、名前のみ、または名前とステータスのみがサポートされます。このパラメータを省略すると、すべてのアイテムが返されます。ワイルドカード文字は`*`です。 q={name like 'org'} q=%7Bname%20like%20%27org%27%7D q={status like 'INPROGRESS'} q=%7Bstatus%20like%20%27INPROGRESS%27%7D q={name like 'org'} & {status like 'all'} q=%7Bname%20like%20%27org%27%7D%20%26%20%7Bstatus%20like%20%27all%27%7D
`orderBy`	`name`または`time`のいずれか。このパラメータを省略すると、返されるアイテムは時間の降順でソートされます。 orderBy=name orderBy=time

名前

説明

q

{name like 'QUERY'} & {status like 'STATUS'} & {type like 'TYPE'}

説明:

QUERYは、テキスト問合せ文字列です。
STATUSは、次のいずれかです。
- ALL
- INPROGRESS
- CONFIGURED
- ACTIVATED
- FAILEDACTIVATION
TYPEは、次のいずれかです。
- developed
- custom
- prebuilt

このパラメータを使用するすべてのエンドポイントで、名前、ステータスおよびタイプがサポートされるわけではありません。一部のエンドポイントでは、名前のみ、または名前とステータスのみがサポートされます。このパラメータを省略すると、すべてのアイテムが返されます。ワイルドカード文字は*です。

q={name like 'org'} 
   q=%7Bname%20like%20%27org%27%7D
q={status like 'INPROGRESS'} 
   q=%7Bstatus%20like%20%27INPROGRESS%27%7D
q={name like 'org'} & {status like 'all'}
   q=%7Bname%20like%20%27org%27%7D%20%26%20%7Bstatus%20like%20%27all%27%7D

orderBy

nameまたはtimeのいずれか。このパラメータを省略すると、返されるアイテムは時間の降順でソートされます。

orderBy=name
orderBy=time

サポートされるメソッド

次の表で要約されている標準HTTPメソッドのリクエストを使用して、ICS on OPCMに対して基本的なCRUD操作(作成、読取り、更新および削除)を実行できます。

この表は、ICS on OPCM REST APIでサポートされているHTTPメソッドを説明します。

HTTPメソッド	説明
`GET`	統合の状態、監視およびパッケージングに関する情報を取得します。
`POST`	統合のインポート、アクティブ化または非アクティブ化、およびルックアップの取得または作成を行います。
`PUT`	統合をインポート(更新)します。
`DELETE`	統合を削除します。

メディア・タイプ

ICS on OPCM REST APIでは、次のメディア・タイプがサポートされます。

application/json
application/xml
application/octet-stream
multipart/form-data

サポートされるヘッダー

ICS on OPCM REST APIでは、次のヘッダーがサポートされ、これらはHTTPリクエストまたはレスポンスのヘッダー・セクションに渡される場合があります。

この表では、ICS on OPCM REST APIでサポートされるHTTPリクエストおよびレスポンス・ヘッダーについて説明します。

ヘッダー	説明	例
`Content-Type`	リクエストの本体のメディア・タイプ。POSTおよびPUTリクエストで必要です。	`Content-Type: application/json`
`Accept`	レスポンスの本体のメディア・タイプ。	`Accept: application/json`

リクエストの送信