すべての購買依頼発行オプションの取得
get
/fscmRestApi/resources/11.13.18.05/requisitionPreferences/{requisitionPreferencesUniqID}/child/requisitioningOptions
リクエスト
パス・パラメータ
- requisitionPreferencesUniqID(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 : 指定した主キー基準に従って、購買依頼プリファレンスから購買依頼発行オプションを検索します。
ファインダ変数:- RequisitioningBUOptionsId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AllowOnetimeAddrFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、購買依頼明細の追加フローで一時住所を使用できるようにします。 falseの場合、一時アドレスを許可しません。 デフォルト値はfalseです。
- CatalogInformationTemplateApplicableFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、顧客は情報テンプレートを使用します。 falseの場合、顧客は情報テンプレートを使用しません。 この属性にはデフォルト値がありません。
- ChartOfAccountId; integer; 購買依頼発行ビジネス・ユニットに関連付けられた勘定体系を一意に識別する値。
- DisplayPackagingStringOptinFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、製品パッケージ文字列の表示機能が有効になっています。 falseの場合、製品パッケージ文字列の表示機能は無効です。 この属性にはデフォルト値がありません。
- EnableApproverOverrideFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、購買依頼の作成または変更中に上書き承認者オプションが有効になります。 falseの場合、上書き承認者オプションは使用不可です。 この属性にはデフォルト値がありません。
- ExpenseAgreementLinesFromInternalSourcesOptinFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、内部ソースからの契約ベース・カタログ品目の費用購買依頼の履行機能が有効になっています。 falseの場合、内部ソースからの契約ベース・カタログ品目の費用購買依頼の履行機能は使用不可です。 この属性にはデフォルト値がありません。
- FunctionalCurrencyCode; string; ユーザーのプリファレンスで購買依頼発行ビジネス・ユニットのプライマリ元帳の通貨を識別する略称。
- HeaderDffContextCode; string; 購買依頼発行ビジネス機能の構成のヘッダー付加フレックスフィールド・コンテキスト・セット。
- InternalMaterialTransfersOptinFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、内部資材転送機能が有効になります。 falseの場合、内部資材転送機能は無効になります。 この属性にはデフォルト値がありません。
- InventoryOrganizationSystemDate; string; ユーザーの購買依頼プリファレンスの購買依頼発行ビジネス・ユニットに関連付けられた在庫組織のタイム・ゾーンのシステム日付。
- InvoiceHoldOptinFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、リクエストされた品目の支払保留の表示および解決機能が有効になります。 falseの場合、リクエストされた品目の支払保留の表示および解決機能が使用不可になります。 この属性にはデフォルト値がありません。
- LESystemDate; string; ユーザーの購買依頼プリファレンスで、購買依頼発行ビジネス・ユニットに関連付けられた法的エンティティのタイム・ゾーンのシステム日付。
- LineDffContextCode; string; 購買依頼発行ビジネス機能の構成における明細付加フレックスフィールド・コンテキスト・セット。
- LineTypeId; integer; 購買依頼明細の追加フローで品目タイプのデフォルト設定に使用される明細タイプを一意に識別する値。
- PackagingStringOrder; string; アプリケーションで構成されたパッケージ文字列単位の表示順序。
- ProgressiveWebappOptinFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、プログレッシブWebアプリケーションを使用した商品およびサービスの調達機能が有効になっています。 falseの場合、プログレッシブWebアプリケーションを使用した商品およびサービスの調達機能は使用不可です。 この属性にはデフォルト値がありません。
- RequestedDateInLocalTimeOptinFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、ローカル・タイム・ゾーンでのサプライ・チェーン・リクエスト日の受入機能が有効になります。 falseの場合、ローカル・タイム・ゾーンでのサプライ・チェーンのリクエスト日の受入機能は使用不可です。 この属性にはデフォルト値がありません。
- RequestedDeliveryDateOffset; string; アプリケーションで構成されたリクエストされた配信日オフセット値。
- RequisitioningBUId; integer; 購買依頼発行ビジネス・ユニットを一意に識別する値。
- RequisitioningBUOptionsId; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : requisitionPreferences-requisitioningOptions
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : requisitionPreferences-requisitioningOptions-item-response
タイプ:
ソースを表示
object
-
AllowOnetimeAddrFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買依頼明細の追加フローで一時住所を使用できるようにします。 falseの場合、一時アドレスを許可しません。 デフォルト値はfalseです。
-
CatalogInformationTemplateApplicableFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、顧客は情報テンプレートを使用します。 falseの場合、顧客は情報テンプレートを使用しません。 この属性にはデフォルト値がありません。
-
ChartOfAccountId: integer
読取り専用:
true
購買依頼発行ビジネス・ユニットに関連付けられた勘定体系を一意に識別する値。 -
ConversionRateType: string
タイトル:
Conversion Rate Type
読取り専用:true
通貨換算レートの決定に使用される購買依頼発行ビジネス・ユニットのデフォルト・レート・タイプです。 -
DisplayPackagingStringOptinFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、製品パッケージ文字列の表示機能が有効になっています。 falseの場合、製品パッケージ文字列の表示機能は無効です。 この属性にはデフォルト値がありません。
-
EnableApproverOverrideFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買依頼の作成または変更中に上書き承認者オプションが有効になります。 falseの場合、上書き承認者オプションは使用不可です。 この属性にはデフォルト値がありません。 -
ExpenseAgreementLinesFromInternalSourcesOptinFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、内部ソースからの契約ベース・カタログ品目の費用購買依頼の履行機能が有効になっています。 falseの場合、内部ソースからの契約ベース・カタログ品目の費用購買依頼の履行機能は使用不可です。 この属性にはデフォルト値がありません。
-
FunctionalCurrencyCode: string
タイトル:
Functional Currency
読取り専用:true
最大長:15
ユーザーのプリファレンスで購買依頼発行ビジネス・ユニットのプライマリ元帳の通貨を識別する略称です。 -
HeaderDffContextCode: string
読取り専用:
true
最大長:80
購買依頼発行ビジネス機能の構成のヘッダー付加フレックスフィールド・コンテキスト・セットです。 -
InternalMaterialTransfersOptinFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、内部資材転送機能が有効になります。 falseの場合、内部資材転送機能は無効になります。 この属性にはデフォルト値がありません。
-
InventoryOrganizationSystemDate: string (date)
ユーザーの購買依頼プリファレンスの購買依頼発行ビジネス・ユニットに関連付けられた在庫組織のタイム・ゾーンのシステム日付。
-
InvoiceHoldOptinFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、リクエストされた品目の支払保留の表示および解決機能が有効になります。 falseの場合、リクエストされた品目の支払保留の表示および解決機能が使用不可になります。 この属性にはデフォルト値がありません。
-
LESystemDate: string (date)
タイトル:
Legal Entity Date
ユーザーの購買依頼プリファレンスの購買依頼発行ビジネス・ユニットに関連付けられた法的エンティティのタイム・ゾーンのシステム日付です。 -
LineDffContextCode: string
読取り専用:
true
最大長:80
購買依頼発行ビジネス機能の構成における明細付加フレックスフィールド・コンテキスト・セットです。 -
LineTypeId: integer (int64)
読取り専用:
true
購買依頼明細の追加フローで品目タイプのデフォルト設定に使用される明細タイプを一意に識別する値です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PackagingStringOrder: string
タイトル:
Packaging String Order
アプリケーションで構成されたパッケージ文字列単位の表示順序。 -
PJCAllowAccountOverride: string
読取り専用:
true
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、プロジェクト関連配分で許可されるアカウント更新(PJC_ALLOW_ACCOUNT_OVERRIDE)プロファイル値ははいに設定されます。 falseの場合、プロジェクト関連配分で許可されるアカウント更新(PJC_ALLOW_ACCOUNT_OVERRIDE)プロファイル値はいいえに設定されます。この属性にはデフォルト値がありません。 -
ProgressiveWebappOptinFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、プログレッシブWebアプリケーションを使用した商品およびサービスの調達機能が有効になっています。 falseの場合、プログレッシブWebアプリケーションを使用した商品およびサービスの調達機能は使用不可です。 この属性にはデフォルト値がありません。
-
ProjectCostingFeatureOptinFlag: boolean
読取り専用:
true
次のいずれかの値が含まれます: trueまたはfalse。 アプリケーションでProject Costing機能が有効になっている場合、属性がtrueに設定され、有効になっていない場合はfalseに設定されます。 この属性にはデフォルト値がありません。 -
RequestedDateInLocalTimeOptinFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ローカル・タイム・ゾーンでのサプライ・チェーン・リクエスト日の受入機能が有効になります。 falseの場合、ローカル・タイム・ゾーンでのサプライ・チェーンのリクエスト日の受入機能は使用不可です。 この属性にはデフォルト値がありません。
-
RequestedDeliveryDateOffset: string
タイトル:
Requested Delivery Date Offset
アプリケーションで構成されたリクエスト搬送日オフセット値。 -
RequisitioningBUId: integer (int64)
読取り専用:
true
購買依頼発行ビジネス・ユニットを一意に識別する値。 -
RequisitioningBUOptionsId: integer (int64)
読取り専用:
true
購買依頼発行ビジネス・ユニットの購買依頼発行機能の構成を一意に識別する値。 -
ShowAdditionalItemAttributes: string
読取り専用:
true
次のいずれかの値が含まれます: YまたはN。 Yの場合、追加の品目属性がレスポンシブwebアプリケーションに表示されます。 Nの場合、属性は表示されません。 この属性のデフォルト値はNです。 -
ShowDFFByDefault: string
読取り専用:
true
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、付加フレックスフィールドがProgressive Web Applicationに表示されます。 falseの場合、付加フレックスフィールドは表示されません。 この属性のデフォルト値は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.
例
この例では、すべての購買依頼発行オプションを取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/requisitionPreferences/requisitionPreferencesUniqID/child/requisitioningOptions"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items": [ { "RequisitioningBUOptionsId": 100010024519191, "RequisitioningBUId": 204, "LineTypeId": 1, "HeaderDffContextCode": null, "LineDffContextCode": "ABP Special Project Info", "FunctionalCurrencyCode": "USD", "LESystemDate": "2022-06-14", "InventoryOrganizationSystemDate": "2022-06-14", "PackagingStringOrder": "ORA_RCS_PS_ASC", "DisplayPackagingStringOptinFlag": "false", "RequestedDeliveryDateOffset": "7", "ProgressiveWebappOptinFlag": "true", "AllowOnetimeAddrFlag": true, "ChartOfAccountId": 101, "ProjectCostingFeatureOptinFlag": "true", "PJCAllowAccountOverride": "Y", "ShowDFFByDefault": "N", "RequestedDateInLocalTimeOptinFlag": "false", "InvoiceHoldOptinFlag": "true", "ConversionRateType": "Corporate", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551/child/requisitioningOptions/100010024519191", "name": "requisitioningOptions", "kind": "item" }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551/child/requisitioningOptions/100010024519191", "name": "requisitioningOptions", "kind": "item" }, { "rel": "parent", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551", "name": "requisitionPreferences", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551/child/requisitioningOptions", "name": "requisitioningOptions", "kind": "collection" } ] }