1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Layouts

createComponentLayout

post

/ccadmin/v1/layouts/component/{id}

Create Component Layout. Creates a component layout.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : createComponentLayout_response
Type: object
Show Source
Example:
{
    "regions":[
        {
            "deviceType":null,
            "metadata":null,
            "components":[
            ],
            "endDate":null,
            "displayName":null,
            "roles":[
            ],
            "type":101,
            "widgets":[
            ],
            "structure":100,
            "cssClass":null,
            "repositoryId":"re1200004",
            "name":null,
            "width":12,
            "audiences":[
            ],
            "startDate":null,
            "mobileWidth":0,
            "height":null
        }
    ],
    "displayName":"Test Container",
    "repositoryId":"pl1100004",
    "name":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/layouts/component/700005"
        }
    ]
}
Nested Schema : regions
Type: array
The regions of the new layout.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : audiences
Type: array
Region audiences (slot-variant-specific).
Show Source
Nested Schema : components
Type: array
Components in the region.
Show Source
Nested Schema : roles
Type: array
The roles of the region.
Show Source
Nested Schema : widgets
Type: array
Widgets
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : ruleSet
Type: object
The rule set for the Audience.
Show Source
Nested Schema : rules
Type: array
An array of rules that make up the rule set.
Show Source
Nested Schema : items
Type: object
Show Source
  • The category of the property, i.e. the user profile.
  • The operator applied to the rule property.
  • The property to be evaluated.
  • The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.
Nested Schema : items
Type: object
Show Source
Nested Schema : instances
Type: array
The instances of the component.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : layoutAssociations
Type: array
The layouts the component instances are associated with.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : descriptor
Type: object
Descriptor
Show Source

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33075|Component not found. | |33076|Component layout already exists.| |33078|Component type is not a container.| |33077|Error creating layout.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top