REST API for Oracle Commerce Cloud December 2017

getElements

get

/ccadmin/v1/elements

Get Elements. Returns on all global or non-global Elements on the system.

Request

Supported Media Types

application/json

Query Parameters

Globals: Type: boolean

Whether global or non-global Elements are desired.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getElements_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of Fragments.

Nested Schema : items

Type: array

The list of Fragments.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

children: Type: array children

Additional Properties Allowed:

Array of fragments.
config: Type: object config

Additional Properties Allowed:

Configuration object for fragment.
configOptions: Type: array configOptions

Additional Properties Allowed:

Array of configurable options.
inline: Type: boolean

Whether inline or not.
previewText: Type: string

Preview of the fragment instance.
repositoryId: Type: integer

Repository ID of fragment.
styles: Type: object styles

Additional Properties Allowed:

Styles of fragment.
tag: Type: string

Tag name of the fragment.
text: Type: string

Text related to fragment.
title: Type: string

Title of the fragment.
type: Type: string

Type of fragment.

Nested Schema : children

Type: array

Array of fragments.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : config

Type: object

Configuration object for fragment.

Properties

color: Type: string

The color of the text
display: Type: string

The display text
font-family: Type: string

The font family
font-style: Type: string

The font style
font-weight: Type: string

The font family
text-decoration: Type: string

Text decoration e.g underline, strike through

Nested Schema : configOptions

Type: array

Array of configurable options.

Items

Type: string

Nested Schema : styles

Type: object

Styles of fragment.

Properties

color: Type: string

Title of the fragment.
display: Type: string

Title of the fragment.
font-family: Type: string

Title of the fragment.
font-style: Type: string

Title of the fragment.
font-weight: Type: string

Title of the fragment.
text-decoration: Type: string

Title of the fragment.

Nested Schema : items

Type: object

Properties

customTitle: Type: string

Custom Title of the fragment.
inline: Type: boolean

Whether inline or not.
tag: Type: string

Tag name of the fragment.
text: Type: string

Text of the fragment.
title: Type: string

Title of the fragment.

Example application/json


[
    {
        "inline":true,
        "children":[
        ],
        "repositoryId":"company-logoFragment",
        "styles":{
        },
        "customTitle":null,
        "tag":"company-logo",
        "text":null,
        "title":"Company Logo",
        "type":"fragment",
        "previewText":null,
        "config":{
        },
        "configOptions":[
        ]
    },
    {
        "inline":true,
        "children":[
        ],
        "repositoryId":"company-nameFragment",
        "styles":{
        },
        "customTitle":null,
        "tag":"company-name",
        "text":null,
        "title":"Company Name",
        "type":"fragment",
        "previewText":"Example",
        "config":{
        },
        "configOptions":[
            "fontPicker",
            "preview"
        ]
    }
]

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

[
  {
    "inline": true,
    "children": [],
    "repositoryId": "company-logoFragment",
    "styles": {},
    "customTitle": null,
    "tag": "company-logo",
    "text": null,
    "title": "Company Logo",
    "type": "fragment",
    "previewText": null,
    "config": {},
    "configOptions": []
  },
  {
    "inline": true,
    "children": [],
    "repositoryId": "company-nameFragment",
    "styles": {},
    "customTitle": null,
    "tag": "company-name",
    "text": null,
    "title": "Company Name",
    "type": "fragment",
    "previewText": "Example",
    "config": {},
    "configOptions": [
      "fontPicker",
      "preview"
    ]
  }
]