Jump to

• Request
• Response

getThemes

get

/ccadmin/v1/themes

Get Themes. Returns a list of themes currently in the repository. Pass in query param ?type=custom to get all custom themes, or ?type=purchased to get all purchased themes. Omit type query param to get all themes.

Request

Supported Media Types

• application/json

Query Parameters

• includeagenttheme(optional): boolean
  include the agent theme in the results
• type(optional): string
  one of custom, purchased or null

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getThemes_response

Type: object

Show Source

• items(optional): array items
  The list of all themes.

{
    "properties":{
        "items":{
            "description":"The list of all themes.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "thumbnail":{
                        "description":"Thumbnail image of the theme.",
                        "type":"string"
                    },
                    "is_active":{
                        "description":"Whether theme is active.",
                        "type":"boolean"
                    },
                    "notes":{
                        "description":"Notes of the theme.",
                        "type":"string"
                    },
                    "usingCodeView":{
                        "description":"Whether using code view or not.",
                        "type":"boolean"
                    },
                    "clone_parent_name":{
                        "description":"Clone parent name of the theme.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Theme name.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository Id of the theme.",
                        "type":"string"
                    },
                    "is_custom":{
                        "description":"Whether theme is custom or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of the theme.",
                        "type":"string"
                    },
                    "clone_parent_id":{
                        "description":"Clone parent id of the theme.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all themes.

Show Source

• Array of: object items

{
    "description":"The list of all themes.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "thumbnail":{
                "description":"Thumbnail image of the theme.",
                "type":"string"
            },
            "is_active":{
                "description":"Whether theme is active.",
                "type":"boolean"
            },
            "notes":{
                "description":"Notes of the theme.",
                "type":"string"
            },
            "usingCodeView":{
                "description":"Whether using code view or not.",
                "type":"boolean"
            },
            "clone_parent_name":{
                "description":"Clone parent name of the theme.",
                "type":"string"
            },
            "name":{
                "description":"Theme name.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository Id of the theme.",
                "type":"string"
            },
            "is_custom":{
                "description":"Whether theme is custom or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of the theme.",
                "type":"string"
            },
            "clone_parent_id":{
                "description":"Clone parent id of the theme.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• clone_parent_id(optional): string
  Clone parent id of the theme.
• clone_parent_name(optional): string
  Clone parent name of the theme.
• id(optional): string
  ID of the theme.
• is_active(optional): boolean
  Whether theme is active.
• is_custom(optional): boolean
  Whether theme is custom or not.
• name(optional): string
  Theme name.
• notes(optional): string
  Notes of the theme.
• repositoryId(optional): string
  Repository Id of the theme.
• thumbnail(optional): string
  Thumbnail image of the theme.
• usingCodeView(optional): boolean
  Whether using code view or not.

{
    "type":"object",
    "properties":{
        "thumbnail":{
            "description":"Thumbnail image of the theme.",
            "type":"string"
        },
        "is_active":{
            "description":"Whether theme is active.",
            "type":"boolean"
        },
        "notes":{
            "description":"Notes of the theme.",
            "type":"string"
        },
        "usingCodeView":{
            "description":"Whether using code view or not.",
            "type":"boolean"
        },
        "clone_parent_name":{
            "description":"Clone parent name of the theme.",
            "type":"string"
        },
        "name":{
            "description":"Theme name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository Id of the theme.",
            "type":"string"
        },
        "is_custom":{
            "description":"Whether theme is custom or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of the theme.",
            "type":"string"
        },
        "clone_parent_id":{
            "description":"Clone parent id of the theme.",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "thumbnail":"/img/cloudlake.jpg",
        "is_active":true,
        "notes":"This is the Cloud Lake Theme.",
        "clone_parent_name":null,
        "name":"Cloud Lake Theme",
        "repositoryId":"100001",
        "is_custom":false,
        "id":"100001",
        "clone_parent_id":null
    },
    {
        "thumbnail":"",
        "is_active":false,
        "notes":"This is the Dark Theme.",
        "clone_parent_name":"Cloud Lake Theme",
        "name":"Dark Theme",
        "repositoryId":"100002",
        "is_custom":true,
        "id":"100002",
        "clone_parent_id":"100001"
    }
]

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