Jump to

• Request
• Response
• Examples

Update a Type

put

/content/management/api/v1.1/types/{name}

Updates a type with the given payload.
If any fields of type are deleted or flagged as inherit from master in type update, all the items of the type will be updated and the deleted field and items data for the deleted fields will be archived.
Also, publish, copy, import of items of the type will not be allowed during type update while deleting fields or flagging the inherit from master field. If publish or import or copy of items of the type is underway then type update with fields delete or flagging the inherit from master will be blocked.
The property: 'caas-translations.file.inheritFromMaster' of DigitalAsset type cannot be changed if the type has assets.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  Type name identifier is case-sensitive and any special characters must be encoded

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

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Updates a type with the given information in the payload. The fields createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.

Root Schema : Type

Type: object

AggregatedType

Show Source

• allowedActions(optional): array allowedActions
  allowedActions on Type.
• allowedFileTypes(optional): array allowedFileTypes
  Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .
• apiName(optional): string
  API Name of the type.
• archivedFields(optional): object ItemSubResourceListTypeField
  Item SubResource.
• connectorInfos(optional): array connectorInfos
  connectorInfos on Type.
• createdBy(optional): string
  Created by
• createdDate(optional): object date
  date
• description(optional): string
  Description of the type.
• displayName(optional): string
  display name of the type. It is a required property in the get response whereas it is not required in the post/put request.
• fields(optional): array fields
  Fields used in the type.
• id(optional): string
  id of the type. It is a required property in the get response and put request whereas it is not required in the post request.
• inplacePreview(optional): object ItemSubResourceListInplacePreview
  Item SubResource.
• jobToken(optional): string
  job token of the background job updating the Type.
• layoutMapping(optional): object ItemSubResourceListLayoutMapping
  Item SubResource.
• links(optional): array links
• name(optional): string
  Name of the type. It is a required property in the get response and post/put request.
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  Type specific properties.
• relationships(optional): object ItemSubResourceTypeRelationships
  Item SubResource.
• requiredTaxonomies(optional): object ItemSubResourceListRequiredTaxonomy
  Item SubResource.
• roleName(optional): string
  Name of the user's role on the content type.
• typeCategory(optional): string
  Category of the type. The allowed values are [ContentType, DigitalAssetType]. It is a required property in the get response. It is optional in post request and defaults to ContentType. It is also optional in put request and is identified based on the typeName path param in URL.
• updatedBy(optional): string
  Updated by
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the type. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the type. It is a required property in the get response and post/put request."
        },
        "displayName":{
            "type":"string",
            "description":"display name of the type. It is a required property in the get response whereas it is not required in the post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the type."
        },
        "description":{
            "type":"string",
            "description":"Description of the type."
        },
        "typeCategory":{
            "type":"string",
            "description":"Category of the type. The allowed values are [ContentType, DigitalAssetType]. It is a required property in the get response. It is optional in post request and defaults to ContentType. It is also optional in put request and is identified based on the typeName path param in URL."
        },
        "createdBy":{
            "type":"string",
            "description":"Created by"
        },
        "createdDate":{
            "description":"date and time Type createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by"
        },
        "updatedDate":{
            "description":"date and time Type updatedAt.",
            "$ref":"#/definitions/date"
        },
        "fields":{
            "type":"array",
            "description":"Fields used in the type.",
            "items":{
                "$ref":"#/definitions/TypeField"
            }
        },
        "properties":{
            "type":"object",
            "description":"Type specific properties.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "allowedFileTypes":{
            "type":"array",
            "description":"Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the content type."
        },
        "layoutMapping":{
            "$ref":"#/definitions/ItemSubResourceListLayoutMapping"
        },
        "inplacePreview":{
            "$ref":"#/definitions/ItemSubResourceListInplacePreview"
        },
        "requiredTaxonomies":{
            "$ref":"#/definitions/ItemSubResourceListRequiredTaxonomy"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "allowedActions":{
            "type":"array",
            "description":"allowedActions on Type.",
            "items":{
                "type":"string",
                "enum":[
                    "preview",
                    "read",
                    "write",
                    "update",
                    "delete"
                ]
            }
        },
        "connectorInfos":{
            "type":"array",
            "description":"connectorInfos on Type.",
            "items":{
                "$ref":"#/definitions/ConnectorInfo"
            }
        },
        "archivedFields":{
            "$ref":"#/definitions/ItemSubResourceListTypeField"
        },
        "relationships":{
            "$ref":"#/definitions/ItemSubResourceTypeRelationships"
        },
        "jobToken":{
            "type":"string",
            "description":"job token of the background job updating the Type."
        }
    },
    "description":"AggregatedType"
}

