Oracle Fusion Cloud Applications共通機能のためのREST API

RESTクライアントの操作

REST APIはHTTPメソッドを使用してコンテンツを送受信するため、HTTPメッセージの送受信をサポートする任意のプログラミング言語またはツールを使用してREST APIをテストできます。まず、HTTPリクエストを作成するためのツールを選択します。

ノート:

Oracle REST APIはOData (Open Data Protocol)に準拠していません。

RESTクライアントの選択に関する考慮事項

次のようなFusion Applicationsと相互作用する多数のクライアントから選択できます:

PostmanやAdvanced REST Clientなどのスタンドアロン・クライアント
接続アプリケーションのクライアント

ノート:

Visual Builder Studioを使用してREST APIにアクセスする場合は、「サービス仕様からのサービス接続の作成」を参照してください。 Oracle Integration Cloudを使用してREST APIにアクセスするには、「ドキュメントで説明するMetadataがない外部REST APIを使用するためのRESTアダプタの構成」を参照してください。独自のクライアントを作成してRESTリソースにアクセスすることもできます。 Javaプログラミング言語を使用してクライアントを構築するには、「JAX-RSクライアントAPIを使用したRESTリソースへのアクセス」を参照してください。
cURLコマンドライン・ユーティリティ

クライアントを使用して、次のタスクを実行できます:

REST APIアカウントのユーザー名、パスワードおよびリクエストURLをテストします。
viewおよびdescribeアクションを実行して、RESTリソース、属性およびパラメータについてさらに学習します。
収集された情報を使用して、様々なタイプのHTTPリクエスト(レコードの作成、更新または削除など)を構成および送信します。

cURLを使用してHTTPリクエストを送信する方法

この例では、URL構文を使用してデータを転送する一般的なコマンドライン・ユーティリティであるcURLを使用して、RESTサービスにリクエストを送信します。cURLは、ほとんどのUNIX、WindowsおよびMacintosh環境で使用できます。詳細は、「WindowsへのcURLコマンドライン・ツールのインストール」を参照してください。

次の表に、RESTサービスに使用できる一般的に使用されるcURLオプションを示します。

オプション	説明
-user	`username:password` サーバー認証のユーザー名とパスワードを指定します。
-d	指定したデータ(JSONリクエスト本文)をサーバーに送信します。データを@記号で開始する場合は、データの読取り元のファイル名を@の後に付ける必要があります。
-H	リクエストに追加のHTTPヘッダーを指定します。複数のヘッダーを指定するには、各ヘッダーの前に`-H`オプションを付けます。次に例を示します。 Content-Type: リクエスト本文の形式(POSTなど) 受入: レスポンス本文の形式 X-Auth-Token: 認証トークン
-output	`<file>` 出力を`stdout`ではなくファイルに書き込みます。
-X	HTTPサーバーとの通信時に使用するリクエスト・メソッドを指定します。デフォルトのメソッドはGETです。

次の表に、cURLを使用したGET、PATCHおよびPOST操作の例を示します。

操作 cURLコマンドの例

操作	cURLコマンドの例
`GET`を使用して、すべてのお知らせを取得します。	`curl -u username:password \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'`
`PATCH`を使用して、お知らせを更新します。	`curl -u username:password \ -X PATCH -d @<example_request_payload.json> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/{AnnouncementId} \ -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"`
`POST`を使用して、お知らせを作成します。	`curl -u username:password \ -X POST -d @<example_request_payload.json> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements \ -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"`

GETを使用して、すべてのお知らせを取得します。

curl  -u username:password \
-X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements \
-H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'

PATCHを使用して、お知らせを更新します。

curl -u username:password \
-X PATCH -d @<example_request_payload.json> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/{AnnouncementId} \
-H "Content-Type: application/vnd.oracle.adf.resourceitem+json"

POSTを使用して、お知らせを作成します。

curl  -u username:password \
 -X POST -d @<example_request_payload.json> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements \
 -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"

クライアントを使用したHTTPリクエストの送信方法

スタンドアロン・クライアント、サードパーティのブラウザ拡張機能、または拡張RESTクライアントなどのアドオンを使用して、HTTPリクエストを送信できます。次の表に、クライアントを使用したGET、POSTおよびPATCH操作の例を示します。

操作レスポンス/ペイロードの例

操作	レスポンス/ペイロードの例
GET: お知らせを取得します。リクエストURL : `https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/{AnnouncementId}`	{ "AnnouncementId": "300100090149733", "CategoryCode": "OF", "CreatedBy": "SEED_DATA_FROM_VERTICAL", "CreationDate": "2017-05-18T08:51:04.001+00:00", "ExpireDate": "2017-05-19T00:00:00+00:00", "ExpiryDaysFlag": null, "LastUpdateDate": "2017-05-18T08:51:07.609+00:00", "LastUpdateLogin": "4FC58160B86257BCE0539D06F10A598C", "LastUpdatedBy": "SEED_DATA_FROM_VERTICAL", "ObjectVersionNumber": 1, "StartDate": "2017-05-18T00:00:00+00:00", "Subject": "meeting at 4pm ", "Description": "meeting at 4pm", ... }
POST: お知らせを作成します。リクエストURL : `https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements`	`{ "Subject": "meeting at 4pm", "CategoryCode": "OF", "StartDate": "2017-05-09", "ExpireDate": "2017-05-10", "Description": "meeting at 4pm" }`
PATCH: お知らせの説明を更新します。リクエストURL : `https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/{AnnouncementId}`	`{ "Description": "meeting at 4pm" }`

GET: お知らせを取得します。

リクエストURL : https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/{AnnouncementId}

{
"AnnouncementId": "300100090149733",
"CategoryCode": "OF",
"CreatedBy": "SEED_DATA_FROM_VERTICAL",
"CreationDate": "2017-05-18T08:51:04.001+00:00",
"ExpireDate": "2017-05-19T00:00:00+00:00",
"ExpiryDaysFlag": null,
"LastUpdateDate": "2017-05-18T08:51:07.609+00:00",
"LastUpdateLogin": "4FC58160B86257BCE0539D06F10A598C",
"LastUpdatedBy": "SEED_DATA_FROM_VERTICAL",
"ObjectVersionNumber": 1,
"StartDate": "2017-05-18T00:00:00+00:00",
"Subject": "meeting at 4pm ",
"Description": "meeting at 4pm",
   ...  
}

POST: お知らせを作成します。

リクエストURL : https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements

{
"Subject": "meeting at 4pm",
"CategoryCode": "OF",
"StartDate": "2017-05-09",
"ExpireDate": "2017-05-10",
"Description": "meeting at 4pm"
}

PATCH: お知らせの説明を更新します。

リクエストURL : https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/{AnnouncementId}

{
  "Description": "meeting at 4pm"
}

クライアントの動作を理解し、次に、レコードに関する情報を取得および更新する方法を示すサンプル・ワークフローの「ユーザーへのロールの追加」方法をレビューできます。