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(optional): boolean
Whether global or non-global Elements are desired.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getElements_response
Type:
Show Source
object
-
items(optional):
array items
The list of Fragments.
Nested Schema : items
Type:
Show Source
object
-
children(optional):
array children
Array of fragments.
-
config(optional):
object config
Configuration object for fragment.
-
configOptions(optional):
array configOptions
Array of configurable options.
-
inline(optional):
boolean
Whether inline or not.
-
previewText(optional):
string
Preview of the fragment instance.
-
repositoryId(optional):
integer
Repository ID of fragment.
-
styles(optional):
object styles
Styles of fragment.
-
tag(optional):
string
Tag name of the fragment.
-
text(optional):
string
Text related to fragment.
-
title(optional):
string
Title of the fragment.
-
type(optional):
string
Type of fragment.
Nested Schema : config
Type:
object
Configuration object for fragment.
Nested Schema : styles
Type:
object
Styles of fragment.
Show Source
-
color(optional):
string
Title of the fragment.
-
display(optional):
string
Title of the fragment.
-
font-family(optional):
string
Title of the fragment.
-
font-style(optional):
string
Title of the fragment.
-
font-weight(optional):
string
Title of the fragment.
-
text-decoration(optional):
string
Title of the fragment.
Nested Schema : items
Type:
Show Source
object
-
customTitle(optional):
string
Custom Title of the fragment.
-
inline(optional):
boolean
Whether inline or not.
-
tag(optional):
string
Tag name of the fragment.
-
text(optional):
string
Text of the fragment.
-
title(optional):
string
Title of the fragment.
Example Response (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
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code