Jump to

• Request
• Response

listCECContent

get

/ccstore/v1/cecContent

Retrieve list of CEC Content Items, cross referenced with matching CMS Content Map items

Request

Supported Media Types

• application/json

Query Parameters

• limit: string
  Allow Empty value: true

  Maximum number of rows to return.
• offset: string
  Allow Empty value: true

  Starting row to return.
• q: string
  Allow Empty value: true

  Search term for the list.
• sort: string
  Allow Empty value: true

  Sort criteria for list.

Back to Top

Response

Supported Media Types

• application/json

200 Response

An array of JSON objects is returned that represents the list of CEC Content Items.

Body ()

Root Schema : listCECContent_response

Type: object

Show Source

• items(optional): string
  list of items retrieved

{
    "properties":{
        "items":{
            "description":"list of items retrieved",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "createdDate":{
        },
        "publishInfo":[
            {
                "publishedDate":{
                },
                "version":"string",
                "target":"string"
            }
        ],
        "name":"string",
        "description":"string",
        "language":{
        },
        "links":[
            {
                "templated":true,
                "method":"string",
                "profile":"string",
                "rel":"string",
                "mediaType":"string",
                "href":"string"
            }
        ],
        "id":"string",
        "updatedDate":{
        },
        "type":"string",
        "fields":{
            "additionalProp1":{
            },
            "additionalProp3":{
            },
            "additionalProp2":{
            }
        },
        "slug":{
        }
    }
]

400 Response

Error returned when user provides invalid input for parameters.

Body ()

Root Schema : listCECContent_invalidParameterValueResponse

Type: object

Show Source

• errorCode(optional): string
  Default Value: 10002

  The internal error code
• message(optional): string
  Default Value: The value 'empty' for parameter 'limit' is invalid

  The HTTP error message
• status(optional): string
  Default Value: 400

  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "default":"10002",
            "description":"The internal error code",
            "type":"string"
        },
        "message":{
            "default":"The value 'empty' for parameter 'limit' is invalid",
            "description":"The HTTP error message",
            "type":"string"
        },
        "status":{
            "default":"400",
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":10002,
    "message":"The value 'empty' for parameter 'limit' is invalid",
    "status":400
}

409 Response

Error returned when user has not enabled CEC Integration.

Body ()

Root Schema : listCECContent_integrationDisabledResponse

Type: object

Show Source

• errorCode(optional): string
  Default Value: 00000000

  The internal error code
• message(optional): string
  Default Value: CEC Integration is not enabled

  The HTTP error message
• status(optional): string
  Default Value: 409

  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "default":"00000000",
            "description":"The internal error code",
            "type":"string"
        },
        "message":{
            "default":"CEC Integration is not enabled",
            "description":"The HTTP error message",
            "type":"string"
        },
        "status":{
            "default":"409",
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":0,
    "message":"CEC Integration is not enabled",
    "status":409
}

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