Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

カタログ割当の作成

post

/fscmRestApi/resources/11.13.18.05/contentZones/{contentZonesUniqID}/child/catalogAssignments

リクエスト

パス・パラメータ

contentZonesUniqID(required): string

これは、コンテンツ・ゾーン・リソースのコンポジット・キーを構成し、コンテンツ・ゾーンのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、コンテンツ・ゾーンの特定のインスタンスに移動してハッシュ・キーを取得するために、コンテンツ・ゾーン・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

タイプ: object

ソースを表示

Catalog: string

タイトル: Catalog

コンテンツ・ゾーンに割り当てられているカタログの名前。
CatalogId: integer (int64)

コンテンツ・ゾーンに割り当てられたカタログを一意に識別する値。

{
    "type":"object",
    "properties":{
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog that's assigned to the content zone.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "Catalog":{
            "title":"Catalog",
            "type":"string",
            "description":"Name of the catalog that's assigned to the content zone.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CatalogName"
                ]
            }
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : contentZones-catalogAssignments-item-response

タイプ: object

ソースを表示

Catalog: string

タイトル: Catalog

コンテンツ・ゾーンに割り当てられているカタログの名前。
CatalogAssignmentId: integer (int64)

読取り専用: true

カタログ割当を一意に識別する値。
CatalogId: integer (int64)

コンテンツ・ゾーンに割り当てられたカタログを一意に識別する値。
CatalogType: string

タイトル: Catalog Type

読取り専用: true

最大長: 80

コンテンツ・ゾーンに割り当てられているカタログのタイプです。有効な値は、「ローカル」、「パンチ・アウト」または「情報」です。
CatalogTypeCode: string

読取り専用: true

最大長: 15

カタログのタイプを識別する略称。有効な値は、LOCAL、PUNCHOUTまたはINFORMATIONALです。
ContentZoneId: integer (int64)

読取り専用: true

コンテンツ・ゾーンを一意に識別する値。
CreatedBy: string

読取り専用: true

最大長: 64

カタログ割当を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーがカタログ割当を作成した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

カタログ割当を最後に更新したユーザー。
LastUpdatedDate: string (date-time)

読取り専用: true

ユーザーがカタログ割当を最後に更新した日時。
links: array Links

タイトル: Links

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the catalog assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the catalog assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the catalog assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogType":{
            "title":"Catalog Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of the catalog that's assigned to the content zone. Valid values are Local, Punchout, or Informational.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogTypeCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the type of the catalog. Valid values are LOCAL, PUNCHOUT, or INFORMATIONAL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the catalog assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContentZoneId":{
            "type":"integer",
            "description":"Value that uniquely identifies the content zone.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog that's assigned to the content zone.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CatalogAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Catalog":{
            "title":"Catalog",
            "type":"string",
            "description":"Name of the catalog that's assigned to the content zone.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CatalogName"
                ]
            }
        }
    }
}

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

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

トップに戻る

例

この例では、カタログをコンテンツ・ゾーンに割り当てる方法について説明します。

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/contentZones/contentZonesUniqID/child/catalogAssignments"

リクエスト本文の例

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

{                    
    "Catalog": "Office Supplies"
}

レスポンス本文の例

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

{
    "CatalogAssignmentId": 300100585271636,
    "ContentZoneId": 300100585274636,
    "CatalogId": 300100585218640,
    "Catalog": "Office Supplies",
    "CatalogTypeCode": "LOCAL",
    "CatalogType": "Local",
    "CreationDate": "2023-11-01T16:31:06.247+00:00",
    "CreatedBy": "CVBUYER01",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdatedDate": "2023-11-01T16:31:06.247+00:00",
    "links": [
        . . .
    ]
}

「トップに戻る」