Nested Schema : allowedActions

Type: array

allowedActions on Type.

Show Source

• Array of: string
  Allowed Values: [ "preview", "read", "write", "update", "delete" ]

{
    "type":"array",
    "description":"allowedActions on Type.",
    "items":{
        "type":"string",
        "enum":[
            "preview",
            "read",
            "write",
            "update",
            "delete"
        ]
    }
}

Nested Schema : allowedFileTypes

Type: array

Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .

Show Source

• Array of: string

{
    "type":"array",
    "description":"Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .",
    "items":{
        "type":"string"
    }
}

Nested Schema : ItemSubResourceListTypeField

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TypeField"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : connectorInfos

Type: array

connectorInfos on Type.

Show Source

• Array of: object ConnectorInfo
  ConnectorInfo

{
    "type":"array",
    "description":"connectorInfos on Type.",
    "items":{
        "$ref":"#/definitions/ConnectorInfo"
    }
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : fields

Type: array

Fields used in the type.

Show Source

• Array of: object TypeField
  FieldInAggrType.

{
    "type":"array",
    "description":"Fields used in the type.",
    "items":{
        "$ref":"#/definitions/TypeField"
    }
}

Nested Schema : ItemSubResourceListInplacePreview

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InplacePreview"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListLayoutMapping

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutMapping"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Type specific properties.",
    "additionalProperties":{
        "type":"object"
    }
}

Type specific properties.

Nested Schema : ItemSubResourceTypeRelationships

Type: object

Item SubResource.

Show Source

• data(optional): object TypeRelationships
  Type Relationships
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/TypeRelationships"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListRequiredTaxonomy

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RequiredTaxonomy"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : data

Type: array

Show Source

• Array of: object TypeField
  FieldInAggrType.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TypeField"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : TypeField

Type: object

FieldInAggrType.

Show Source

• apiName(optional): string
  API Name of the field.
• archivedBy(optional): string
  Archived by.
• archivedDate(optional): object date
  date
• datatype(optional): string
  Allowed Values: [ "number", "long", "decimal", "text", "largetext", "reference", "datetime", "boolean" ]

  Data Type Enum. It is a required property in the get response and post/put request.
• defaultValue(optional): object defaultValue
  defaultValue for field.
• description(optional): string
  Description of the field.
• id(optional): string
  id of the field. It is a required property in the get response and put request whereas it is not required in the post request.
• isSystemField(optional): boolean
  Is the field provided by the system.
• name(optional): string
  name of the field. It is a required property in the get response and post/put request.
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  Field specific properties. The field publishingDependency is specific for media and reference.
• required(optional): boolean
  Required or optional value for the Field. It is a required property in the get response and post/put request.
• settings(optional): object settings
  Additional Properties Allowed: additionalProperties

  Field specific settings.
