View Zone layout

GET /zone-layouts/{id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/zone-layouts/{id}

Retrieves the details of a Zone layout that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ zone-layout ]
An array of all created items.
Zone Layout
Name
Description
contentstring
Layout content.


Example: Content goes here.
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:23
descriptionstring
More detailed info about Layout.


Example: Example goes here.
idstring
Layout unique identificator.


Example: banner
layoutstring
Layout unique identificator.


Example: banner
namestring
Layout name.


Example: Banner layout
typestring
Type of the layout.


Example: system
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "banner",
      "layout": "banner",
      "type": "system",
      "name": "Banner layout",
      "content": "Content goes here.",
      "description": "Example goes here.",
      "create_time": "2021-10-29 12:47:23",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}