すべての品目詳細の取得
get
/fscmRestApi/resources/11.13.18.05/requisitionProductDetails
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ByItemId : 品目識別子に従って品目を検索します。
ファインダ変数:- bind_itemId; integer; 品目を一意に識別する値。
- ByPunchoutItemIdentifier : パンチアウト品目識別子に従って品目を検索します。
ファインダ変数:- bind_punchoutItemIdentifier; integer; パンチアウト品目を一意に識別する値。
- BySourceDocLineId : ソース文書の明細識別子に従って品目を検索します。
ファインダ変数:- bind_sourceDocLineId; integer; ソース文書の行を一意に識別する値。
- PrimaryKey : カタログ品目キーに従って品目を検索します。
ファインダ変数:- CatalogItemKey; integer; カタログ品目キーを使用して品目を一意に識別する値。
- ByItemId : 品目識別子に従って品目を検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- Amount; number; 機能通貨での品目の金額。
- CatalogItemKey; integer; カタログ品目を一意に識別する値。
- CategoryName; string; 品目を分類するカテゴリの名前。
- CurrencyAmount; number; 外貨での品目の金額。
- CurrencyCode; string; 品目価格の通貨を識別する略称。
- CurrencyUnitPrice; integer; 外貨での各単位の品目の価格。
- FormattedAmount; string; 通貨に対して書式設定された金額。
- FormattedCurrencyAmount; string; 通貨に対してフォーマットされた通貨金額。
- FormattedCurrencyUnitPrice; string; 通貨に対して書式設定された各単位の品目の通貨価格の値。
- FormattedUnitPrice; string; 通貨に対して書式設定された単位ごとの品目の価格。
- FunctionalCurrencyCode; string; 機能通貨を識別する略称。
- FunctionalCurrencySymbol; string; 機能通貨を識別する記号。
- ItemDescription; string; 製品詳細ページで使用可能な品目の説明。
- ItemKey; string; 品目を一意に識別する値です。 これは、品目識別子、ソース文書明細識別子、言語およびパンチアウト品目識別子の組合せを使用してアプリケーションで生成されるキーです。
- ItemSource; string; 項目のソースを識別する値。 このソースは、カタログ、カタログ外、クイック作成、パンチアウト、購買依頼インポートまたはwebサービスです。
- LongDescription; string; 品目のテキストの説明。
- Manufacturer; string; 品目を製造するパーティの名前。
- ManufacturerPartNumber; string; 部品を製造元として識別する値です。
- OrderTypeLookupCode; string; オーダー・タイプの参照値を識別する略称。 受け入れられる値のリストには、固定価格と数量が含まれます。
- PunchoutCatalogId; integer; パンチアウト・カタログを一意に識別する値。
- PunchoutItemIdentifier; integer; パンチアウト品目を一意に識別する値。
- RequisitioningBUId; integer; 購買依頼発行ビジネス・ユニットを一意に識別する値。
- SuggestedVendorName; string; 品目の提示サプライヤの名前。
- SupplierPartNumber; string; 部品をサプライヤから発信元として識別する値です。
- ThumbnailImage; string; 品目のサムネイル・イメージ。
- UOM; string; 品目が使用する単位。
- UnitPrice; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : requisitionProductDetails
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : requisitionProductDetails-item-response
タイプ:
ソースを表示
object
-
Amount: number
機能通貨での品目の金額です。
-
CatalogItemKey: integer (int64)
読取り専用:
true
カタログ品目を一意に識別する値。 -
CategoryName: string
読取り専用:
true
最大長:250
品目を分類するカテゴリの名前です。 -
CurrencyAmount: number
品目の金額(外貨)。
-
CurrencyCode: string
読取り専用:
true
最大長:32
品目価格の通貨を識別する略称です。 -
CurrencyUnitPrice: integer (int64)
読取り専用:
true
外国通貨での各ユニットの品目の価格。 -
FormattedAmount: string
読取り専用:
true
通貨に対してフォーマットされた金額です。 -
FormattedCurrencyAmount: string
読取り専用:
true
通貨に対して書式設定された通貨金額。 -
FormattedCurrencyUnitPrice: string
読取り専用:
true
通貨に対して書式設定された各単位の品目の通貨価格の値。 -
FormattedUnitPrice: string
読取り専用:
true
通貨に対して書式設定された各単位の品目の価格。 -
FunctionalCurrencyCode: string
読取り専用:
true
最大長:32
機能通貨を識別する略称です。 -
FunctionalCurrencySymbol: string
読取り専用:
true
機能通貨を識別する記号。 -
ItemDescription: string
読取り専用:
true
最大長:240
製品詳細ページで使用可能な品目の摘要。 -
ItemKey: string
読取り専用:
true
最大長:129
品目を一意に識別する値。 これは、品目識別子、ソース文書明細識別子、言語およびパンチアウト品目識別子の組合せを使用してアプリケーションで生成されるキーです。 -
ItemSource: string
読取り専用:
true
最大長:8
品目のソースを識別する値です。 このソースは、カタログ、カタログ外、クイック作成、パンチアウト、購買依頼インポートまたはwebサービスです。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LongDescription: string
読取り専用:
true
最大長:4000
品目のテキスト説明。 -
Manufacturer: string
読取り専用:
true
最大長:700
品目を製造するパーティの名前です。 -
ManufacturerPartNumber: string
読取り専用:
true
部品を製造元として識別する値です。 -
OrderTypeLookupCode: string
読取り専用:
true
最大長:25
オーダー・タイプの参照値を識別する略称です。 受け入れられる値のリストには、固定価格と数量が含まれます。 -
priceBreaks: array Price Breaks
タイトル:
Price Breaks
価格分岐リソースは、品目の価格分岐詳細を取得します。 -
PunchoutCatalogId: integer
読取り専用:
true
パンチアウト・カタログを一意に識別する値。 -
PunchoutItemIdentifier: integer (int64)
読取り専用:
true
パンチアウト品目を一意に識別する値。 -
RequisitioningBUId: integer
読取り専用:
true
購買依頼発行ビジネス・ユニットを一意に識別する値。 -
SuggestedVendorName: string
読取り専用:
true
最大長:360
品目の提示サプライヤの名前。 -
SupplierPartNumber: string
読取り専用:
true
サプライヤからの部品であることを識別する値です。 -
ThumbnailImage: string
読取り専用:
true
最大長:1000
品目のサムネイル・イメージ。 -
UnitPrice: number
読取り専用:
true
機能通貨での各ユニットの品目の価格。 -
UOM: string
読取り専用:
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.
ネストされたスキーマ : requisitionProductDetails-priceBreaks-item-response
タイプ:
ソースを表示
object
-
CurrencyCode: string
読取り専用:
true
最大長:15
品目の価格分岐の通貨を識別する略称です。 -
DeliverTo: string
タイトル:
Deliver To
読取り専用:true
最大長:302
明細の搬送先事業所を識別する値です。 -
Discount: number
タイトル:
Discount Percent
読取り専用:true
価格分岐に対する割引率。 -
EndDate: string (date)
タイトル:
End Date
読取り専用:true
価格分岐が非アクティブになる日付。 -
FormattedDiscount: string
読取り専用:
true
通貨に対して書式設定された割引のパーセント。 -
FormattedFunctionalCurrencyPrice: string
読取り専用:
true
通貨に対して書式設定された機能通貨価格です。 -
FormattedPrice: string
読取り専用:
true
通貨に対して書式設定された品目の価格分岐です。 -
FunctionalCurrencyCode: string
品目の価格分岐の機能通貨を識別する略称です。
-
FunctionalCurrencyPrice: number
機能通貨での品目の価格分岐の値です。
-
FunctionalCurrencySymbol: string
読取り専用:
true
品目の価格分岐の機能通貨を識別する記号。 -
LineLocationId: integer (int64)
読取り専用:
true
明細事業所を一意に識別する値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Price: number
タイトル:
Price
読取り専用:true
オーダー出荷の価格または価格分岐です。 -
Quantity: number
タイトル:
Quantity
読取り専用:true
包括購買契約価格分岐明細からの品目の数量です。 -
StartDate: string (date)
タイトル:
Start Date
読取り専用:true
価格分岐がアクティブになる日付。 -
UnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
品目の価格分岐の単位。
例
この例では、すべての品目の詳細を取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/requisitionProductDetails"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items": [ { "ItemKey": "l#100000012320874#-2#-2#US", "PunchoutItemIdentifier": -2, "PunchoutCatalogId": -2, "ItemDescription": "Ergonomic Keyboard", "LongDescription": null, "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Miscellaneous_1", "CurrencyUnitPrice": 0, "UnitPrice": 0, "CurrencyAmount": null, "Amount": null, "SuggestedVendorName": null, "Manufacturer": null, "ThumbnailImage": null, "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "CatalogItemKey": 30439, "FunctionalCurrencySymbol": "$", "ManufacturerPartNumber": null, "SupplierPartNumber": null, "UOM": "Each", "RequisitioningBUId": 204, "FormattedUnitPrice": "0.00", "FormattedCurrencyUnitPrice": "0.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30439", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30439", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30439/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] }, { "ItemKey": "l#1769#-2#-2#US", "PunchoutItemIdentifier": -2, "PunchoutCatalogId": -2, "ItemDescription": "Keyboard - 111 Keys", "LongDescription": null, "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Miscellaneous_1", "CurrencyUnitPrice": 0, "UnitPrice": 0, "CurrencyAmount": null, "Amount": null, "SuggestedVendorName": null, "Manufacturer": null, "ThumbnailImage": null, "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "CatalogItemKey": 30441, "FunctionalCurrencySymbol": "$", "ManufacturerPartNumber": null, "SupplierPartNumber": null, "UOM": "Each", "RequisitioningBUId": 204, "FormattedUnitPrice": "0.00", "FormattedCurrencyUnitPrice": "0.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30441", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30441", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30441/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] }, { "ItemKey": "l#300100063781146#-2#-2#US", "PunchoutItemIdentifier": -2, "PunchoutCatalogId": -2, "ItemDescription": "ATO-Dining-Table-Glass", "LongDescription": null, "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Miscellaneous_1", "CurrencyUnitPrice": 10000, "UnitPrice": 10000, "CurrencyAmount": null, "Amount": null, "SuggestedVendorName": null, "Manufacturer": null, "ThumbnailImage": null, "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "CatalogItemKey": 30064, "FunctionalCurrencySymbol": "$", "ManufacturerPartNumber": null, "SupplierPartNumber": null, "UOM": "Each", "RequisitioningBUId": 204, "FormattedUnitPrice": "10,000.00", "FormattedCurrencyUnitPrice": "10,000.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30064", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30064", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30064/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] }, { "ItemKey": "l#300100063781269#-2#-2#US", "PunchoutItemIdentifier": -2, "PunchoutCatalogId": -2, "ItemDescription": "ATO-Dining-Table-Glass-Table", "LongDescription": null, "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Miscellaneous_1", "CurrencyUnitPrice": 5000, "UnitPrice": 5000, "CurrencyAmount": null, "Amount": null, "SuggestedVendorName": null, "Manufacturer": null, "ThumbnailImage": null, "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "CatalogItemKey": 30079, "FunctionalCurrencySymbol": "$", "ManufacturerPartNumber": null, "SupplierPartNumber": null, "UOM": "Each", "RequisitioningBUId": 204, "FormattedUnitPrice": "5,000.00", "FormattedCurrencyUnitPrice": "5,000.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30079", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30079", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30079/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] }, { "ItemKey": "l#100100039742321#300100113893538#-2#US", "PunchoutItemIdentifier": -2, "PunchoutCatalogId": -2, "ItemDescription": "Fus13_SItem_Motherboard Mini", "LongDescription": null, "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Miscellaneous_1", "CurrencyUnitPrice": 23, "UnitPrice": 23, "CurrencyAmount": null, "Amount": null, "SuggestedVendorName": "CV_SuppA01", "Manufacturer": "Intel", "ThumbnailImage": null, "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "CatalogItemKey": 98528, "FunctionalCurrencySymbol": "$", "ManufacturerPartNumber": "192.168.22.1", "SupplierPartNumber": "SItem2", "UOM": "EA", "RequisitioningBUId": 204, "FormattedUnitPrice": "23.00", "FormattedCurrencyUnitPrice": "23.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/98528", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/98528", "name": "requisitionProductDetails", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/98528/child/priceBreaks", "name": "priceBreaks", "kind": "collection" } ] } ], "count": 5, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails", "name": "requisitionProductDetails", "kind": "collection" } ] }