• valuecount(optional): string
  Allowed Values: [ "single", "list" ]

  Value count as a single or list. It is a required property in the get response and post/put request.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the field. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"name of the field. It is a required property in the get response and post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the field."
        },
        "description":{
            "type":"string",
            "description":"Description of the field."
        },
        "datatype":{
            "type":"string",
            "description":"Data Type Enum. It is a required property in the get response and post/put request.",
            "enum":[
                "number",
                "long",
                "decimal",
                "text",
                "largetext",
                "reference",
                "datetime",
                "boolean"
            ]
        },
        "required":{
            "type":"boolean",
            "description":"Required or optional value for the Field. It is a required property in the get response and post/put request."
        },
        "valuecount":{
            "type":"string",
            "description":"Value count as a single or list. It is a required property in the get response and post/put request.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValue":{
            "type":"object",
            "description":"defaultValue for field."
        },
        "isSystemField":{
            "type":"boolean",
            "description":"Is the field provided by the system."
        },
        "properties":{
            "type":"object",
            "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
            "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "settings":{
            "type":"object",
            "description":"Field specific settings.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "archivedBy":{
            "type":"string",
            "description":"Archived by."
        },
        "archivedDate":{
            "description":"date and time Field archivedAt",
            "$ref":"#/definitions/date"
        }
    },
    "description":"FieldInAggrType."
}

Nested Schema : defaultValue

Type: object

defaultValue for field.

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
    "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
    "additionalProperties":{
        "type":"object"
    }
}

Field specific properties. The field publishingDependency is specific for media and reference.

Example:

{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}

Nested Schema : settings

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Field specific settings.",
    "additionalProperties":{
        "type":"object"
    }
}

Field specific settings.

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

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."
}

Nested Schema : ConnectorInfo

Type: object

ConnectorInfo

Show Source

• connectorId(optional): string
  id of the connector.
• connectorSyncEnabled(optional): boolean
  Sync status of connector.

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"id of the connector."
        },
        "connectorSyncEnabled":{
            "type":"boolean",
            "description":"Sync status of connector."
        }
    },
    "description":"ConnectorInfo"
}

Nested Schema : data

Type: array

Show Source

• Array of: object InplacePreview
  InplacePreview

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/InplacePreview"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : InplacePreview

Type: object

InplacePreview

Show Source

• isSiteExternal(optional): boolean
• pageId(optional): string
• pageName(optional): string
• pageUrl(optional): string
• siteId(optional): string
• siteName(optional): string
• typeId(optional): string

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "pageId":{
            "type":"string"
        },
        "isSiteExternal":{
            "type":"boolean"
        },
        "siteName":{
            "type":"string"
        },
        "pageName":{
            "type":"string"
        },
        "pageUrl":{
            "type":"string"
        }
    },
    "description":"InplacePreview"
}

Nested Schema : data

Type: array

Show Source

• Array of: object LayoutMapping
  LayoutMapping

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LayoutMapping"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : LayoutMapping

Type: object

LayoutMapping

Show Source

• apiName(optional): string
  Name of the layout.
• formats(optional): object formats
  Additional Properties Allowed: additionalProperties

  layout formats.
• generateRendition(optional): boolean
  generateRendition.
• id(optional): integer(int64)
  Id of the layout mapping.
• label(optional): string
  Name of the category for layout mapping.

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Name of the category for layout mapping."
        },
        "apiName":{
            "type":"string",
            "description":"Name of the layout."
        },
        "formats":{
            "type":"object",
            "description":"layout formats.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "generateRendition":{
            "type":"boolean",
            "description":"generateRendition."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Id of the layout mapping."
        }
    },
    "description":"LayoutMapping"
}

Nested Schema : formats

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"layout formats.",
    "additionalProperties":{
        "type":"string"
    }
}

layout formats.

Nested Schema : additionalProperties

Type: object

Nested Schema : TypeRelationships

Type: object

Type Relationships

Show Source

• references(optional): array references
  Unique Items Required: true

  Reference type names/ids

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference type names/ids",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/TypeReferences"
            }
        }
    },
    "description":"Type Relationships"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : references

Type: array

Unique Items Required: true

Reference type names/ids

Show Source

• Array of: object TypeReferences
  Type References bean

{
    "type":"array",
    "description":"Reference type names/ids",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/TypeReferences"
    }
}

Nested Schema : TypeReferences

Type: object

Type References bean

Show Source

• id(optional): string
  id of the type
