機械翻訳について

すべてのカタログ品目の取得

get

/fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultItems

リクエスト

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

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • ByMobileApplyFilterCriteria : カテゴリまたは製造元に従って検索結果を検索します。
      ファインダ変数:
      • bind_CategoryName; string; カテゴリ名。
      • bind_Manufacturer; string; 製造元の名前。
    • ByMobileVC : モバイルを使用した検索時に特定の品目を検索します。
      ファインダ変数:
      • ByMobileWithPunchoutItems : カタログ品目を含むパンチアウト品目を検索します。
        ファインダ変数:
        • PrimaryKey : カタログ品目キーに従って検索結果を検索します。
          ファインダ変数:
          • CatalogItemKey; integer; カタログ品目を一意に識別する値。
          • ItemKey; string.
      • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
      • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

        例:
        self,canonical
      • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
      • データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
      • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
      • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY

        フォーマット : ?q=expression1;expression2

        次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
        • Amount; number; 機能通貨での品目の金額。
        • CatalogItemKey; integer; カタログ品目を一意に識別する値。
        • CategoryName; string; 品目を分類するカテゴリの名前。
        • CurrencyAmount; number; 外貨での品目の金額。
        • CurrencyCode; string; 検索結果に表示される品目の通貨を識別する略称。
        • CurrencyUnitPrice; number; 各単位の外貨での品目の価格。
        • FormattedAmount; string; 通貨に対して書式設定された金額。
        • FormattedCurrencyAmount; string; 通貨に対してフォーマットされた通貨金額。
        • FormattedCurrencyUnitPrice; string; 通貨に対して書式設定された各単位の品目の通貨価格の値。
        • FormattedUnitPrice; string; 通貨に対して書式設定された単位ごとの品目の価格。
        • FunctionalCurrencyCode; string; 機能通貨を識別する略称。
        • FunctionalCurrencySymbol; string; 機能通貨を識別する記号。
        • ItemDescription; string; 検索結果に表示される品目の説明。
        • ItemId; integer; 品目を一意に識別する値。
        • ItemKey; string; 品目を一意に識別する値です。 これは、品目の検索時にアプリケーションで生成されるキーです。 品目識別子、ソース文書明細識別子、言語およびパンチアウト品目識別子の組合せです。
        • ItemSource; string; 項目のソースを識別する値。 このソースは、カタログ、カタログ外、クイック作成、パンチアウト、購買依頼インポートまたはwebサービスです。
        • Manufacturer; string; 品目を製造するパーティの名前。
        • OrderTypeLookupCode; string; オーダー・タイプの参照値を識別する略称。 受け入れられる値のリストには、固定価格と数量が含まれます。
        • PunchoutCatalogId; integer; パンチアウト・カタログを一意に識別する値。
        • PunchoutItemId; integer; パンチアウト品目を一意に識別する値。
        • ThumbnailImage; string; 品目のサムネイル・イメージ。
        • UnitOfMeasure; string; 品目で使用される単位。
        • UnitPrice; number; 機能通貨での各ユニットの品目の価格。
      • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
      ヘッダー・パラメータ
      • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
      • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

      トップに戻る

      レスポンス

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

      デフォルトのレスポンス

      次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
      ヘッダー
      • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
      • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
      本文 ()
      ルート・スキーマ : shoppingSearches-resultItems
      タイプ: object
      ソースを表示
      ネストされたスキーマ : 品目
      タイプ: array
      タイトル: Items
      コレクション内の品目。
      ソースを表示
      ネストされたスキーマ : shoppingSearches-resultItems-item-response
      タイプ: object
      ソースを表示
      トップに戻る

      この例では、すべてのカタログ品目を取得する方法を説明します。

      cURLコマンドの例

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

      curl -u username:password "https://servername/fscmRestApi/resources/version/shoppingSearches/SearchPhraseId/child/resultItems"

      レスポンス本文の例

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

      {
          "items": [
              {
                  "ItemKey": "l#-2#403958#-2#US",
                  "ItemId": -2,
                  "PunchoutItemId": -2,
                  "PunchoutCatalogId": -2,
                  "ItemDescription": "14\"\" Laptop 4Mhz, 2 TB HD, DVD, Black",
                  "CurrencyCode": "USD",
                  "OrderTypeLookupCode": "QUANTITY",
                  "CategoryName": "Laptop Computer",
                  "CurrencyUnitPrice": 969,
                  "UnitPrice": 969,
                  "CurrencyAmount": null,
                  "Amount": null,
                  "Manufacturer": "Big Computers",
                  "ThumbnailImage": "https://servername/~apawar/Strategy_Images/googlesamsun.jpg",
                  "ItemSource": "CATALOG",
                  "FunctionalCurrencyCode": "USD",
                  "FunctionalCurrencySymbol": "$",
                  "CatalogItemKey": 69513,
                  "UnitOfMeasure": "Each",
                  "FormattedUnitPrice": "969.00",
                  "FormattedCurrencyUnitPrice": "969.00",
                  "FormattedAmount": null,
                  "FormattedCurrencyAmount": null,
                  "links": [
                      {
                          "rel": "self",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393538232D322355530000000EACED000577080000000000010F89",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "canonical",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393538232D322355530000000EACED000577080000000000010F89",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "parent",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917",
                          "name": "shoppingSearches",
                          "kind": "item"
                      }
                  ]
              },
              {
                  "ItemKey": "l#300100089967925#-2#-2#US",
                  "ItemId": 300100089967925,
                  "PunchoutItemId": -2,
                  "PunchoutCatalogId": -2,
                  "ItemDescription": "zR13OTBI_LCM_ITM002",
                  "CurrencyCode": "USD",
                  "OrderTypeLookupCode": "QUANTITY",
                  "CategoryName": "Laptop Accessory",
                  "CurrencyUnitPrice": 5,
                  "UnitPrice": 5,
                  "CurrencyAmount": null,
                  "Amount": null,
                  "Manufacturer": null,
                  "ThumbnailImage": null,
                  "ItemSource": "CATALOG",
                  "FunctionalCurrencyCode": "USD",
                  "FunctionalCurrencySymbol": "$",
                  "CatalogItemKey": 50333,
                  "UnitOfMeasure": "Kilogram",
                  "FormattedUnitPrice": "5.00",
                  "FormattedCurrencyUnitPrice": "5.00",
                  "FormattedAmount": null,
                  "FormattedCurrencyAmount": null,
                  "links": [
                      {
                          "rel": "self",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/00020000001A6C23333030313030303839393637393235232D32232D322355530000000EACED00057708000000000000C49D",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "canonical",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/00020000001A6C23333030313030303839393637393235232D32232D322355530000000EACED00057708000000000000C49D",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "parent",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917",
                          "name": "shoppingSearches",
                          "kind": "item"
                      }
                  ]
              },
              {
                  "ItemKey": "l#-2#403961#-2#US",
                  "ItemId": -2,
                  "PunchoutItemId": -2,
                  "PunchoutCatalogId": -2,
                  "ItemDescription": "Laptop Carrycase Black",
                  "CurrencyCode": "USD",
                  "OrderTypeLookupCode": "QUANTITY",
                  "CategoryName": "Laptop Accessory",
                  "CurrencyUnitPrice": 25,
                  "UnitPrice": 25,
                  "CurrencyAmount": null,
                  "Amount": null,
                  "Manufacturer": "Big Computers",
                  "ThumbnailImage": "https://servername/~apawar/Strategy_Images/backpack-2-720x480-c.jpg",
                  "ItemSource": "CATALOG",
                  "FunctionalCurrencyCode": "USD",
                  "FunctionalCurrencySymbol": "$",
                  "CatalogItemKey": 69516,
                  "UnitOfMeasure": "Each",
                  "FormattedUnitPrice": "25.00",
                  "FormattedCurrencyUnitPrice": "25.00",
                  "FormattedAmount": null,
                  "FormattedCurrencyAmount": null,
                  "links": [
                      {
                          "rel": "self",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393631232D322355530000000EACED000577080000000000010F8C",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "canonical",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393631232D322355530000000EACED000577080000000000010F8C",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "parent",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917",
                          "name": "shoppingSearches",
                          "kind": "item"
                      }
                  ]
              },
              {
                  "ItemKey": "l#-2#403962#-2#US",
                  "ItemId": -2,
                  "PunchoutItemId": -2,
                  "PunchoutCatalogId": -2,
                  "ItemDescription": "Netbook Carrycase Black",
                  "CurrencyCode": "USD",
                  "OrderTypeLookupCode": "QUANTITY",
                  "CategoryName": "Laptop Accessory",
                  "CurrencyUnitPrice": 22,
                  "UnitPrice": 22,
                  "CurrencyAmount": null,
                  "Amount": null,
                  "Manufacturer": "Big Computers",
                  "ThumbnailImage": "https://servername//~apawar/Strategy_Images/s-l1600.jpg",
                  "ItemSource": "CATALOG",
                  "FunctionalCurrencyCode": "USD",
                  "FunctionalCurrencySymbol": "$",
                  "CatalogItemKey": 69517,
                  "UnitOfMeasure": "Each",
                  "FormattedUnitPrice": "22.00",
                  "FormattedCurrencyUnitPrice": "22.00",
                  "FormattedAmount": null,
                  "FormattedCurrencyAmount": null,
                  "links": [
                      {
                          "rel": "self",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393632232D322355530000000EACED000577080000000000010F8D",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "canonical",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393632232D322355530000000EACED000577080000000000010F8D",
                          "name": "resultItems",
                          "kind": "item"
                      },
                      {
                          "rel": "parent",
                          "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917",
                          "name": "shoppingSearches",
                          "kind": "item"
                      }
                  ]
              }
          ],
          "count": 4,
          "hasMore": false,
          "limit": 200,
          "offset": 0,
          "links": [
              {
                  "rel": "self",
                  "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems",
                  "name": "resultItems",
                  "kind": "collection"
              }
          ]
      }
      
      「トップに戻る」