機械翻訳について

1つの品目詳細の取得

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogItemDetails/{SearchObjectId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : shoppingCatalogItemDetails-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    購買会社の通貨でのサービス品目の金額。
  • タイトル: Availability
    読取り専用: true
    最大長: 700
    商品およびサービスの可用性を示す値です。
  • Buying Options
    タイトル: Buying Options
    購買オプション・リソースは、複数の契約によって品目が参照されるときに、様々な購買オプションを取得します。
  • 読取り専用: true
    最大長: 255
    契約明細を分類するカテゴリの名前です。
  • タイトル: Comments
    読取り専用: true
    最大長: 700
    契約明細に関するコメント。
  • 読取り専用: true
    最大長: 64
    品目詳細を作成したユーザー。
  • 読取り専用: true
    ユーザーが品目詳細を作成した日付。
  • 読取り専用: true
    品目通貨を識別する略称です。
  • 読取り専用: true
    最大長: 700
    契約明細のイメージのURL (Uniform Resource Locator)。
  • タイトル: Shippable
    読取り専用: true
    最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、品目は内部的に転送可能です。 falseの場合、品目は内部転送可能ではありません。 この属性にはデフォルト値がありません。
  • タイトル: Transfer Orders Enabled
    読取り専用: true
    最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、品目は内部移動伝票に対して有効になります。 falseの場合、社内転送オーダーの品目は無効です。 この属性にはデフォルト値がありません。
  • 読取り専用: true
    品目のカテゴリを一意に識別する値。
  • Item GTIN Relationships
    タイトル: Item GTIN Relationships
    品目GTIN関連リソースは、マスター品目のグローバル取引品目番号(GTIN)詳細を取得します。
  • Item Images
    タイトル: Item Images
    品目イメージ・リソースは、マスター品目のイメージを取得します。
  • Item Manufacturers
    タイトル: Item Manufacturers
    品目製造業者リソースは、マスター品目の製造業者詳細を取得します。
  • 読取り専用: true
    最大長: 300
    マスター品目の名前。
  • 読取り専用: true
    最大長: 255
    マスター品目の改訂。
  • Item Suppliers
    タイトル: Item Suppliers
    品目サプライヤ・リソースは、マスター品目のサプライヤ詳細を取得します。
  • 読取り専用: true
    ユーザーが品目詳細を最後に更新した日付。
  • 読取り専用: true
    最大長: 64
    品目詳細を最後に更新したユーザー。
  • タイトル: Lead Time Days
    読取り専用: true
    オーダーの発行後にサプライヤが商品を搬送するのに要した時間。
  • タイトル: Line Type
    読取り専用: true
    最大長: 30
    契約明細のタイプです。 有効な値は、物品またはサービスまたはユーザー定義明細タイプです。
  • Links
  • 読取り専用: true
    最大長: 255
    品目の詳細摘要。
  • 読取り専用: true
    最大長: 700
    品目を製造するパーティの名前です。
  • 読取り専用: true
    最大長: 700
    個々の製品を一意に識別する製造業者によって発行された番号。
  • 読取り専用: true
    最大長: 25
    契約明細のタイプを識別する略称です。 有効な値は、QUANTITY ServicesまたはFIXED Servicesです。
  • 読取り専用: true
    最大長: 255
    梱包済供給品目の単位。
  • タイトル: Purchasable
    読取り専用: true
    最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、品目は購買可能になります。 falseの場合、品目は購買に対して使用不可になります。 この属性にはデフォルト値がありません。
  • カタログ品目によって参照される検索オブジェクトを一意に識別する値。
  • 読取り専用: true
    最大長: 255
    品目の摘要。
  • 契約ヘッダーを一意に識別する値。
  • タイトル: Agreement
    読取り専用: true
    最大長: 30
    品目が使用可能な契約を識別する番号。
  • 契約明細を一意に識別する値です。
  • 読取り専用: true
    最大長: 300
    サプライヤ品目を識別する番号。
  • 読取り専用: true
    最大長: 255
    サプライヤ品目補助を一意に識別する値。
  • 読取り専用: true
    最大長: 360
    品目または契約のサプライヤの名前。
  • 読取り専用: true
    最大長: 255
    品目が使用する単位。
  • 読取り専用: true
    購買会社の通貨での品目の価格。
  • タイトル: UNSPSC
    読取り専用: true
    最大長: 700
    購買される商品およびサービスを一意に識別する値。
  • 読取り専用: true
    最大長: 255
    単位を識別する略語。
ネストされたスキーマ : 購入オプション
タイプ: array
タイトル: Buying Options
購買オプション・リソースは、複数の契約によって品目が参照されるときに、様々な購買オプションを取得します。
ソースを表示
ネストされたスキーマ : 品目GTIN関連
タイプ: array
タイトル: Item GTIN Relationships
品目GTIN関連リソースは、マスター品目のグローバル取引品目番号(GTIN)詳細を取得します。
ソースを表示
ネストされたスキーマ : 品目イメージ
タイプ: array
タイトル: Item Images
品目イメージ・リソースは、マスター品目のイメージを取得します。
ソースを表示
ネストされたスキーマ : 品目製造業者
タイプ: array
タイトル: Item Manufacturers
品目製造業者リソースは、マスター品目の製造業者詳細を取得します。
ソースを表示
ネストされたスキーマ : 品目サプライヤ
タイプ: array
タイトル: Item Suppliers
品目サプライヤ・リソースは、マスター品目のサプライヤ詳細を取得します。
ソースを表示
ネストされたスキーマ : shoppingCatalogItemDetails-buyingOptions-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : shoppingCatalogItemDetails-itemGTINRelationships-item-response
タイプ: object
ソースを表示
  • タイトル: GTIN
    読取り専用: true
    最大長: 255
    マスター品目のグローバル取引品目番号(GTIN)を一意に識別する値。
  • Links
  • 読取り専用: true
    最大長: 255
    グローバル取引品目番号(GTIN)のパーティのタイプです。 値は、空白、サプライヤまたは製造業者です。
  • タイトル: UOM
    読取り専用: true
    最大長: 25
    グローバル取引品目番号(GTIN)が定義されている単位を識別する略称です。
ネストされたスキーマ : shoppingCatalogItemDetails-itemImages-item-response
タイプ: object
ソースを表示
  • タイトル: DownloadInfo
    ファイル添付をプログラムで取得するために必要な情報を含むJSON形式の文字列。
  • タイトル: File Web Image
    読取り専用: true
    Base64でエンコードされた、.png形式で表示されるファイルのイメージ(ソースが変換可能なイメージの場合)。
  • 読取り専用: true
    品目イメージのUniform Resource Locator (URL)。
  • Links
ネストされたスキーマ : shoppingCatalogItemDetails-itemManufacturers-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: Manufacturer
    読取り専用: true
    最大長: 360
    品目の製造業者の名前。
  • タイトル: Manufacturer Part Number
    読取り専用: true
    最大長: 150
    個々の部品を一意に識別する製造業者によって発行された番号。 このアトリビュートは、パーツを類似パーツや偽造と区別します。
ネストされたスキーマ : shoppingCatalogItemDetails-itemSuppliers-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: Supplier
    読取り専用: true
    最大長: 360
    マスター品目のサプライヤの名前。
  • タイトル: Supplier Item
    読取り専用: true
    最大長: 150
    個々の部品を一意に識別するサプライヤが発行した番号。 このアトリビュートは、パーツを類似パーツや偽造と区別します。
トップに戻る

この例では、1つの品目の詳細を取得する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/SearchObjectId"

たとえば、次のコマンドは1つの品目の詳細を取得します:

curl -u username:password "https://servername/fscmRestApi/resources/version/costAdjustments/4011"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
	"items": [
	{
		"SearchObjectId": 100100139952304,
		"SupplierPartAuxid": "Aux1234",
		"Availability": "Available",
		"PackagingString": "EA 5/BX 5",
		"LeadTime": 10,
		"LongDescription": "Mother Board for the internal laptops",
		"Comments": "This agreement is for internal user",
		"CategoryName": "Miscellaneous_1",
		"VendorName": "CV_SuppA01",
		"UnitOfMeasure": "Each",
		"Amount": 1000,
		"UnitPrice": 100,
		"Quantity": 10,
		"CurrencyCode": "USD",
		"ShortDescription": "Mother board",
		"Manufacturer": "Dell",
		"ImageURL": "https://images.example.com/photo-1516424716439-aeccb78c41c8?ixlib=rb-1.2.1",
		"LineType": "Goods",
		"ManufacturerPartNumber": "Part1234",
		"SourceDocumentHeaderId": 556300,
		"SourceDocumentLineId": 534087,
		"SourceDocumentNumber": "1002737",
		"UNSPSC": "345353",
		"UOMCode": "Ea",
		"Item": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304",
			"name": "shoppingCatalogItemDetails",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304",
			"name": "shoppingCatalogItemDetails",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemGTINRelationships",
			"name": "itemGTINRelationships",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemImages",
			"name": "itemImages",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemManufacturers",
			"name": "itemManufacturers",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemSuppliers",
			"name": "itemSuppliers",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails",
		"name": "shoppingCatalogItemDetails",
		"kind": "collection"
	}
	]
}
「トップに戻る」