• links(optional): array links
• name(optional): string
  name of the type

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the type"
        },
        "name":{
            "type":"string",
            "description":"name of the type"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Type References bean"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : data

Type: array

Show Source

• Array of: object RequiredTaxonomy

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RequiredTaxonomy"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : RequiredTaxonomy

Type: object

Show Source

• defaultCategories(optional): array defaultCategories
• description(optional): string
  Read Only: true
• id(optional): string
• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "defaultCategories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Category"
            }
        }
    }
}

Nested Schema : defaultCategories

Type: array

Show Source

• Array of: object Category

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Category"
    }
}

Nested Schema : Category

Type: object

Show Source

• apiName(optional): string
  Read Only: true
• id(optional): string
• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "apiName":{
            "type":"string",
            "readOnly":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Type

Type: object

AggregatedType

Show Source

• allowedActions(optional): array allowedActions
  allowedActions on Type.
• allowedFileTypes(optional): array allowedFileTypes
  Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .
• apiName(optional): string
  API Name of the type.
• archivedFields(optional): object ItemSubResourceListTypeField
  Item SubResource.
• connectorInfos(optional): array connectorInfos
  connectorInfos on Type.
• createdBy(optional): string
  Created by
• createdDate(optional): object date
  date
• description(optional): string
  Description of the type.
• displayName(optional): string
  display name of the type. It is a required property in the get response whereas it is not required in the post/put request.
• fields(optional): array fields
  Fields used in the type.
• id(optional): string
  id of the type. It is a required property in the get response and put request whereas it is not required in the post request.
• inplacePreview(optional): object ItemSubResourceListInplacePreview
  Item SubResource.
• jobToken(optional): string
  job token of the background job updating the Type.
• layoutMapping(optional): object ItemSubResourceListLayoutMapping
  Item SubResource.
• links(optional): array links
• name(optional): string
  Name of the type. It is a required property in the get response and post/put request.
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  Type specific properties.
• relationships(optional): object ItemSubResourceTypeRelationships
  Item SubResource.
• requiredTaxonomies(optional): object ItemSubResourceListRequiredTaxonomy
  Item SubResource.
• roleName(optional): string
  Name of the user's role on the content type.
• typeCategory(optional): string
  Category of the type. The allowed values are [ContentType, DigitalAssetType]. It is a required property in the get response. It is optional in post request and defaults to ContentType. It is also optional in put request and is identified based on the typeName path param in URL.
• updatedBy(optional): string
  Updated by
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the type. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the type. It is a required property in the get response and post/put request."
        },
        "displayName":{
            "type":"string",
            "description":"display name of the type. It is a required property in the get response whereas it is not required in the post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the type."
        },
        "description":{
            "type":"string",
            "description":"Description of the type."
        },
        "typeCategory":{
            "type":"string",
            "description":"Category of the type. The allowed values are [ContentType, DigitalAssetType]. It is a required property in the get response. It is optional in post request and defaults to ContentType. It is also optional in put request and is identified based on the typeName path param in URL."
        },
        "createdBy":{
            "type":"string",
            "description":"Created by"
        },
        "createdDate":{
            "description":"date and time Type createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by"
        },
        "updatedDate":{
            "description":"date and time Type updatedAt.",
            "$ref":"#/definitions/date"
        },
        "fields":{
            "type":"array",
            "description":"Fields used in the type.",
            "items":{
                "$ref":"#/definitions/TypeField"
            }
        },
        "properties":{
            "type":"object",
            "description":"Type specific properties.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "allowedFileTypes":{
            "type":"array",
            "description":"Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the content type."
        },
        "layoutMapping":{
            "$ref":"#/definitions/ItemSubResourceListLayoutMapping"
        },
        "inplacePreview":{
            "$ref":"#/definitions/ItemSubResourceListInplacePreview"
        },
        "requiredTaxonomies":{
            "$ref":"#/definitions/ItemSubResourceListRequiredTaxonomy"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "allowedActions":{
            "type":"array",
            "description":"allowedActions on Type.",
            "items":{
                "type":"string",
                "enum":[
                    "preview",
                    "read",
                    "write",
                    "update",
                    "delete"
                ]
            }
        },
        "connectorInfos":{
            "type":"array",
            "description":"connectorInfos on Type.",
            "items":{
                "$ref":"#/definitions/ConnectorInfo"
            }
        },
        "archivedFields":{
            "$ref":"#/definitions/ItemSubResourceListTypeField"
        },
        "relationships":{
            "$ref":"#/definitions/ItemSubResourceTypeRelationships"
        },
        "jobToken":{
            "type":"string",
            "description":"job token of the background job updating the Type."
        }
    },
    "description":"AggregatedType"
}

