すべての配分の取得
get
/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/child/distributions
リクエスト
パス・パラメータ
- POLineId(required): integer(int64)
購買オーダー明細を一意に識別する値。
- purchaseOrdersUniqID(required): string
これは、購買オーダー・リソースの複合キーを構成し、購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、購買オーダー・コレクション・リソースを問い合せる必要があります。
- schedulesUniqID(required): string
これは、Schedulesリソースのコンポジット・キーを構成し、Schedulesのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Schedulesの特定のインスタンスに移動してハッシュ・キーを取得するために、Schedulesコレクション・リソースを問い合せる必要があります。
問合せパラメータ
- 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 : 配分識別子に従って購買オーダー配分を検索します。
ファインダ変数:- PODistributionId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- BudgetDate; string; 組織が予算を消費したときに時間枠を決定するために使用する日付。
- CreatedBy; string; 購買オーダー配分を作成したユーザー。
- CreationDate; string; バイヤーまたはアプリケーションが購買オーダー配分を作成した日時。
- DeliverToCustomer; string; 品目を受け取るサード・パーティの名前。
- DeliverToCustomerId; integer; 品目を受け取るサード・パーティのロケーションを一意に識別する値。
- DeliverToCustomerLocation; string; 品目を受け取る顧客のロケーションの名前。 直接出荷時に適用されます。
- DeliverToCustomerLocationId; integer; 品目を受け取るサード・パーティのロケーションを一意に識別する値。
- DeliverToLocationCode; string; 品目を受け取る最終的なロケーションを識別する略称。
- DeliverToLocationId; integer; 品目を受け取る最終的なロケーションを一意に識別する値。
- DestinationSubinventory; string; リクエストされた品目の配送先を識別する保管場所。
- DistributionNumber; number; 購買オーダー・スケジュールの購買オーダー配分を一意に識別する番号。
- LastUpdateDate; string; バイヤーまたはアプリケーションが購買オーダー配分を最後に更新した日時。
- LastUpdatedBy; string; 購買オーダー配分を最後に更新したユーザー。
- PODistributionId; integer; 購買オーダー配分を一意に識別する値。
- Requester; string; 搬送先個人または依頼者の名前。
- RequesterId; integer; 搬送先個人または要求者を一意に識別する値。
- Requisition; string; 購買依頼を識別する番号。
- RequisitionHeaderId; integer; 購買依頼ヘッダーを一意に識別する値。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : purchaseOrders-lines-schedules-distributions
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : purchaseOrders-lines-schedules-distributions-item-response
タイプ:
ソースを表示
object
-
BudgetDate: string (date)
タイトル:
Budget Date
組織が予算を消費した時間枠の決定に使用する日付です。 -
ConversionRate: number
タイトル:
Conversion Rate
通貨の換算時に使用する換算レートです。 -
ConversionRateDate: string (date)
タイトル:
Conversion Date
金額を別の通貨に換算する際の換算レートに使用する日付。 換算レートは日付によって異なります。 -
CreatedBy: string
読取り専用:
true
最大長:64
購買オーダー配分を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
バイヤーまたはアプリケーションが購買オーダー配分を作成した日時。 -
Currency: string
タイトル:
Currency
読取り専用:true
最大長:80
購買オーダー通貨です。 -
CurrencyCode: string
読取り専用:
true
最大長:15
購買オーダー通貨を識別する略語。 -
DeliverToCustomer: string
タイトル:
Name
読取り専用:true
最大長:360
品目を受け取るサード・パーティの名前。 -
DeliverToCustomerId: integer (int64)
品目を受け入れるサード・パーティ事業所を一意に識別する値。
-
DeliverToCustomerLocation: string
読取り専用:
true
品目を受け入れる顧客事業所の名前。 直接出荷時に適用されます。 -
DeliverToCustomerLocationId: integer (int64)
品目を受け入れるサード・パーティ事業所を一意に識別する値。
-
DeliverToLocationCode: string
タイトル:
Deliver-to Location
読取り専用:true
品目を受け取る最終ロケーションを識別する略称です。 -
DeliverToLocationId: integer (int64)
品目を受け取る最終事業所を一意に識別する値です。
-
DestinationChargeAccount: string
タイトル:
Destination Charge Account
読取り専用:true
購買依頼発行ビジネス・ユニットで品目の原価として請求する勘定科目です。 -
DestinationChargeAccountId: integer (int64)
購買依頼発行ビジネス・ユニットの品目の原価に対して請求する勘定科目を一意に識別する値です。
-
DestinationSubinventory: string
タイトル:
Destination Subinventory
最大長:10
リクエスト品目を搬送する場所を識別する保管場所。 -
DestinationVarianceAccount: string
タイトル:
Destination Variance Account
読取り専用:true
購買依頼発行ビジネス・ユニットでの購買に対する購買価格の変動に対して請求する勘定科目です。 購買依頼発行ビジネス・ユニットの法的エンティティが販売先法的エンティティと異なる場合に適用されます。 -
DestinationVarianceAccountId: integer (int64)
購買依頼発行ビジネス・ユニットの購買に対する購買価格の変動に対して請求するアカウントを一意に識別する値です。 購買依頼発行ビジネス・ユニットの法的エンティティが販売先法的エンティティと異なる場合に適用されます。
-
DFF: array Flexfields for Distributions
タイトル:
Flexfields for Distributions
Flexfields for Distributions(配分のフレックスフィールド)リソースは、購買オーダー配分に関する追加詳細を管理します。 -
DistributionNumber: number
タイトル:
Distribution
購買オーダー・スケジュールの購買オーダー配分を一意に識別する番号。 -
globalDFFs: array US Federal Attributes for Distributions
タイトル:
US Federal Attributes for Distributions
US Federal Attributes for Distributionsリソースは、購買オーダー配分の連邦財務属性を管理します。 -
LastUpdateDate: string (date-time)
読取り専用:
true
バイヤーまたはアプリケーションが購買オーダー配分を最後に更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
購買オーダー配分を最後に更新したユーザー。 -
LineNumber: number
タイトル:
Line
読取り専用:true
購買オーダーの購買オーダー明細を一意に識別する番号です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NonrecoverableExclusiveTax: number
タイトル:
Nonrecoverable Exclusive Tax
購買オーダー金額に含まれない税金です。 購入者はこの税金を控除できません。 -
NonrecoverableInclusiveTax: number
タイトル:
Nonrecoverable Inclusive Tax
購買オーダー金額に含まれる税金です。 購入者はこの税金を控除できません。 -
Ordered: number
タイトル:
Ordered
価格に配分数量を掛けた値。 購買オーダー明細に数量が含まれている場合に適用されます。 購買オーダー明細が固定価格サービスを参照する場合、この属性には配分金額に含まれるものと同じ値が含まれます。 -
OrderNumber: string
タイトル:
Order
読取り専用:true
最大長:30
販売先法的エンティティの購買オーダーを一意に識別する番号です。 -
POAccrualAccount: string
タイトル:
PO Accrual Account
読取り専用:true
受入経過勘定を請求する勘定科目です。 購買依頼発行ビジネス・ユニットの法的エンティティと販売先法的エンティティが同じ場合に適用されます。 -
POAccrualAccountId: integer (int64)
受入経過勘定を請求する勘定科目を一意に識別する値です。 購買依頼発行ビジネス・ユニットの法的エンティティと販売先法的エンティティが同じ場合に適用されます。
-
POChargeAccount: string
タイトル:
PO Charge Account
読取り専用:true
購入に対して請求する勘定科目です。 購買依頼発行ビジネス・ユニットの法的エンティティと販売先法的エンティティが同じ場合に適用されます。 -
POChargeAccountId: integer (int64)
購買に請求するアカウントを一意に識別する値です。 購買依頼発行ビジネス・ユニットの法的エンティティと販売先法的エンティティが同じ場合に適用されます。
-
PODistributionId: integer (int64)
購買オーダー配分を一意に識別する値。
-
POHeaderId: integer (int64)
購買オーダーを一意に識別する値。
-
POLineId: integer (int64)
購買オーダー明細の親を一意に識別する値です。
-
POVarianceAccount: string
タイトル:
PO Variance Account
読取り専用:true
請求書と購買オーダーの間の価格差異を請求する勘定。 -
POVarianceAccountId: integer (int64)
請求書と購買オーダーの間の価格差異に対して請求する勘定科目を一意に識別する値。
-
projectDFF: array Project Costing Flexfields for Distributions
タイトル:
Project Costing Flexfields for Distributions
配分のProject Costing Flexfields(プロジェクト原価計算フレックスフィールド)リソースは、購買オーダー配分に関するプロジェクト詳細を管理します。 -
Quantity: number
タイトル:
Quantity
購入者が購入する品目の配分数量。 -
RecoverableExclusiveTax: number
タイトル:
Recoverable Exclusive Tax
購買オーダー金額に含まれない税金です。 購入者はこの税金を回収できます。 -
RecoverableInclusiveTax: number
タイトル:
Recoverable Inclusive Tax
購買オーダー金額に含まれる税金です。 購入者はこの税金を回収できます。 -
Requester: string
タイトル:
Requester
読取り専用:true
最大長:240
搬送先個人または依頼者の名前。 -
RequesterId: integer (int64)
搬送先個人またはリクエスト者を一意に識別する値。
-
Requisition: string
タイトル:
Requisition
読取り専用:true
最大長:64
購買依頼を識別する番号。 -
RequisitionDistribution: number
タイトル:
Requisition Distribution
読取り専用:true
購買依頼明細の購買依頼配分を一意に識別する番号です。 -
RequisitionDistributionId: integer (int64)
読取り専用:
true
購買依頼配分を一意に識別する値。 -
RequisitionHeaderId: integer (int64)
読取り専用:
true
購買依頼ヘッダーを一意に識別する値。 -
RequisitionLine: number
タイトル:
Requisition Line
読取り専用:true
購買依頼の購買依頼明細を一意に識別する番号です。 -
RequisitionLineId: integer (int64)
読取り専用:
true
購買依頼明細を一意に識別する値。 -
ScheduleNumber: number
タイトル:
Schedule
読取り専用:true
購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号です。 -
Total: number
タイトル:
Total
オーダー金額に購買オーダー配分の外税額を加えた金額。 -
TotalTax: number
タイトル:
Total Tax
購買オーダー配分に対して購買者が控除でき、控除できない外税額の合計です。 -
UOM: string
タイトル:
UOM
読取り専用:true
最大長:25
品目数量の単位。 -
UOMCode: string
読取り専用:
true
最大長:3
単位を識別する略語。
ネストされたスキーマ : 配分用フレックスフィールド
タイプ:
array
タイトル:
Flexfields for Distributions
Flexfields for Distributions(配分のフレックスフィールド)リソースは、購買オーダー配分に関する追加詳細を管理します。
ソースを表示
ネストされたスキーマ : US連邦配分属性
タイプ:
array
タイトル:
US Federal Attributes for Distributions
US Federal Attributes for Distributionsリソースは、購買オーダー配分の連邦財務属性を管理します。
ソースを表示
ネストされたスキーマ : 配分用のProject Costingフレックスフィールド
タイプ:
array
タイトル:
Project Costing Flexfields for Distributions
配分のProject Costing Flexfields(プロジェクト原価計算フレックスフィールド)リソースは、購買オーダー配分に関するプロジェクト詳細を管理します。
ソースを表示
ネストされたスキーマ : purchaseOrders-lines-schedules-distributions-DFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Prompt
最大長:30
購買オーダー配分の付加フレックスフィールド・コンテキスト名です。 -
__FLEX_Context_DisplayValue: string
タイトル:
Context Prompt
購買オーダー配分の付加フレックスフィールド・コンテキスト表示値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PoDistributionId: integer (int64)
購買オーダー配分を一意に識別する値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : purchaseOrders-lines-schedules-distributions-globalDFFs-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Segment
最大長:150
購買オーダー配分のUS連邦属性のグローバル付加フレックスフィールド・コンテキスト名です。 -
__FLEX_Context_DisplayValue: string
タイトル:
Context Segment
購買オーダー配分のUS連邦属性のグローバル付加フレックスフィールド・コンテキスト表示値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PoDistributionId: integer (int64)
購買オーダー配分を一意に識別する値。
ネストされたスキーマ : purchaseOrders-lines-schedules-distributions-projectDFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Value
最大長:40
購買オーダー配分のプロジェクト・コスト計算付加フレックスフィールド・コンテキスト名です。 -
__FLEX_Context_DisplayValue: string
タイトル:
Context Value
購買オーダー配分のプロジェクト原価計算付加フレックスフィールド・コンテキスト表示値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PoDistributionId: integer (int64)
購買オーダー配分を一意に識別する値。