すべての価格分岐の取得
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}/child/priceBreaks
リクエスト
パス・パラメータ
- LineId(required): number
ネゴシエーション明細を一意に識別する値です。
- supplierNegotiationsUniqID(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
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey: 主キーに従って一意の価格分岐を検索します。 主キーは、AuctionHeaderId、LineIdおよびPriceBreakIdです。
ファインダ変数:- AuctionHeaderId; integer; オークション・ヘッダーを一意に識別する値。
- LineId; number; ネゴシエーション明細を一意に識別する値。
- PriceBreakId; number; 価格分岐を一意に識別する値。
- PrimaryKeyFinder : PriceBreakIdに従って価格分岐を検索します。
ファインダ変数:- PriceBreakId; number; 価格分岐を一意に識別する値。
- PrimaryKey: 主キーに従って一意の価格分岐を検索します。 主キーは、AuctionHeaderId、LineIdおよびPriceBreakIdです。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AuctionHeaderId; integer; ネゴシエーションを一意に識別する値。
- LineId; number; ネゴシエーション明細を一意に識別する値。
- PriceBreakEndDate; string; 価格分岐が失効する日付。
- PriceBreakId; number; 価格分岐を識別する値。
- PriceBreakStartDate; string; 価格分岐が有効になる日付。
- Quantity; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : supplierNegotiations-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"の場合、推定行数は含まれません。
ネストされたスキーマ : supplierNegotiations-lines-priceBreaks-item-response
タイプ:
ソースを表示
object
-
AuctionHeaderId: integer (int64)
読取り専用:
true
ネゴシエーションを一意に識別する値です。 -
CreatedBy: string
読取り専用:
true
最大長:64
価格分岐を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが価格分岐を作成した日時。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが最後に価格分岐を更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
価格分岐を最後に更新したユーザー。 -
Line: string
ネゴシエーション明細を識別する番号。
-
LineDescription: string
ネゴシエーション明細の摘要。
-
LineId: number
読取り専用:
true
ネゴシエーション明細を一意に識別する値です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PriceBreakEndDate: string (date)
タイトル:
End Date
価格分岐が失効する日付。 -
PriceBreakId: number
タイトル:
Price Break ID
読取り専用:true
価格分岐を識別する値です。 -
PriceBreakStartDate: string (date)
タイトル:
Start Date
価格分岐が有効になる日付。 -
Quantity: number
タイトル:
Quantity
価格分岐の数量。 -
ShipToLocation: string
タイトル:
Location
最大長:60
サプライヤが品目を出荷する事業所の名前です。 -
ShipToLocationId: integer (int64)
タイトル:
Ship-to Location ID
サプライヤが品目を出荷する事業所を一意に識別する値です。 -
ShipToOrganization: string
タイトル:
Ship-to Organization
最大長:240
サプライヤが品目を出荷する在庫組織の名前です。 -
ShipToOrganizationId: integer (int64)
タイトル:
Ship-to Organization ID
サプライヤが品目を出荷する在庫組織を一意に識別する値です。 -
TargetPrice: number
タイトル:
Target Price
価格分岐のターゲット価格。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
例
この例では、すべての価格分岐を取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/lines/LineId/child/priceBreaks"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items": [ { "AuctionHeaderId": 300100152357495, "LineId": 1, "PriceBreakId": 1, "ShipToOrganizationId": 6204, "ShipToOrganization": "Vision Corporation", "ShipToLocationId": 21192, "ShipToLocation": "London", "Quantity": 25, "TargetPrice": 35000, "PriceBreakStartDate": null, "PriceBreakEndDate": null, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T11:30:00.521+00:00", "LastUpdatedBy": "CVBUYER01", "LastUpdateDate": "2018-06-28T11:32:00.005+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceBreaks/1", "name": "priceBreaks", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceBreaks/1", "name": "priceBreaks", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1", "name": "lines", "kind": "item" } ] }, { "AuctionHeaderId": 300100152357495, "LineId": 1, "PriceBreakId": 2, "ShipToOrganizationId": 4064, "ShipToOrganization": "Green Corp.", "ShipToLocationId": 1861226, "ShipToLocation": "Antwerpen", "Quantity": 25, "TargetPrice": 45000, "PriceBreakStartDate": null, "PriceBreakEndDate": null, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T11:30:39.074+00:00", "LastUpdatedBy": "CVBUYER01", "LastUpdateDate": "2018-06-28T11:32:00.015+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceBreaks/2", "name": "priceBreaks", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceBreaks/2", "name": "priceBreaks", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1", "name": "lines", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 10, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] }