Nested Schema : allowedActions

Type: array

allowedActions on Type.

Show Source

• Array of: string
  Allowed Values: [ "preview", "read", "write", "update", "delete" ]

{
    "type":"array",
    "description":"allowedActions on Type.",
    "items":{
        "type":"string",
        "enum":[
            "preview",
            "read",
            "write",
            "update",
            "delete"
        ]
    }
}

Nested Schema : allowedFileTypes

Type: array

Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .

Show Source

• Array of: string

{
    "type":"array",
    "description":"Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .",
    "items":{
        "type":"string"
    }
}

Nested Schema : ItemSubResourceListTypeField

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TypeField"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : connectorInfos

Type: array

connectorInfos on Type.

Show Source

• Array of: object ConnectorInfo
  ConnectorInfo

{
    "type":"array",
    "description":"connectorInfos on Type.",
    "items":{
        "$ref":"#/definitions/ConnectorInfo"
    }
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : fields

Type: array

Fields used in the type.

Show Source

• Array of: object TypeField
  FieldInAggrType.

{
    "type":"array",
    "description":"Fields used in the type.",
    "items":{
        "$ref":"#/definitions/TypeField"
    }
}

Nested Schema : ItemSubResourceListInplacePreview

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InplacePreview"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListLayoutMapping

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutMapping"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Type specific properties.",
    "additionalProperties":{
        "type":"object"
    }
}

Type specific properties.

Nested Schema : ItemSubResourceTypeRelationships

Type: object

Item SubResource.

Show Source

• data(optional): object TypeRelationships
  Type Relationships
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/TypeRelationships"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListRequiredTaxonomy

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RequiredTaxonomy"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : data

Type: array

Show Source

• Array of: object TypeField
  FieldInAggrType.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TypeField"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : TypeField

Type: object

FieldInAggrType.

Show Source

• apiName(optional): string
  API Name of the field.
• archivedBy(optional): string
  Archived by.
• archivedDate(optional): object date
  date
• datatype(optional): string
  Allowed Values: [ "number", "long", "decimal", "text", "largetext", "reference", "datetime", "boolean" ]

  Data Type Enum. It is a required property in the get response and post/put request.
• defaultValue(optional): object defaultValue
  defaultValue for field.
• description(optional): string
  Description of the field.
• id(optional): string
  id of the field. It is a required property in the get response and put request whereas it is not required in the post request.
• isSystemField(optional): boolean
  Is the field provided by the system.
• name(optional): string
  name of the field. It is a required property in the get response and post/put request.
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  Field specific properties. The field publishingDependency is specific for media and reference.
• required(optional): boolean
  Required or optional value for the Field. It is a required property in the get response and post/put request.
• settings(optional): object settings
  Additional Properties Allowed: additionalProperties

  Field specific settings.
