すべてのシミュレーション・トランザクション付加フレックスフィールドの取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF
リクエスト
パス・パラメータ
- SimulationId(required): integer(int64)
計算シミュレーションの一意の識別子。
- TransactionId(required): integer(int64)
計算シミュレーションのトランザクションの一意の識別子。
問合せパラメータ
- 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 : 指定した主キーを持つシミュレーション・トランザクション付加フレックス・フィールドを検索します。
ファインダ変数:- SimulationId; integer;計算シミュレーションの一意の識別子。
- TransactionId; 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;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- SimulationId; integer; このシミュレーション・トランザクションが属するシミュレーションの一意の識別子。
- TransactionId; integer; この付加フレックスフィールドが属するトランザクションの一意の識別子。
- _Area_Code; string;市外局番の地理的トランザクション属性。 市外局番は電話番号の構成要素であり、通常は国内の各電話サービス区域を識別する3桁の番号です。
- _Billing_Address; number;顧客請求先事業所の一意の識別子。
- _Billing_Contact; number;請求先事業所における担当者の一意の識別子。
- _City; string;このシミュレーション・トランザクションに関連する都市名。
- _City_Display; string;このシミュレーション・トランザクションに関連する市区町村の名前。
- _Country; string;このシミュレーション・トランザクションに関連する国。
- _Country_Display; string;このシミュレーション・トランザクションに関連する国名。
- _Postal_Code; string;住所の郵便番号。
- _Product_Item_ID; number;在庫品目の一意の識別子。
- _Product_Item_ID_Display; string;在庫品目の表示値。
- _Province; string;州の名前。
- _Sales_Channel;文字列。販売チャネルは、トランザクションの販売方法を表します。 たとえば、間接、直接などです。
- _Shipping_Address; number;顧客の出荷先事業所の一意の識別子。
- _Shipping_Contact; number;出荷先事業所における担当者の一意の識別子。
- _Sold_To_Customer; number;トランザクションにリストされたアイテムまたはサービスを購入した顧客の一意の識別子。
- _Sold_To_Customer_Display; string;トランザクションにリストされたアイテムまたはサービスを購入した顧客の名前。
- _State; string;このシミュレーション・トランザクションに関連する状態。
- _State_Display; string;このシミュレーション・トランザクションに関連する状態の名前。
- __FLEX_Context; string;付加フレックスフィールドのコンテキスト・セグメント。
- __FLEX_Context_DisplayValue; string;付加フレックス・フィールドのコンテキスト・セグメントの表示値。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Business Unit Context for Base Transaction Attributes
最大長:30
付加フレックスフィールドのコンテキスト・セグメントです。 -
__FLEX_Context_DisplayValue: string
タイトル:
Business Unit Context for Base Transaction Attributes
付加フレックスフィールドのコンテキスト・セグメントの表示値。 -
_Area_Code: string
タイトル:
Area Code
最大長:360
市外局番の地理トランザクション属性。 市外局番は電話番号の構成要素であり、通常は国内の各電話サービス区域を識別する3桁の番号です。 -
_Billing_Address: number
タイトル:
Customer Billing Address Location
顧客請求先事業所の一意の識別子。 -
_Billing_Contact: number
タイトル:
Customer Billing Contact
請求先事業所の担当者の一意の識別子です。 -
_City: string
タイトル:
City
最大長:360
このシミュレーション・トランザクションに関連する市区町村。 -
_City_Display: string
タイトル:
City
このシミュレーション・トランザクションに関連する市区町村の名前。 -
_Country: string
タイトル:
Country
最大長:360
このシミュレーション・トランザクションに関連する国。 -
_Country_Display: string
タイトル:
Country
このシミュレーション・トランザクションに関連する国の名前。 -
_Postal_Code: string
タイトル:
Postal Code
最大長:360
住所の郵便番号。 -
_Product_Item_ID: number
タイトル:
Line Item ID
在庫品目の一意の識別子。 -
_Product_Item_ID_Display: string
タイトル:
Line Item ID
在庫品目の表示値。 -
_Province: string
タイトル:
Province
最大長:360
州の名前。 -
_Sales_Channel: string
タイトル:
Sales Channel
最大長:30
販売チャネルは、トランザクションの販売方法を表します。 たとえば、間接、直接などです。 -
_Shipping_Address: number
タイトル:
Shipping Address Location
顧客の出荷先事業所の一意の識別子。 -
_Shipping_Contact: number
タイトル:
Customer Shipping Contact
出荷先事業所の担当者の一意の識別子です。 -
_Sold_To_Customer: number
タイトル:
Customer
トランザクションにリストされた品目またはサービスを購入した顧客の一意の識別子。 -
_Sold_To_Customer_Display: string
タイトル:
Customer
トランザクションにリストされた品目またはサービスを購入した顧客の名前。 -
_State: string
タイトル:
State
最大長:360
このシミュレーション・トランザクションに関連する状態。 -
_State_Display: string
タイトル:
State
このシミュレーション・トランザクションに関連する状態の名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SimulationId: integer (int64)
このシミュレーション・トランザクションが属するシミュレーションの一意の識別子。
-
TransactionId: 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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。