Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

すべての検索品目の取得

get

/fscmRestApi/resources/11.13.18.05/shoppingSearches

リクエスト

問合せパラメータ

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 : 検索フレーズ識別子に従って検索結果を検索します。
  ファインダ変数:
  - SearchPhraseId; integer; 検索フレーズを一意に識別する値。
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問合せパラメータを使用してこの収集リソースをフィルタできます:
- RequisitioningBUId; integer; 検索が実行された購買依頼発行BUを一意に識別する値。
- SearchDate; string; 検索が実行された日付。
- SearchPhraseId; integer; 検索語句を一意に識別する値。
- SearchPhraseTerms; string; 検索に使用できる文字の文字列。
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のデフォルト・バージョンを選択します。

ルート・スキーマ : shoppingSearches

タイプ: 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"の場合、推定行数は含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

ネストされたスキーマ : 品目

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

Array of: object shoppingSearches-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : shoppingSearches-item-response

タイプ: object

ソースを表示

brandFilters: array Brand Filters

タイトル: Brand Filters

ブランド・フィルタ・リソースは、検索結果の品目を個別のブランドにフィルタします。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
RequisitioningBUId: integer (int64)

検索が実行された購買依頼発行BUを一意に識別する値。
resultItems: array Result Items

タイトル: Result Items

結果品目リソースは検索結果を管理します。
resultPunchoutCatalogs: array Result Punchout Catalogs

タイトル: Result Punchout Catalogs

結果パンチアウト・カタログ・リソースは、検索結果からのパンチアウト・カタログを管理します。
SearchDate: string (date)

読取り専用: true

検索が実行された日付。
SearchPhraseId: integer (int64)

検索語句を一意に識別する値。
SearchPhraseTerms: string

最大長: 700

