Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

検索語句を1つ作成

post

/fscmRestApi/resources/11.13.18.05/shoppingSearches

リクエスト

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/json

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

brandFilters: array Brand Filters

タイトル: Brand Filters

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

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

タイトル: Result Items

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

タイトル: Result Punchout Catalogs

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

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

最大長: 700

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

{
    "required":[
        "RequisitioningBUId",
        "SearchPhraseTerms"
    ],
    "type":"object",
    "properties":{
        "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-post-request"
            }
        },
        "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
            }
        },
        "SearchPhraseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the search phrase.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SearchPhraseTerms":{
            "maxLength":700,
            "type":"string",
            "description":"String of characters that you can use to search.",
            "nullable":false
        },
        "resultItems":{
            "title":"Result Items",
            "type":"array",
            "description":"The Result Items resource manages the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultItems-item-post-request"
            }
        },
        "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-post-request"
            }
        }
    }
}

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

タイプ: array

タイトル: Brand Filters

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

ソースを表示

Array of: object shoppingSearches-brandFilters-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: array

タイトル: Result Items

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

ソースを表示

Array of: object shoppingSearches-resultItems-item-post-request

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

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

タイプ: array

タイトル: Result Punchout Catalogs

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

ソースを表示

Array of: object shoppingSearches-resultPunchoutCatalogs-item-post-request

{
    "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-post-request"
    }
}

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

タイプ: object

ソースを表示

TotalItems: string

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

{
    "type":"object",
    "properties":{
        "TotalItems":{
            "type":"string",
            "description":"Total count of the items from a particular manufacturer.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

Amount: number

タイトル: Amount

機能通貨での品目の金額です。
CurrencyAmount: number

タイトル: Amount

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

最大長: 700

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

{
    "type":"object",
    "properties":{
        "ThumbnailImage":{
            "maxLength":700,
            "type":"string",
            "description":"Thumbnail image of the item.",
            "nullable":true
        },
        "CurrencyAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in foreign currency.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in functional currency.",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : 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"
    }
}

リンク

brandFilters

操作: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/brandFilters

パラメータ:

SearchPhraseId: $request.path.SearchPhraseId

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

resultItems

操作: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultItems

パラメータ:

SearchPhraseId: $request.path.SearchPhraseId

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

resultPunchoutCatalogs

操作: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultPunchoutCatalogs

パラメータ:

SearchPhraseId: $request.path.SearchPhraseId

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

トップに戻る

例

この例では、1つの検索語句を作成する方法を説明します。

cURLコマンドの例

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/shoppingSearches"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
 "SearchPhraseTerms":   "1002258"
}

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{  
   "SearchPhraseId":300100124738549,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"1002258",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

例2 リクエスト本文

次の例では、検索結果から結果品目を取得するためのリクエスト本文のコンテンツをJSON形式で含めます。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
"SearchPhraseTerms":"Laptop Desc"
}

例2 レスポンス本文

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{  
   "SearchPhraseId":300100124920663,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"Laptop Desc",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

例3 リクエスト本文

次の例では、検索結果からパンチアウト・カタログを取得するためのJSON形式のリクエスト本文のコンテンツが含まれています。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
"SearchPhraseTerms":"Rest_Punchout"
}

例3 レスポンス本文

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{  
   "SearchPhraseId":300100124920640,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"Rest_Punchout",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

例4 リクエスト本文

次の例では、JSON形式のリクエスト本文のコンテンツを含めて、検索結果の品目を個別のブランドに取得します。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
"SearchPhraseTerms":"Laptop"
}

例4 レスポンス本文

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{  
   "SearchPhraseId":300100124920664,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"Laptop",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

「トップに戻る」