{ "openapi": "3.0.1", "info": { "title": "Layouts", "version": "9.1.20.0", "description": "Create and administer layouts.", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/rest/admin/v2", "variables": { "port": { "default": "443", "enum": [ "443", "8000" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "tags": [ { "name": "Layouts", "description": "Provide RESTful services to manage layouts." } ], "paths": { "/layouts": { "get": { "summary": "Get layouts for a store.", "operationId": "getLayouts", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-builder-class": "com.ibm.commerce.rest.admin.v2.pagelayout.LayoutExpressionBuilder", "x-expression-builder-method": "formatExpression", "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "isTemplate", "description": "Indicates whether it is layout template or layout.", "required": false, "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "searchString", "description": "Limits search results to only include layouts with a name that matches the value of this parameter.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } }, "post": { "summary": "Create a layout.", "operationId": "createLayout", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "processLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ProcessLayoutType", "x-action-code": "Create", "x-expression-template": "{_pgl.enforceUpdateDefault=true}/Layout[1]", "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Layout" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "headers": { "Location": { "description": "The URI of the layout.", "schema": { "type": "string" } } } } } } }, "/layouts/{id}": { "get": { "summary": "Get a layout by ID.", "operationId": "getLayout", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap='{accessProfile}'}/Layout[LayoutIdentifier[(UniqueID='{id}')]]", "x-parameters": { "accessProfile": "IBM_Admin_Summary" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "description": "The layout ID.", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Layout" } } } } } }, "patch": { "summary": "Update a layout.", "operationId": "updateLayout", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Update", "x-expression-template": "{_pgl.enforceUpdateDefault=true}/Layout[1]", "parameters": [ { "name": "id", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Layout" } } } }, "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Layout" } } } } } }, "delete": { "summary": "Delete a layout.", "operationId": "deleteLayout", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "processLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ProcessLayoutType", "x-action-code": "Delete", "x-expression-template": "/Layout[1]", "parameters": [ { "name": "id", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The operation is successful." } } } }, "/layouts/{layoutId}/assignments": { "get": { "summary": "Get layout assignments by layout ID.", "operationId": "getLayoutAssignments", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap={accessProfile}}/Layout[LayoutIdentifier[UniqueID='{layoutId}']]/PageLocation", "x-parameters": { "accessProfile": "IBM_Admin_Layout_Locations" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/pageLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentCollection" } } } } } }, "post": { "summary": "Create a layout assignment.", "operationId": "createLayoutAssignment", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Add", "x-request-verb": "change", "x-expression-template": "/Layout[1]/PageLocation[1]", "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]/pageLocation[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutAssignment" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/pageLocation[1]/pageLocationID", "headers": { "Location": { "description": "The URI of the layout assignment.", "schema": { "type": "string" } } } } } } }, "/layouts/{layoutId}/assignments/{id}": { "delete": { "summary": "Delete a layout assignment.", "operationId": "deleteLayoutAssignment", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Delete", "x-request-verb": "change", "x-expression-template": "/Layout[1]/PageLocation[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the layout assignment.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/pageLocation[1]/pageLocationID", "schema": { "type": "string" } }, { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The operation is successful." } } }, "patch": { "summary": "Update a layout assignment.", "operationId": "updateLayoutAssignment", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Update", "x-request-verb": "change", "x-expression-template": "/Layout[1]/PageLocation[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the layout assignment.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/pageLocation[1]/pageLocationID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "layoutId", "description": "The unique numeric ID for identifying the layout.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]/pageLocation[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutAssignment" } } } }, "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/pageLocation[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutAssignment" } } } } } } }, "/layouts/{layoutId}/widgets": { "get": { "summary": "Get layout widgets by layout ID.", "operationId": "getLayoutWidgets", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap='{accessProfile}'}/Layout[LayoutIdentifier[(UniqueID='{layoutId}')]]", "x-parameters": { "accessProfile": "IBM_Admin_Details" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/widget", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetCollection" } } } } } }, "post": { "summary": "Create a layout widget.", "operationId": "createLayoutWidget", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Add", "x-request-verb": "change", "x-expression-template": "/Layout[1]/Widget[1]", "parameters": [ { "name": "layoutId", "description": "The unique numeric ID for identifying the layout.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]/widget[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } }, "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/widget[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } } } } }, "/layouts/{layoutId}/widgets/{id}": { "delete": { "summary": "Delete a layout widget.", "operationId": "deleteLayoutWidget", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Remove", "x-request-verb": "change", "x-expression-template": "/Layout[1]/Widget[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the widget.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/widgetIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "layoutId", "description": "The unique numeric ID for identifying the layout.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } }, "patch": { "summary": "Update a layout widget.", "operationId": "updateLayoutWidget", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Update", "x-request-verb": "change", "x-expression-template": "/Layout[1]/Widget[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the widget.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/widgetIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "layoutId", "description": "The unique numeric ID for identifying the layout.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]/widget[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } }, "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/widget[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } } } } }, "/layouts/{layoutId}/widgets/{widgetId}/extended-data": { "post": { "summary": "Create a layout widget extended datum.", "operationId": "createLayoutWidgetExtendedData", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Add", "x-request-verb": "change", "x-expression-template": "/Layout[1]/Widget[1]/ExtendedData[1]", "parameters": [ { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "widgetId", "description": "The widget ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/widgetIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedData" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]/uniqueID", "headers": { "Location": { "description": "The URI of the layout widget.", "schema": { "type": "string" } } } } } } }, "/layouts/{layoutId}/widgets/{widgetId}/extended-data/{id}": { "delete": { "summary": "Delete a widget extended datum.", "operationId": "deleteLayoutWidgetExtendedData", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Remove", "x-request-verb": "change", "x-expression-template": "/Layout[1]/Widget[1]/ExtendedData[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the extended datum.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]/attributes[1]/attribute/uniqueId", "schema": { "type": "string" } }, { "name": "widgetId", "description": "The widget ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/widgetIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "dataType", "description": "The data type of the extended data.", "required": true, "in": "query", "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]/dataType", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]/storeIdentifier/uniqueID", "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } }, "patch": { "summary": "Update a widget extended datum.", "operationId": "updateLayoutWidgetExtendedData", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "changeLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType", "x-action-code": "Change", "x-request-verb": "change", "x-expression-template": "/Layout[1]/Widget[1]/ExtendedData[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the extended datum.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]/attributes[1]/attribute/uniqueId", "schema": { "type": "string" } }, { "name": "widgetId", "description": "The unique numeric ID for identifying the widget.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/widget[1]/widgetIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "layoutId", "description": "The layout ID.", "required": true, "in": "path", "x-entity-path": "dataArea/layout[1]/layoutIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]/storeIdentifier/uniqueID", "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedData" } } } }, "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout[1]/widget[1]/extendedData[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedData" } } } } } } }, "/layouts/by-espot/{emsId}": { "get": { "summary": "Get layouts by e-marketing spot ID.", "operationId": "getLayoutsByESpot", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap={accessProfile}}/Layout[Widget[WidgetProperty[Name='emsId' and Value='{emsId}']]]", "x-parameters": { "accessProfile": "IBM_Admin_Summary" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "emsId", "description": "The unique numeric ID for identifying the e-Marketing spot.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } }, "/layouts/by-ids": { "get": { "summary": "Get layouts by list of IDs.", "operationId": "getLayoutsByIds", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap='{accessProfile}'}/Layout[LayoutIdentifier[(UniqueID='{id}')]]", "x-parameters": { "accessProfile": "IBM_Admin_Details" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "description": "The layout ID.", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } }, "/layouts/by-name": { "get": { "summary": "Find layouts by name.", "operationId": "getLayoutsByName", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder", "x-expression-builder-method": "formatExpression", "x-parameters": { "template": "/Layout[@template='$isTemplate$' and search(LayoutIdentifier/ExternalIdentifierType/Name='$name$')]", "accessProfile": "IBM_Admin_Details" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "isTemplate", "description": "Indicates whether it is layout template or layout.", "required": false, "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "name", "description": "The name of the layout to find.", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } }, "/layouts/by-page": { "get": { "summary": "Get layouts by page.", "operationId": "getLayoutsByPage", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap={accessProfile}}/Layout[PageLocation[Page[@pageGroup='{pageType}' and PageIdentifier[UniqueID='{pageId}']]]]", "x-parameters": { "accessProfile": "IBM_Admin_Details" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageId", "description": "The unique numeric ID for identifying the page.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageType", "description": "The page type:
  1. Category
  2. Content
  3. Search
  4. Product
  5. Kit
  6. Bundle
  7. DynamicKit
  8. Variant
  9. CategorySKU
.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } }, "/layouts/template-by-device": { "get": { "summary": "Get layout templates by device class.", "operationId": "getLayoutTemplatesByDeviceClass", "tags": [ "Layouts" ], "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap='{accessProfile}'}/Layout[@deviceClass='{deviceClass}' and template]", "x-parameters": { "accessProfile": "IBM_Admin_Details" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceClass", "description": "The class of the device that this layout is designed to.", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } }, "/layouts/search": { "get": { "summary": "Find layouts.", "operationId": "getLayoutsByAdvancedSearch", "tags": [ "Layouts" ], "description": "Find layouts, used for advanced search.", "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder", "x-expression-builder-method": "formatExpression", "x-parameters": { "template": "{_wcf.ap=$accessProfile$;_pgl.isTemplate='$isTemplate$';_pgl.startDate='$startDate$';_pgl.endDate='$endDate$';_pgl.deviceClass='$deviceClass$'}/Layout[search(LayoutIdentifier/ExternalIdentifierType/Name='$name$')]", "accessProfile": "IBM_Admin_Summary" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "isTemplate", "description": "Indicates whether the layout is a layout template or layout.", "required": true, "in": "query", "schema": { "type": "boolean" } }, { "name": "name", "description": "The name of the layout.", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "description": "The start date time of the layout shedule. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".", "required": true, "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "deviceClass", "description": "The class of the device that this layout is designed to.", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "description": "The end date time of the layout shedule. The date and time must be entered as a timestamp in the following ISO8601 format: \"YYYY-MM-DDThh:mm:ssZ\".", "required": true, "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } }, "/layouts/by-activity": { "get": { "summary": "Get layouts by activity.", "operationId": "getLayoutsByActivity", "tags": [ "Layouts" ], "x-introduced": "9.1.13.0", "x-facade-client-class": "com.ibm.commerce.pagelayout.facade.client.PageLayoutFacadeClient", "x-facade-client-method": "getLayout", "x-request-bod-class": "com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType", "x-expression-template": "{_wcf.ap={accessProfile}}/Layout[PageLocation[@activityID='{activityId}']]", "x-parameters": { "accessProfile": "IBM_Admin_Details" }, "parameters": [ { "name": "storeId", "description": "The store ID.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "activityId", "description": "Limits the results to only include layouts that are associated with the specified activity ID.", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/layout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LayoutCollection" } } } } } } } }, "components": { "schemas": { "AssignmentCollection": { "description": "A collection of page layout assignments.", "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutAssignment" } } } }, "LayoutCollection": { "description": "A collection of page layouts.", "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Layout" } } } }, "Layout": { "description": "A page layout.", "type": "object", "x-entity-class": "com.ibm.commerce.pagelayout.facade.datatypes.LayoutType", "properties": { "id": { "type": "string", "description": "The unique numeric ID for identifying the page layout.", "x-entity-path": "layoutIdentifier/uniqueID" }, "templateId": { "type": "string", "description": "The unique identifier of the template, based on which the page layout is created.", "x-entity-path": "templateIdentifier/uniqueID" }, "name": { "type": "string", "description": "The name of the layout.", "x-entity-path": "layoutIdentifier/externalIdentifier/name" }, "memberId": { "type": "string", "description": "The unique numeric ID for identifying the organization that owns the layout.", "x-entity-path": "layoutIdentifier/externalIdentifier/ownerID" }, "storeId": { "type": "integer", "format": "int32", "description": "The unique numeric ID for identifying the store.", "x-entity-path": "layoutIdentifier/externalIdentifier/storeIdentifier/uniqueID" }, "description": { "type": "string", "description": "The description of the page layout." }, "default": { "type": "boolean", "description": "The flag that indicates whether the page layout is a default page layout. Only one default page layout should exist for each page layout type." }, "layoutGroup": { "type": "string", "description": "The layout group this layout belongs to." }, "deviceClass": { "type": "string", "description": "The class of the device that this layout is designed to render a store page for, for example: " }, "managingTool": { "type": "string", "description": "Indicates which tool manages the page layout." }, "state": { "type": "string", "description": "The state of the page layout." }, "template": { "type": "boolean", "description": "Indicates whether the page layout is a layout template or not." }, "priority": { "type": "integer", "format": "int32", "description": "The priority of the page layout. The default value is 0.", "x-entity-path": "schedule/priority" }, "startDate": { "type": "string", "format": "date-time", "x-entity-path": "schedule/startDate", "description": "The start time for the page layout. If the start time is null, then the page layout can start immediately." }, "endDate": { "type": "string", "format": "date-time", "x-entity-path": "schedule/endDate", "description": "The end time for the page layout. If the end time is null, then the page layout will run indefinitely." }, "assignment": { "description": "The page layout assignment. The matching layout assignment is returned for layouts requested for a specific page.", "x-entity-path": "pageLocation[1]", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LayoutAssignment" } ] } } }, "WidgetCollection": { "description": "A collection of page layout widgets.", "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Widget" } } } }, "Widget": { "description": "An authoring widget.", "x-entity-class": "com.ibm.commerce.pagelayout.facade.datatypes.AuthoringWidgetType", "type": "object", "properties": { "widgetSequence": { "description": "The order that the child widget or child container is displayed within a parent container.", "type": "number", "format": "double" }, "layoutId": { "description": "The unique numeric ID for identifying the page layout.", "type": "string", "x-entity-path": "container/layoutIdentifier/uniqueID" }, "id": { "description": "The unique numeric ID for identifying the widget.", "type": "string", "x-entity-path": "widgetIdentifier/uniqueID" }, "name": { "description": "The name of the widget.", "type": "string", "x-entity-path": "widgetIdentifier/name" }, "widgetDefinitionId": { "description": "The unique numeric ID for identifying the widget definition for the widget.", "type": "string", "x-entity-path": "widgetDefinitionIdentifier/uniqueID" }, "widgetDefinitionName": { "description": "The widget definition name of the widget.", "type": "string", "x-entity-path": "widgetDefinitionIdentifier/externalIdentifier/identifier" }, "slotName": { "x-entity-path": "slot/internalSlotId", "type": "string", "description": "The name of the slot where the widget is included." }, "properties": { "x-entity-path": "widgetProperty", "description": "The list of properties for the widget.", "type": "array", "items": { "$ref": "#/components/schemas/WidgetProperty" } }, "extendedData": { "description": "The list of extended data for the widget.", "type": "array", "items": { "$ref": "#/components/schemas/ExtendedData" } }, "parentWidgetId": { "description": "The unique numeric ID for identifying the parent widget.", "type": "string", "x-entity-path": "parentWidget/uniqueID" }, "parentWidgetName": { "description": "The name of the parent widget.", "type": "string", "x-entity-path": "parentWidget/name" } } }, "ExtendedData": { "description": "The widget extended data.", "type": "object", "x-entity-class": "com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType", "properties": { "widgetId": { "description": "The unique numeric ID for identifying the widget.", "type": "string", "x-entity-path": "container/widgetIdentifier/uniqueID" }, "id": { "description": "The extended data ID.The unique numeric ID for identifying the extended data.", "type": "string", "x-entity-path": "uniqueID" }, "storeId": { "description": "The unique numeric ID for identifying the store.", "type": "integer", "format": "int32", "x-entity-path": "storeIdentifier/uniqueID" }, "sequenceOrder": { "description": "The sequence that the extended data displays for the widget.", "type": "number", "format": "double" }, "dataType": { "description": "The data type for the extended data.", "type": "string" }, "attributes": { "description": "The widget extended data for each supported language.", "type": "array", "items": { "$ref": "#/components/schemas/LanguageData" } } } }, "LanguageData": { "description": "The extended data for a language.", "type": "object", "x-entity-class": "com.ibm.commerce.pagelayout.facade.datatypes.AttributesType", "properties": { "languageId": { "description": "The languageId of the extended data.", "type": "number", "x-entity-path": "language" }, "data": { "description": "The data.", "type": "object", "x-entity-path": "attribute", "additionalProperties": { "type": "string" } } } }, "WidgetProperty": { "description": "A widget property.", "type": "object", "x-entity-class": "com.ibm.commerce.pagelayout.facade.datatypes.WidgetPropertyType", "properties": { "widgetId": { "description": "The widget ID.The unique numeric ID for identifying the widget.", "type": "string", "x-entity-path": "container/widgetIdentifier/uniqueID" }, "id": { "description": "The unique numeric ID for identifying the widget property.", "type": "string", "x-entity-path": "widgetPropertyID" }, "sequenceOrder": { "description": "The sequence that the properties display for the widget.", "type": "number", "format": "double" }, "name": { "description": "The name of the widget property.", "type": "string" }, "value": { "description": "The value of the widget property.", "type": "string" } } }, "LayoutAssignment": { "description": "A layout assignment.", "type": "object", "x-entity-class": "com.ibm.commerce.pagelayout.facade.datatypes.PageLocationType", "properties": { "id": { "description": "The unique numeric ID for identifying the layout assignment.", "type": "string", "x-entity-path": "pageLocationID" }, "storeId": { "description": "The unique numeric ID for identifying the store.", "type": "integer", "format": "int32", "x-entity-path": "storeIdentifier/uniqueID" }, "activityId": { "description": "The unique numeric ID for identifying the web activity that defines a rule and mapping between a page and a layout.", "type": "integer", "format": "int32", "x-entity-path": "activityID" }, "searchKeyword": { "description": "A search keyword.", "type": "string", "x-entity-path": "keyword" }, "pageId": { "description": "The unique numeric ID for identifying the page.", "type": "string", "x-entity-path": "page/pageIdentifier/uniqueID" }, "pageName": { "description": "The page name.", "type": "string", "x-entity-path": "page/pageIdentifier/externalIdentifier/name" }, "applyToSubPage": { "description": "Flag that indicates whether the layout assignment applies to the sub-pages instead of only the page that is indicated by the page name. The value of this attribute indicates the type of sub-pages where the page applies. For example, 'CatalogEntry' indicates that the page layout applies to all the sub-catalog entry pages.", "type": "string", "x-entity-path": "page/applyToSubPage" }, "pageType": { "description": "The page type: ", "type": "string", "x-entity-path": "page/pageGroup" }, "propagateToSubLevels": { "description": "Flag that indicates whether the page layout propagates to sub-levels. It is typically used for 1)Category pages and 2)all child catalog entry pages under a Category.", "type": "boolean", "x-entity-path": "page/propagateToSubLevels" }, "pageStoreId": { "description": "The store ID.", "type": "integer", "format": "int32", "x-entity-path": "page/pageIdentifier/externalIdentifier/storeIdentifier/uniqueID" } } } } } }