すべての価格分岐の取得
get
/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/lines/{LineId}/child/priceBreaks
リクエスト
パス・パラメータ
- LineId(required): number
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
- draftSupplierNegotiationResponsesUniqID(required): string
これは、ドラフト・サプライヤ・ネゴシエーション・レスポンス・リソースの複合キーを構成し、ドラフト・サプライヤ・ネゴシエーション・レスポンスのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ドラフト・サプライヤ・ネゴシエーション・レスポンスの特定のインスタンスに移動してハッシュ・キーを取得するために、ドラフト・サプライヤ・ネゴシエーション・レスポンス・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey主キーに従って、ネゴシエーション・レスポンス明細に関連付けられた価格分岐を検索します。
ファインダ変数- LineId; integer; 各ネゴシエーション・レスポンス明細に割り当てられた一意のID。
- PriceBreakId; integer; 明細価格分岐IDに従って、レスポンス明細の価格分岐を一意に識別します。
- ResponseNumber; integer; ネゴシエーション応答の価格分岐を一意に識別する値。
- PrimaryKeyFinderレスポンス明細のレスポンス価格分岐を一意に識別するバインド変数に従って、ネゴシエーション・レスポンス明細に関連付けられた価格分岐を検索します。
ファインダ変数- PriceBreakId; integer; レスポンス行のレスポンス価格分岐を一意に識別するバインド変数。
- PrimaryKey主キーに従って、ネゴシエーション・レスポンス明細に関連付けられた価格分岐を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; 行を作成したユーザーを識別します。
- CreationDate; string; 行の作成のタイムスタンプ。
- LastUpdateDate; string; ユーザーが最後に行を更新した日時。
- LastUpdatedBy; string; 行を最後に更新したユーザー。
- LineId; integer; ネゴシエーション明細を識別する値。
- PriceBreakEndDate; string; 価格分岐が失効する日付。
- PriceBreakId; integer; 価格分岐が有効になる日付。
- PriceBreakStartDate; string; 価格分岐が有効になる日付。
- PricingBasis; string; アプリケーションが価格分岐の計算に使用する基準。 使用可能な値のリストは、参照タイプPON_SHIPMENT_PRICING_BASISで定義されます。
- PricingBasisCode; string; アプリケーションがレスポンス明細価格分岐の計算に使用する基準を識別する略称。 使用可能な値のリストは、参照タイプPON_SHIPMENT_PRICING_BASISで定義されます。
- Quantity; number; 価格分岐の数量。
- ResponseNumber; integer; サプライヤ応答を識別する値。
- ResponseValue; number; 価格分岐の応答値。
- ShipToLocation; string; サプライヤが品目を出荷する事業所の名前。
- ShipToLocationId; integer; サプライヤが品目を出荷する事業所を一意に識別する値。
- ShipToOrganization; string; サプライヤが品目を出荷する在庫組織の名前。
- ShipToOrganizationId; integer; サプライヤが品目を出荷する在庫組織を一意に識別する値。
- TargetPrice; number; 価格分岐のターゲット価格。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : draftSupplierNegotiationResponses-lines-priceBreaks
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内の品目。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : draftSupplierNegotiationResponses-lines-priceBreaks-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
行を作成したユーザーを識別します。 -
CreationDate: string (date-time)
読取り専用:
true
行の作成のタイムスタンプ。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが最後に明細を更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
明細を最後に更新したユーザー。 -
Line: string
読取り専用:
true
最大長:25
ネゴシエーション明細を識別する番号。 -
LineId: integer
タイトル:
Line ID
読取り専用:true
ネゴシエーション明細を識別する値です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PriceBreakEndDate: string (date)
タイトル:
End Date
価格分岐が失効する日付。 -
PriceBreakId: integer
タイトル:
Price Break ID
読取り専用:true
価格分岐が有効になる日付。 -
PriceBreakStartDate: string (date)
タイトル:
Start Date
価格分岐が有効になる日付。 -
PricingBasis: string
タイトル:
Pricing Basis
最大長:80
アプリケーションが価格分岐の計算に使用する基準。 使用可能な値のリストは、参照タイプPON_SHIPMENT_PRICING_BASISで定義されます。 -
PricingBasisCode: string
最大長:
25
アプリケーションがレスポンス明細価格分岐の計算に使用する基準を識別する略称です。 使用可能な値のリストは、参照タイプPON_SHIPMENT_PRICING_BASISで定義されます。 -
Quantity: number
タイトル:
Quantity
価格分岐の数量。 -
ResponseNumber: integer (int64)
タイトル:
Response Number
読取り専用:true
サプライヤ・レスポンスを識別する値です。 -
ResponseValue: number
タイトル:
Response Value
価格分岐のレスポンス値。 -
ShipToLocation: string
タイトル:
Display Name
最大長:240
サプライヤが品目を出荷する事業所の名前。 -
ShipToLocationId: integer
タイトル:
Ship-to Location ID
サプライヤが品目を出荷する事業所を一意に識別する値です。 -
ShipToOrganization: string
タイトル:
Ship-to Organization
最大長:240
サプライヤが品目を出荷する在庫組織の名前です。 -
ShipToOrganizationId: integer
タイトル:
Ship-to Organization ID
サプライヤが品目を出荷する在庫組織を一意に識別する値です。 -
TargetPrice: number
タイトル:
Target Price
読取り専用:true
価格分岐のターゲット価格。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
例
この例では、レスポンスIDと明細ID、グループID、価格分岐を使用して、ネゴシエーション・レスポンス明細のすべての価格分岐を取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/draftSupplierNegotiationResponsesUniqID/child/lines/LineId/child/priceBreaks"
たとえば:
curl -u username:password "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/priceBreaks"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "items": [ { "ResponseNumber": 188787, "LineId": 1, "Line": "1", "PriceBreakId": 1, "ShipToOrganizationId": 7295, "ShipToOrganization": "A1 Manufacturing", "ShipToLocationId": 300100176649196, "ShipToLocation": "SCP_IM1", "Quantity": 10, "ResponseValue": 10, "TargetPrice": null, "PriceBreakStartDate": null, "PriceBreakEndDate": null, "PricingBasisCode": "PRICE", "PricingBasis": "Price", "CreatedBy": "CVSUPPB01", "CreationDate": "2022-04-08T19:39:31+00:00", "LastUpdatedBy": "CVSUPPB01", "LastUpdateDate": "2022-04-20T14:41:52.666+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/priceBreaks/1", "name": "priceBreaks", "kind": "item", "properties": { "changeIndicator": "..." } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/priceBreaks/1", "name": "priceBreaks", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1", "name": "lines", "kind": "item" } ] }, { "ResponseNumber": 188787, "LineId": 1, "Line": "1", "PriceBreakId": 2, "ShipToOrganizationId": 7295, "ShipToOrganization": "A1 Manufacturing", "ShipToLocationId": 300100176649196, "ShipToLocation": "SCP_IM1", "Quantity": 5, "ResponseValue": 4, "TargetPrice": null, "PriceBreakStartDate": null, "PriceBreakEndDate": null, "PricingBasisCode": "PRICE DISCOUNT", "PricingBasis": "Price Discount Percent", "CreatedBy": "CVSUPPB01", "CreationDate": "2022-04-20T14:41:38.426+00:00", "LastUpdatedBy": "CVSUPPB01", "LastUpdateDate": "2022-04-20T14:41:52.657+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/priceBreaks/2", "name": "priceBreaks", "kind": "item", "properties": { "changeIndicator": "..." } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/priceBreaks/2", "name": "priceBreaks", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1", "name": "lines", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] }