Oracle Fusion Cloud ProcurementのREST API

1つの購買オーダーの推奨

post

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/action/communicate

Oracle Business-to-Businessチャネルを介して購買オーダーを推奨します。 B2Bメッセージを使用して、サプライヤに電子的に購買オーダーを送信できます。これらのメッセージは、サプライヤが受信しないか処理できない場合があります。このような状況では、REST APIを使用してオーダーを再確認できます。

リクエスト

パス・パラメータ

purchaseOrdersUniqID(required): string

これは、購買オーダー・リソースの複合キーを構成し、購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、購買オーダー・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Effective-Of:

このヘッダーは文字列値を受け入れます。この文字列は、セミコロンで区切られた=のリストです。有効日範囲操作の実行に使用されます。受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/vnd.oracle.adf.action+json

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

changeOrderNumber: string

連絡する変更オーダー番号を示す値です。この属性にはデフォルト値がありません。
forceCommunicationFlag: boolean

次のいずれかの値が含まれます: 正誤問題。 Trueの場合は、すでに通信した購買オーダーを再送します。 Falseの場合は、再送信しないでください。デフォルト値は「False」です。

{
    "type":"object",
    "properties":{
        "forceCommunicationFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then resend the purchase order that you already communicated. If False, then do not resend. The default value is False.",
            "nullable":true
        },
        "changeOrderNumber":{
            "type":"string",
            "description":"Value that indicates the change order number to communicate. This attribute doesn't have a default value.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

トップに戻る

レスポンス

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

application/json
application/vnd.oracle.adf.actionresult+json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

result(required): string

リクエストが成功した場合、このアクションは成功の値を返します。

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a value of Success."
        }
    },
    "additionalProperties":false
}

トップに戻る

例

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/purchaseOrders/purchaseOrdersUniqID"

数値の例	説明
例1	Oracle Business-to-Businessチャネルを使用して、最新の購買オーダー改訂を推奨します。
例2	Oracle Business-to-Businessチャネルを使用して、特定の購買オーダー改訂を推奨します。

例1

この例では、Oracle Business-to-Businessチャネルを使用して最新の購買オーダー改訂を推奨する方法について説明します。

例1 リクエスト本文

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。この例では、購買オーダーの最新改訂の推奨方法を示します。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
    "name": "communicate",
    "parameters": [
        {
            "forceCommunicationFlag": "true"
        }
    ]
}

例1 レスポンス本文

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
    "result": "Success"
}

例2

この例では、Oracle Business-to-Businessチャネルを使用して、特定の購買オーダー改訂を推奨する方法について説明します。

例2 リクエスト本文

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。この例では、特定の購買オーダー改訂の推奨方法を示します。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

ノート:

特定の購買オーダー改訂を通信するには、電子メッセージングに使用される拡張可能データ・モデル・プロファイルを有効にする必要があります。
「ドキュメント履歴」ページは、ユーザーがREST APIを使用して推奨を開始する変更オーダー番号の下にある通信処理を取得します。

{
    "name": "communicate",
    "parameters": [
        {
            "forceCommunicationFlag": "true"
        },
        {
            "changeOrderNumber": "1"
        }
    ]
}

例2 レスポンス本文

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
    "result": "Success"
}

「トップに戻る」