• valuecount(optional): string
  Allowed Values: [ "single", "list" ]

  Value count as a single or list. It is a required property in the get response and post/put request.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the field. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"name of the field. It is a required property in the get response and post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the field."
        },
        "description":{
            "type":"string",
            "description":"Description of the field."
        },
        "datatype":{
            "type":"string",
            "description":"Data Type Enum. It is a required property in the get response and post/put request.",
            "enum":[
                "number",
                "long",
                "decimal",
                "text",
                "largetext",
                "reference",
                "datetime",
                "boolean"
            ]
        },
        "required":{
            "type":"boolean",
            "description":"Required or optional value for the Field. It is a required property in the get response and post/put request."
        },
        "valuecount":{
            "type":"string",
            "description":"Value count as a single or list. It is a required property in the get response and post/put request.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValue":{
            "type":"object",
            "description":"defaultValue for field."
        },
        "isSystemField":{
            "type":"boolean",
            "description":"Is the field provided by the system."
        },
        "properties":{
            "type":"object",
            "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
            "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "settings":{
            "type":"object",
            "description":"Field specific settings.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "archivedBy":{
            "type":"string",
            "description":"Archived by."
        },
        "archivedDate":{
            "description":"date and time Field archivedAt",
            "$ref":"#/definitions/date"
        }
    },
    "description":"FieldInAggrType."
}

Nested Schema : defaultValue

Type: object

defaultValue for field.

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
    "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
    "additionalProperties":{
        "type":"object"
    }
}

Field specific properties. The field publishingDependency is specific for media and reference.

Example:

{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}

Nested Schema : settings

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Field specific settings.",
    "additionalProperties":{
        "type":"object"
    }
}

Field specific settings.

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

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."
}

Nested Schema : ConnectorInfo

Type: object

ConnectorInfo

Show Source

• connectorId(optional): string
  id of the connector.
• connectorSyncEnabled(optional): boolean
  Sync status of connector.

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"id of the connector."
        },
        "connectorSyncEnabled":{
            "type":"boolean",
            "description":"Sync status of connector."
        }
    },
    "description":"ConnectorInfo"
}

Nested Schema : data

Type: array

Show Source

• Array of: object InplacePreview
  InplacePreview

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/InplacePreview"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : InplacePreview

Type: object

InplacePreview

Show Source

• isSiteExternal(optional): boolean
• pageId(optional): string
• pageName(optional): string
• pageUrl(optional): string
• siteId(optional): string
• siteName(optional): string
• typeId(optional): string

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "pageId":{
            "type":"string"
        },
        "isSiteExternal":{
            "type":"boolean"
        },
        "siteName":{
            "type":"string"
        },
        "pageName":{
            "type":"string"
        },
        "pageUrl":{
            "type":"string"
        }
    },
    "description":"InplacePreview"
}

Nested Schema : data

Type: array

Show Source

• Array of: object LayoutMapping
  LayoutMapping

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LayoutMapping"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : LayoutMapping

Type: object

LayoutMapping

Show Source

• apiName(optional): string
  Name of the layout.
• formats(optional): object formats
  Additional Properties Allowed: additionalProperties

  layout formats.
• generateRendition(optional): boolean
  generateRendition.
• id(optional): integer(int64)
  Id of the layout mapping.
• label(optional): string
  Name of the category for layout mapping.

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Name of the category for layout mapping."
        },
        "apiName":{
            "type":"string",
            "description":"Name of the layout."
        },
        "formats":{
            "type":"object",
            "description":"layout formats.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "generateRendition":{
            "type":"boolean",
            "description":"generateRendition."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Id of the layout mapping."
        }
    },
    "description":"LayoutMapping"
}

Nested Schema : formats

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"layout formats.",
    "additionalProperties":{
        "type":"string"
    }
}

layout formats.

Nested Schema : additionalProperties

Type: object

Nested Schema : TypeRelationships

Type: object

Type Relationships

Show Source

• references(optional): array references
  Unique Items Required: true

  Reference type names/ids

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference type names/ids",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/TypeReferences"
            }
        }
    },
    "description":"Type Relationships"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : references

Type: array

Unique Items Required: true

Reference type names/ids

Show Source

• Array of: object TypeReferences
  Type References bean

{
    "type":"array",
    "description":"Reference type names/ids",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/TypeReferences"
    }
}

Nested Schema : TypeReferences

Type: object

Type References bean

Show Source

• id(optional): string
  id of the type
