1つの品目詳細の取得
get
/fscmRestApi/resources/11.13.18.05/requisitionProductDetails/{CatalogItemKey}
リクエスト
パス・パラメータ
- CatalogItemKey(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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- 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-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
品目の価格分岐の単位。
リンク
- priceBreaks
-
パラメータ:
- CatalogItemKey:
$request.path.CatalogItemKey
価格分岐リソースは、品目の価格分岐詳細を取得します。 - CatalogItemKey:
例
この例では、1つの品目の詳細を取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/requisitionProductDetails/CatalogItemKey
レスポンス本文の例
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", "href": "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" } ] } ], "count": 1, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails", "name": "requisitionProductDetails", "kind": "collection" } ] }