機械翻訳について

Metadataへのアクセス

GETメソッドを使用して、RESTリソースに関するメタデータを/describeエンドポイントから取得できます。 各リソースのメタデータには、オブジェクト・リソースのURI、属性、サポートされているアクション、子リソース、値リスト(LOV)リソースなど、包括的な説明が含まれています。 メタデータには、名前、タイプ、必須、更新可能、問合せ可能などの属性プロパティも含まれます。

特定のリソースのメタデータにアクセスする場合を除き、metadataMode問合せパラメータを使用して記述操作を実行する必要があります。

その他のMetadataを使用しないすべてのリソースURLの取得方法

メタデータを含めずにすべてのリソースのURLのみを取得する場合は、/describeエンドポイントのGETリクエストでmetadataModeパラメータの値をlistに設定します。 たとえば、次のパラメータを使用したリクエストURLの例を次に示します:

https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/describe?metadataMode=list

次に、cURLコマンドを示します:

curl -X GET -u <username:password> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/describe?metadataMode=list

レスポンスにはリソースURLのみが含まれ、リソース・メタデータは含まれません。

すべてのリソースの最小Metadataを取得する方法

アプリケーションに対して取得されるメタデータの量を制限するには、metadataMode=minimal問合せパラメータを使用します。 次のリクエストURLを使用してGET操作を実行します:

https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/describe?metadataMode=minimal

このcURLコマンドを使用して、リソースのみを返すことができます:

curl -X GET -u <username:password> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/describe?metadataMode=minimal

ノート:

metadataModeパラメータを使用して、特定のリソースのメタデータにアクセスすることはできません。

特定のリソースのMetadataを取得する方法

次のリクエストURL構文を使用して、リソースに対してGET操作を実行します:

https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/<resource>/describe

お知らせリソースのメタデータを取得するとします。 次のリクエストURLを使用してGET操作を実行します:

https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/announcements/describe

このcURLコマンドを使用して操作を完了できます:

curl -X GET -u <username:password> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/announcements/describe

優先言語でのMetadataの取得方法

優先言語でメタデータを取得する場合は、GETリクエストのAccept-Languageヘッダーを使用できます。 cURLコマンドにAccept-Languageヘッダーを含めて、その値として言語短縮コードを指定します。 たとえば、トルコ語のメタデータを取得するには、Accept-Languageヘッダー値としてtrを使用します。

次に示すように、cURLコマンドを実行します:

curl -X GET -u <username:password> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partnerTypesLOV/describe \  
  -H 'Accept-Language: tr' \

レスポンスには、翻訳されたメタデータが含まれます。

titleおよびtitlePluralの値がトルコ語で翻訳されていることがわかります。 英語では、これらはPartner TypeおよびPartner Typesとして表示されます。

ノート:

翻訳は、顧客向けラベル(titleやtitlePluralなど)にのみ適用され、アプリケーションの言語設定によって異なります。

OpenAPI形式でMetadataを取得する方法

すべてのREST APIで、OpenAPI形式のMetadataがサポートされるようになりました。 GETリクエストで、Acceptヘッダーをapplication/vnd.oracle.openapi3+jsonに設定して、その形式のメタデータを取得します。 cURLコマンドを使用している場合は、次のようにGETリクエストを作成します:

curl  -u username:password \
-X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/announcements/describe \
'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-H 'Accept: application/vnd.oracle.openapi3+json'

PostmanなどのRESTクライアントを使用している場合は、次に示すようにAcceptヘッダーの値を設定します:

スクリーンショットに示すように、レスポンスはOpenAPI形式で取得されます。

v1リソースのMetadata

デフォルトでは、すべてのv1リソースはOpenAPI形式をサポートしています。 リソースの説明を取得するリクエストを送信する場合、レスポンスにモジュール・レベルの説明を含めるか、リソース・レベルの説明を含めるかを選択できます。 モジュール内のすべてのリソースの説明を取得するには、次のようにリクエストを送信します:

GET https://<servername>/api/boss/data/objects/<module_segment>/v1/$openapi

特定のリソースの説明を取得するには、次のようにリクエストを送信します:

GET https://<servername>/api/boss/data/objects/<module_segment>/v1/$openapi/<resource>