REST API for Content Management

List All Data Types

get

/content/management/api/v1.1/dataTypes

List information of all the data types.

Request

Query Parameters

links(optional): string

This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : DataTypes

Type: object

DataTypes

Show Source

dataTypes(optional): array dataTypes

dataTypes. List
links(optional): array links

Links

{
    "type":"object",
    "properties":{
        "dataTypes":{
            "type":"array",
            "description":"dataTypes. List<DataTypeBean>",
            "items":{
                "$ref":"#/definitions/DataType"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"DataTypes"
}

Nested Schema : dataTypes

Type: array

dataTypes. List

Show Source

Array of: object DataType

DataType

{
    "type":"array",
    "description":"dataTypes. List<DataTypeBean>",
    "items":{
        "$ref":"#/definitions/DataType"
    }
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : DataType

Type: object

DataType

Show Source

datatype(optional): string
description(optional): string

{
    "type":"object",
    "properties":{
        "datatype":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "description":"DataType"
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

href(optional): string

The target resource's URI. It could be template URI. It is a required property in the get response.
mediaType(optional): string

Media type.
method(optional): string

What HTTP method can be used to access the target resource.
profile(optional): string

Link to the metadata that describes the target resource.
rel(optional): string

Relation type. It is a required property in the get response.
templated(optional): boolean

Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Examples

The following example shows how to get all the types by submission of a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/dataTypes'

Example:

This lists all the DataTypes supported by system.

/content/management/api/v1.1/dataTypes

Response Body

{
    "dataTypes": [
    {
      "datatype": "text",
      "description": "Supports upto 2000 characters"
    },
    {
      "datatype": "largetext",
      "description": "Supports unlimited text"
    },
    {
      "datatype": "number",
      "description": "Supports Supports as signed Integer value with the range of -2,147,483,648 to 2,147,483,647"
    },
    {
      "datatype": "decimal",
      "description": "Supports float or decimal values with the range of approximately ??3.40282347E+38F (6-7 significant decimal digits)"
    },
    {
      "datatype": "boolean",
      "description": "Supports Boolean values of TRUE or FALSE, default value is FALSE for empty"
    },
    {
      "datatype": "reference",
      "description": "Supports the reference relationship to other Item(s)"
    },
    {
      "datatype": "datetime",
      "description": "Supports date and time values"
    },
    {
      "datatype": "location",
      "description": "Supports location data about geo location using longitude and latitude values"
    },
    {
      "datatype": "json",
      "description": "Supports the json type data"
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/dataTypes",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/dataTypes",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/metadata-catalog/dataTypes",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
    ]
    }