• links(optional): array links
• name(optional): string
  name of the type

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the type"
        },
        "name":{
            "type":"string",
            "description":"name of the type"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Type References bean"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : data

Type: array

Show Source

• Array of: object RequiredTaxonomy

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RequiredTaxonomy"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : RequiredTaxonomy

Type: object

Show Source

• defaultCategories(optional): array defaultCategories
• description(optional): string
  Read Only: true
• id(optional): string
• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "defaultCategories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Category"
            }
        }
    }
}

Nested Schema : defaultCategories

Type: array

Show Source

• Array of: object Category

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Category"
    }
}

Nested Schema : Category

Type: object

Show Source

• apiName(optional): string
  Read Only: true
• id(optional): string
• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "apiName":{
            "type":"string",
            "readOnly":true
        }
    }
}

202 Response

Accepted.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

409 Response

Conflict.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to update a field by submitting a PUT request on a REST resource using cURL.

curl -X PUT -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/types/{name}'

Example 1:

This updates existing type Book with a required field to an optional field. Replace payload with your own data.

/content/management/api/v1.1/types/Book

Request Body

{
    "name": "Book",
    "description": "Description of the book",
    "fields": [
    {
      "name": "volume",
      "description": "Number Field",
      "datatype": "number",
      "required": false,
      "valuecount": "single"
    }
    ]
    }

Example 2:

This updates an existing type typeName by adding a new optional field. Replace payload with your own data.

/content/management/api/v1.1/types/typeName

Request Body

{
        "name": "Book",
        "description": "some decription for Book",
        "typeCategory": "ContentType",
        "fields": [
          {
            "name": "volume",
            "description": "Text field",
            "datatype": "largetext",
            "required": false,
            "valuecount": "single"
          },
          {
            "name": "abstract",
            "description": "Text field",
            "datatype": "largetext",
            "required": false,
            "valuecount": "single"
          }
        ]
      }

Example 3:

This updates the publishingDependency from optional to required for an existing type with a reference. Replace payload with your own data.

/content/management/api/v1.1/types/referenceType-pubDep-required

Request Body

{
        "name": "referenceType-pubDep-required",
        "description": "referenceType-pubDep-required description",
        "fields": [
          {
            "name": "media",
            "apiName": "media",
            "datatype": "reference",
            "required": true,
            "valuecount": "single",
            "properties": {
              "publishingDependency": "optional"
            }
          }
        ]
      }

Example 4:

This updates an existing type typeName having content items by deleting fields. Replace payload with your own data. There will be no response body and response headers will contain status link of the async type update job.

/content/management/api/v1.1/types/typeName

Request Body

{
        "name": "typeName",
        "description": "some decription for typeName",
        "fields": [
          {
            "name": "volume",
            "description": "Text field",
            "datatype": "largetext",
            "required": false,
            "valuecount": "single"
          }
        ]
      }

Example 5:

This updates an existing Digital Asset type Book which doesn't have any assets by flipping the property 'properties.caas-translations.file.inheritFromMaster' from true to false thus converting type file shared to non-file shared type. Replace payload with your own data.

/content/management/api/v1.1/types/typeName

Request Payload

{
        "name": "Book",
        "description": "some decription for Book",
        "displayName": "BookDisplayName",
        "typeCategory": "DigitalAssetType",
        "fields": [
          {
            "name": "volume",
            "description": "Text field",
            "datatype": "largetext",
            "required": false,
            "valuecount": "single"
          }
        ],
        "caas-translations": {
          "description": {
            "inheritFromMaster": false,
            "note": "",
            "translate": true
          },
          "file": {
            "inheritFromMaster": false,
            "note": "",
            "translate": true
          },
          "name": {
            "inheritFromMaster": false,
            "note": "",
            "translate": true
          },
          "slug": {
            "inheritFromMaster": false,
            "note": "",
            "translate": true
          }
        }
      }

Request Headers

{
        "Content-Type": "application/json",
        "X-Requested-With": "XMLHttpRequest"
 }

Back to Top