Jump to

• Request
• Response
• Examples

Create catalog assignments

post

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

Request

Path Parameters

• 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.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "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"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : contentZones-catalogAssignments-item-response

Type: object

Show Source

• 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.

{
    "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"
                ]
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• 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.

{
    "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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top

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": [
        . . .
    ]
}

Back to Top