機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

1つの購買オーダーの取消

post

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

不要になった購買オーダーを取り消します。 この処理は、すべての購買オーダー作成メソッドでサポートされています。 このアクションは子レベルにロール・ダウンされます。 購買オーダーに対して取消処理が実行されると、購買オーダー明細およびスケジュールが取り消されます。

リクエスト

パス・パラメータ

• 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

リクエスト本文 - application/vnd.oracle.adf.action+json ()

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

タイプ: object

ソースを表示

• acknowledgeWithinDays: number
  サプライヤが購買オーダー取消を受理または拒否できる日数です。
• BCCEmail: string
  他の受信者に知らせずに購買オーダー取消Eメールのコピーが送信されるEメール・アドレス。
• cancellationReason: string
  購買オーダー取消の事由または目的を説明するテキスト。
• cancelUnfulfilledDemandFlag: boolean
  次のいずれかの値が含まれます: 正誤問題。 Trueの場合、オーダーの取消中に、関連するすべての購買依頼を取り消します。 Falseの場合、オーダーの取消中に関連する購買依頼を取り消さないでください。 この属性にはデフォルト値がありません。
• CCEmail: string
  購買オーダー取消Eメールのコピーが送信されるEメール・アドレス。
• communicationMethod: string
  EメールやFAXなど、購買オーダーの取消がサプライヤに通信される方法。
• email: string
  購買オーダー取消が通信されるサプライヤのEメール・アドレス。
• fax: string
  購買オーダー取消をサプライヤに通信するために使用するFAX番号。
• initiatingParty: string
  変更オーダーの取消をリクエストしたパーティの名前。 有効な値は、バイヤーと依頼者、サプライヤです。
• requiredAcknowledgment: string
  購買オーダーの取消をサプライヤから要求する確認です。 有効な値は、文書およびスケジュール、文書およびなしです。

{
    "type":"object",
    "properties":{
        "acknowledgeWithinDays":{
            "type":"number",
            "description":"Number of days the supplier can decide to accept or reject the purchase order cancellation.",
            "nullable":true
        },
        "communicationMethod":{
            "type":"string",
            "description":"Method by which the purchase order cancellation is communicated to the supplier, such as email or fax.",
            "nullable":true
        },
        "cancellationReason":{
            "type":"string",
            "description":"Text that describes the reason or purpose of the purchase order cancellation.",
            "nullable":true
        },
        "requiredAcknowledgment":{
            "type":"string",
            "description":"Acknowledgment that the application requires from the supplier to cancel a purchase order. Valid values are Document and Schedule, Document and None.",
            "nullable":true
        },
        "CCEmail":{
            "type":"string",
            "description":"Email address to which a copy of the purchase order cancellation email is sent.",
            "nullable":true
        },
        "BCCEmail":{
            "type":"string",
            "description":"Email address to which a copy of the purchase order cancellation email is sent without letting other recipients know.",
            "nullable":true
        },
        "initiatingParty":{
            "type":"string",
            "description":"Name of the party that requested the cancellation of the change order. Valid values are buyer, requester, and supplier.",
            "nullable":true
        },
        "fax":{
            "type":"string",
            "description":"Fax number used to communicate the purchase order cancellation to the supplier.",
            "nullable":true
        },
        "email":{
            "type":"string",
            "description":"Email address of the supplier to whom the purchase order cancellation is communicated.",
            "nullable":true
        },
        "cancelUnfulfilledDemandFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then cancel all the associated requisitions while canceling an order. If False, then do not cancel the associated requisitions while canceling an order. This attribute does not 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 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 リクエスト本文

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

{
	"name": "cancel",
	"parameters": [
	{
		"cancellationReason": "No longer required"
	},
	{
		"initiatingParty": "buyer"
	}
	]
}

例1 レスポンス本文

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

{ 
	"result": "SUCCESS"
}

例2 リクエスト本文

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 この例では、購買オーダーが正常に取り消され、未履行需要が再稼働されます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
	"name": "cancel",
	"parameters": [
	{
		"cancellationReason": "Cancel a purchase order"
	},
	{
		"initiatingParty": "buyer"
	},
	{
		"cancelUnfulfilledDemandFlag": "false"
	}
	]
}

例2 レスポンス本文

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

{ 
	"result": "SUCCESS"
}

例3 リクエスト本文

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 この例では、購買オーダーが正常に取り消され、購買オーダーの取消がEメールでサプライヤに伝達されます。 以前にCCおよびBCCを使用したセカンダリ受信者への購買オーダーの通信機能にオプト・インしている場合は、カーボン・コピーおよびブラインド・カーボン・コピーを送信することで、追加のサプライヤ担当者および内部利害関係者に購買オーダー取消を連絡するように選択できます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
	"name": "cancel",
	"parameters": [
	{
		"cancellationReason": "Duplicate order"
	},
	{
		"initiatingParty": "buyer"
	},
	{
		"communicationMethod": "E-mail"
	},
	{
		"email": "[e-mail]"
	},
	{
		"CCEmail": "[e-mail]"
	},
	{
		"BCCEmail": "[e-mail]"
	}


	]
}

例3 レスポンス本文

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

{ 
	"result": "SUCCESS"
}

例4 リクエスト本文

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 この例では、購買オーダーが正常に取り消され、購買オーダーの取消を確認するようにサプライヤにリクエストされています。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
	"name": "cancel",
	"parameters": [
	{
		"cancellationReason": "Cancel a purchase order"
	},
	{
		"initiatingParty": "buyer"
	},
	{
		"requiredAcknowledgment": "Document"
	},
	{
		"acknowledgeWithinDays": "5"
	}
	]
}

例4 レスポンス本文

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

{ 
	"result": "SUCCESS"
}

「トップに戻る」