Jump to

• Request
• Response

Retrieve list of OCE (CEC) Content Items

get

/ccadmin/v1/cecContentType

Retrieve details for an OCE content type

Request

Supported Media Types

• application/json

Path Parameters

• contentType(required): string
  Content Type to Request

Body ()

Root Schema : getCECContentType_request

Show Source

{
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON Object representing the definition of an OCE Content Type.

Body ()

Root Schema : getCECContentType_response

Type: object

Show Source

• createdBy: string
  User who created the content type
• createdDate: object oce_dateType
• description: string
  Description of the content type
• fields: array fields
  Field within the content type
• id: string
  Unique OCE ID for this content type
• name: string
  Name for the content type
• updatedBy: string
  User who updated the content type
• updatedDate: object oce_dateType

{
    "properties":{
        "createdDate":{
            "description":"Date the content type was created",
            "$ref":"#/definitions/oce_dateType"
        },
        "updatedBy":{
            "description":"User who updated the content type",
            "type":"string"
        },
        "createdBy":{
            "description":"User who created the content type",
            "type":"string"
        },
        "name":{
            "description":"Name for the content type",
            "type":"string"
        },
        "description":{
            "description":"Description of the content type",
            "type":"string"
        },
        "id":{
            "description":"Unique OCE ID for this content type",
            "type":"string"
        },
        "updatedDate":{
            "description":"Date the content type was last updated",
            "$ref":"#/definitions/oce_dateType"
        },
        "fields":{
            "description":"Field within the content type",
            "type":"array",
            "items":{
                "$ref":"#/definitions/oce_fieldType"
            }
        }
    }
}

Nested Schema : oce_dateType

Type: object

Show Source

• timezone: string
  Timezone for the date
• value: string
  Date value

{
    "type":"object",
    "properties":{
        "timezone":{
            "description":"Timezone for the date",
            "type":"string"
        },
        "value":{
            "description":"Date value",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: array

Field within the content type

Show Source

• Array of: object oce_fieldType

{
    "description":"Field within the content type",
    "type":"array",
    "items":{
        "$ref":"#/definitions/oce_fieldType"
    }
}

Nested Schema : oce_fieldType

Type: object

Show Source

• datatype: string
  Data type of the field
• description: string
  Description of the field
• id: string
  Unique ID for the field
• name: string
  Name of the field
• properties: object properties
  Additional properties for the field
• required: boolean
  Is the field required
• settings: object settings
  Settings the field
• valuecount: string
  Value Count

{
    "type":"object",
    "properties":{
        "settings":{
            "description":"Settings the field",
            "type":"object"
        },
        "datatype":{
            "description":"Data type of the field",
            "type":"string"
        },
        "name":{
            "description":"Name of the field",
            "type":"string"
        },
        "description":{
            "description":"Description of the field",
            "type":"string"
        },
        "id":{
            "description":"Unique ID for the field",
            "type":"string"
        },
        "required":{
            "description":"Is the field required",
            "type":"boolean"
        },
        "valuecount":{
            "description":"Value Count",
            "type":"string"
        },
        "properties":{
            "description":"Additional properties for the field",
            "type":"object"
        }
    }
}

Nested Schema : properties

Type: object

Additional properties for the field

Nested Schema : settings

Type: object

Settings the field

Example Response (application/json)

[
    {
        "createdDate":"oce_dateType",
        "updatedBy":"string",
        "createdBy":"string",
        "name":"string",
        "description":"string",
        "id":"string",
        "updatedDate":"oce_dateType",
        "fields":[
            {
                "settings":{
                },
                "datatype":"string",
                "name":"string",
                "description":"string",
                "id":"string",
                "required":"boolean",
                "valuecount":"string",
                "properties":{
                }
            }
        ]
    }
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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