検索に使用できる文字の文字列。

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning BU in which the search was run.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "resultItems":{
            "title":"Result Items",
            "type":"array",
            "description":"The Result Items resource manages the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultItems-item-response"
            }
        },
        "SearchDate":{
            "type":"string",
            "description":"Date when the search was conducted.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "brandFilters":{
            "title":"Brand Filters",
            "type":"array",
            "description":"The Brand Filters resource filters the items in the search results into distinct brands.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-brandFilters-item-response"
            }
        },
        "resultPunchoutCatalogs":{
            "title":"Result Punchout Catalogs",
            "type":"array",
            "description":"The Result Punchout Catalogs resource manages the punchout catalogs from the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultPunchoutCatalogs-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SearchPhraseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the search phrase.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SearchPhraseTerms":{
            "maxLength":700,
            "type":"string",
            "description":"String of characters that you can use to search.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : ブランド・フィルタ

タイプ: array

タイトル: Brand Filters

ブランド・フィルタ・リソースは、検索結果の品目を個別のブランドにフィルタします。

ソースを表示

Array of: object shoppingSearches-brandFilters-item-response

{
    "title":"Brand Filters",
    "type":"array",
    "description":"The Brand Filters resource filters the items in the search results into distinct brands.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-brandFilters-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 結果品目

タイプ: array

タイトル: Result Items

結果品目リソースは検索結果を管理します。

ソースを表示

Array of: object shoppingSearches-resultItems-item-response

{
    "title":"Result Items",
    "type":"array",
    "description":"The Result Items resource manages the search results.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-resultItems-item-response"
    }
}

ネストされたスキーマ : 結果パンチアウト・カタログ

タイプ: array

タイトル: Result Punchout Catalogs

結果パンチアウト・カタログ・リソースは、検索結果からのパンチアウト・カタログを管理します。

ソースを表示

Array of: object shoppingSearches-resultPunchoutCatalogs-item-response

{
    "title":"Result Punchout Catalogs",
    "type":"array",
    "description":"The Result Punchout Catalogs resource manages the punchout catalogs from the search results.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-resultPunchoutCatalogs-item-response"
    }
}

ネストされたスキーマ : shoppingSearches-brandFilters-item-response

タイプ: object

ソースを表示

links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Manufacturer: string

読取り専用: true

最大長: 255

品目を製造するパーティの名前です。
TotalItems: string

特定の製造元からの品目の合計数。

{
    "type":"object",
    "properties":{
        "Manufacturer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the party who manufactures the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalItems":{
            "type":"string",
            "description":"Total count of the items from a particular manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : shoppingSearches-resultItems-item-response

タイプ: object

ソースを表示

Amount: number

タイトル: Amount

機能通貨での品目の金額です。
CatalogItemKey: integer (int64)

読取り専用: true

カタログ品目を一意に識別する値。
CategoryName: string

読取り専用: true

最大長: 250

品目を分類するカテゴリの名前です。
CurrencyAmount: number

タイトル: Amount

品目の金額(外貨)。
CurrencyCode: string

読取り専用: true

最大長: 32

検索結果に表示される品目の通貨を識別する略称です。
CurrencyUnitPrice: number

タイトル: Price

読取り専用: true

外国通貨での各ユニットの品目の価格。
FormattedAmount: string

読取り専用: true

通貨に対してフォーマットされた金額です。
FormattedCurrencyAmount: string

読取り専用: true

通貨に対して書式設定された通貨金額。
FormattedCurrencyUnitPrice: string

読取り専用: true

通貨に対して書式設定された各単位の品目の通貨価格の値。
FormattedUnitPrice: string

読取り専用: true

通貨に対して書式設定された各単位の品目の価格。
FunctionalCurrencyCode: string

読取り専用: true

最大長: 32

機能通貨を識別する略称です。
FunctionalCurrencySymbol: string

読取り専用: true

機能通貨を識別する記号。
ItemDescription: string

タイトル: Description

読取り専用: true

最大長: 960

検索結果に表示される品目の説明。
ItemId: integer (int64)

読取り専用: true

品目を一意に識別する値。
ItemKey: string

読取り専用: true

最大長: 88

品目を一意に識別する値。これは、品目の検索時にアプリケーションで生成されるキーです。品目識別子、ソース文書明細識別子、言語およびパンチアウト品目識別子の組合せです。
ItemSource: string

読取り専用: true

最大長: 255

デフォルト値: CATALOG

品目のソースを識別する値です。このソースは、カタログ、カタログ外、クイック作成、パンチアウト、購買依頼インポートまたはwebサービスです。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Manufacturer: string

タイトル: Brand

読取り専用: true

最大長: 700

品目を製造するパーティの名前です。
OrderTypeLookupCode: string

タイトル: Line Type

読取り専用: true

最大長: 25

オーダー・タイプの参照値を識別する略称です。受け入れられる値のリストには、固定価格と数量が含まれます。
PunchoutCatalogId: integer (int64)

読取り専用: true

パンチアウト・カタログを一意に識別する値。
PunchoutItemId: integer (int64)

読取り専用: true

パンチアウト品目を一意に識別する値。
ThumbnailImage: string

最大長: 700

品目のサムネイル・イメージ。
UnitOfMeasure: string

読取り専用: true

品目が使用する単位。
UnitPrice: number

タイトル: Price

読取り専用: true

機能通貨での各ユニットの品目の価格。

{
    "type":"object",
    "properties":{
        "PunchoutCatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies punchout catalog.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogItemKey":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure that the item uses.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Uom"
                ]
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSource":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the source of the item. This source can be catalog, noncatalog, quick create, punchout, requisition import, or web service.",
            "nullable":true,
            "readOnly":true,
            "default":"CATALOG",
            "x-queryable":true
        },
        "FormattedAmount":{
            "type":"string",
            "description":"Amount formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Amount",
                    "FunctionalCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "FormattedCurrencyUnitPrice":{
            "type":"string",
            "description":"Value of the currency price of item for each unit formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrencyCode",
                    "CurrencyUnitPrice"
                ]
            },
            "x-queryable":true
        },
        "CurrencyUnitPrice":{
            "title":"Price",
            "type":"number",
            "description":"Price of item for each unit in foreign currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencySymbol":{
            "type":"string",
            "description":"Symbol that identifies the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":960,
            "type":"string",
            "description":"Description of the item that is displayed in the search results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in foreign currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":32,
            "type":"string",
            "description":"Abbreviation that identifies the currency of the item that is displayed in the search results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Price",
            "type":"number",
            "description":"Price of item for each unit in functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "maxLength":32,
            "type":"string",
            "description":"Abbreviation that identifies the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThumbnailImage":{
            "maxLength":700,
            "type":"string",
            "description":"Thumbnail image of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemKey":{
            "maxLength":88,
            "type":"string",
            "description":"Value that uniquely identifies the item. It is a key that the application generates when it searches for the item. It is the combination of item identifier, source document line identifier, language, and punchout item identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PunchoutItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Manufacturer":{
            "title":"Brand",
            "maxLength":700,
            "type":"string",
            "description":"Name of the party who manufactures the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedCurrencyAmount":{
            "type":"string",
            "description":"Currency amount formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrencyAmount",
                    "CurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "OrderTypeLookupCode":{
            "title":"Line Type",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the category that classifies the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedUnitPrice":{
            "type":"string",
            "description":"Price of item for each unit formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode",
                    "UnitPrice"
                ]
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : shoppingSearches-resultPunchoutCatalogs-item-response

タイプ: object

ソースを表示

CatalogId: integer (int64)

読取り専用: true

パンチアウト・カタログを一意に識別する値。
CatalogName: string

読取り専用: true

最大長: 30

検索結果に表示されるパンチアウト・カタログの名前。
ImageURL: string

読取り専用: true

品目のイメージのURL (Uniform Resource Locator)。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PunchoutURL: string

読取り専用: true

パンチアウト・カタログのイメージのURL (Uniform Resource Locator)。

{
    "type":"object",
    "properties":{
        "ImageURL":{
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the image of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PunchoutURL":{
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the image of the punchout catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the punchout catalog that is displayed in the search results.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

「トップに戻る」