Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getElements_response

Type: object

Show Source

• items(optional): array items
  The list of Fragments.

{
    "properties":{
        "items":{
            "description":"The list of Fragments.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "inline":{
                        "description":"Whether inline or not.",
                        "type":"boolean"
                    },
                    "children":{
                        "description":"Array of fragments.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "inline":{
                                    "description":"Whether inline or not.",
                                    "type":"boolean"
                                },
                                "customTitle":{
                                    "description":"Custom Title of the fragment.",
                                    "type":"string"
                                },
                                "text":{
                                    "description":"Text of the fragment.",
                                    "type":"string"
                                },
                                "tag":{
                                    "description":"Tag name of the fragment.",
                                    "type":"string"
                                },
                                "title":{
                                    "description":"Title of the fragment.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "repositoryId":{
                        "description":"Repository ID of fragment.",
                        "type":"integer"
                    },
                    "styles":{
                        "description":"Styles of fragment.",
                        "type":"object",
                        "properties":{
                            "color":{
                                "description":"Title of the fragment.",
                                "type":"string"
                            },
                            "font-weight":{
                                "description":"Title of the fragment.",
                                "type":"string"
                            },
                            "text-decoration":{
                                "description":"Title of the fragment.",
                                "type":"string"
                            },
                            "display":{
                                "description":"Title of the fragment.",
                                "type":"string"
                            },
                            "font-family":{
                                "description":"Title of the fragment.",
                                "type":"string"
                            },
                            "font-style":{
                                "description":"Title of the fragment.",
                                "type":"string"
                            }
                        }
                    },
                    "text":{
                        "description":"Text related to fragment.",
                        "type":"string"
                    },
                    "tag":{
                        "description":"Tag name of the fragment.",
                        "type":"string"
                    },
                    "title":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of fragment.",
                        "type":"string"
                    },
                    "previewText":{
                        "description":"Preview of the fragment instance.",
                        "type":"string"
                    },
                    "config":{
                        "description":"Configuration object for fragment.",
                        "type":"object"
                    },
                    "configOptions":{
                        "description":"Array of configurable options.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of Fragments.

Show Source

• Array of: object items

{
    "description":"The list of Fragments.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "inline":{
                "description":"Whether inline or not.",
                "type":"boolean"
            },
            "children":{
                "description":"Array of fragments.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "inline":{
                            "description":"Whether inline or not.",
                            "type":"boolean"
                        },
                        "customTitle":{
                            "description":"Custom Title of the fragment.",
                            "type":"string"
                        },
                        "text":{
                            "description":"Text of the fragment.",
                            "type":"string"
                        },
                        "tag":{
                            "description":"Tag name of the fragment.",
                            "type":"string"
                        },
                        "title":{
                            "description":"Title of the fragment.",
                            "type":"string"
                        }
                    }
                }
            },
            "repositoryId":{
                "description":"Repository ID of fragment.",
                "type":"integer"
            },
            "styles":{
                "description":"Styles of fragment.",
                "type":"object",
                "properties":{
                    "color":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    },
                    "font-weight":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    },
                    "text-decoration":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    },
                    "display":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    },
                    "font-family":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    },
                    "font-style":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    }
                }
            },
            "text":{
                "description":"Text related to fragment.",
                "type":"string"
            },
            "tag":{
                "description":"Tag name of the fragment.",
                "type":"string"
            },
            "title":{
                "description":"Title of the fragment.",
                "type":"string"
            },
            "type":{
                "description":"Type of fragment.",
                "type":"string"
            },
            "previewText":{
                "description":"Preview of the fragment instance.",
                "type":"string"
            },
            "config":{
                "description":"Configuration object for fragment.",
                "type":"object"
            },
            "configOptions":{
                "description":"Array of configurable options.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "inline":{
            "description":"Whether inline or not.",
            "type":"boolean"
        },
        "children":{
            "description":"Array of fragments.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "inline":{
                        "description":"Whether inline or not.",
                        "type":"boolean"
                    },
                    "customTitle":{
                        "description":"Custom Title of the fragment.",
                        "type":"string"
                    },
                    "text":{
                        "description":"Text of the fragment.",
                        "type":"string"
                    },
                    "tag":{
                        "description":"Tag name of the fragment.",
                        "type":"string"
                    },
                    "title":{
                        "description":"Title of the fragment.",
                        "type":"string"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"Repository ID of fragment.",
            "type":"integer"
        },
        "styles":{
            "description":"Styles of fragment.",
            "type":"object",
            "properties":{
                "color":{
                    "description":"Title of the fragment.",
                    "type":"string"
                },
                "font-weight":{
                    "description":"Title of the fragment.",
                    "type":"string"
                },
                "text-decoration":{
                    "description":"Title of the fragment.",
                    "type":"string"
                },
                "display":{
                    "description":"Title of the fragment.",
                    "type":"string"
                },
                "font-family":{
                    "description":"Title of the fragment.",
                    "type":"string"
                },
                "font-style":{
                    "description":"Title of the fragment.",
                    "type":"string"
                }
            }
        },
        "text":{
            "description":"Text related to fragment.",
            "type":"string"
        },
        "tag":{
            "description":"Tag name of the fragment.",
            "type":"string"
        },
        "title":{
            "description":"Title of the fragment.",
            "type":"string"
        },
        "type":{
            "description":"Type of fragment.",
            "type":"string"
        },
        "previewText":{
            "description":"Preview of the fragment instance.",
            "type":"string"
        },
        "config":{
            "description":"Configuration object for fragment.",
            "type":"object"
        },
        "configOptions":{
            "description":"Array of configurable options.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : children

Type: array

Array of fragments.

Show Source

• Array of: object items

{
    "description":"Array of fragments.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "inline":{
                "description":"Whether inline or not.",
                "type":"boolean"
            },
            "customTitle":{
                "description":"Custom Title of the fragment.",
                "type":"string"
            },
            "text":{
                "description":"Text of the fragment.",
                "type":"string"
            },
            "tag":{
                "description":"Tag name of the fragment.",
                "type":"string"
            },
            "title":{
                "description":"Title of the fragment.",
                "type":"string"
            }
        }
    }
}

Nested Schema : config

Type: object

Configuration object for fragment.

Nested Schema : configOptions

Type: array

Array of configurable options.

Show Source

• Array of: string

{
    "description":"Array of configurable options.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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.

{
    "description":"Styles of fragment.",
    "type":"object",
    "properties":{
        "color":{
            "description":"Title of the fragment.",
            "type":"string"
        },
        "font-weight":{
            "description":"Title of the fragment.",
            "type":"string"
        },
        "text-decoration":{
            "description":"Title of the fragment.",
            "type":"string"
        },
        "display":{
            "description":"Title of the fragment.",
            "type":"string"
        },
        "font-family":{
            "description":"Title of the fragment.",
            "type":"string"
        },
        "font-style":{
            "description":"Title of the fragment.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "inline":{
            "description":"Whether inline or not.",
            "type":"boolean"
        },
        "customTitle":{
            "description":"Custom Title of the fragment.",
            "type":"string"
        },
        "text":{
            "description":"Text of the fragment.",
            "type":"string"
        },
        "tag":{
            "description":"Tag name of the fragment.",
            "type":"string"
        },
        "title":{
            "description":"Title of the fragment.",
            "type":"string"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top