Create catalog assignments
/fscmRestApi/resources/11.13.18.05/contentZones/{contentZonesUniqID}/child/catalogAssignments
Request
-
contentZonesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Content Zones resource and used to uniquely identify an instance of Content Zones. The client should not generate the hash key value. Instead, the client should query on the Content Zones collection resource in order to navigate to a specific instance of Content Zones to get the hash key.
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/json
object
-
Catalog: string
Title:
Catalog
Name of the catalog that's assigned to the content zone. -
CatalogId: integer
(int64)
Value that uniquely identifies the catalog that's assigned to the content zone.
Response
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object
-
Catalog: string
Title:
Catalog
Name of the catalog that's assigned to the content zone. -
CatalogAssignmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the catalog assignment. -
CatalogId: integer
(int64)
Value that uniquely identifies the catalog that's assigned to the content zone.
-
CatalogType: string
Title:
Catalog Type
Read Only:true
Maximum Length:80
Type of the catalog that's assigned to the content zone. Valid values are Local, Punchout, or Informational. -
CatalogTypeCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the type of the catalog. Valid values are LOCAL, PUNCHOUT, or INFORMATIONAL. -
ContentZoneId: integer
(int64)
Read Only:
true
Value that uniquely identifies the content zone. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the catalog assignment. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the catalog assignment. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the catalog assignment. -
LastUpdatedDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the catalog assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to assign a catalog to a content zone.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
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"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "Catalog": "Office Supplies" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "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": [ . . . ] }