Jump to

• Request
• Response
• Examples

Update a taxonomy

put

/content/management/api/v1.1/taxonomies/{id}

with given payload. The field shortName must be unique and it will be auto-generated by the system if no value is provided.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  id of the taxonomy.

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
• q(optional): string
  This parameter accepts a query expression condition that matches the field values. Query conditions can be joined using AND operators and grouped with parentheses. The value of a query condition follows the format of {fieldName} {operator} "{fieldValue}". The only field names allowed are status, version, name, shortName, roleName and repositoryId. A query cannot include multiple status, version, name, shortName, roleName or repositoryId fieldNames. Both name and shortName cannot be specified in the same query.
  If no value is provided for status it defaults to "promoted". When listing taxonomies, status can be equal to "draft", "promoted" or "all". When listing taxonomies, roleName can be equal to "viewer", "editor" or "manager". If status is equals to "all", all taxonomies will be retrieved - if a taxonomy is currently available in both "draft" and "promoted" states, only "draft" will be returned. In case status equals to "all" is used in other endpoints, an error will be returned.
  The only value allowed in the operator is eq (Equals) for status, version, shortName, roleName and repositoryId.
  The only value allowed in the operator is co (Contains) for name.
  
  When updating a taxonomy the query parameter should always be provided with status set to "draft" as the default status is "promoted" and a promoted taxonomy cannot be modified.
  
  Example:
  https://{cecsdomain}/content/management/api/v1.1/taxonomies?q=(status eq "draft")
  Example:
  https://{cecsdomain}/content/management/api/v1.1/taxonomies?q=(status eq "promoted")

Header Parameters

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

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Update a taxonomy with the given information in the payload. The fields id, status, version, availableStates, publishedChannels, createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.

When the field shortName is updated, all apiName values currently prefixed with the taxonomy shortName will be automatically updated for the entire "draft" taxonomy.

Root Schema : Taxonomy

Type: object

Taxonomy

Show Source

• availableStates(optional): array availableStates
  List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.
• categoryProperties(optional): object ItemSubResourceListCategoryPropertyDefinition
  Item SubResource.
• createdBy(optional): string
  The user who created the Taxonomy.
• createdDate(optional): object date
  date
• customProperties(optional): object customProperties
  Additional Properties Allowed: additionalProperties

  Custom properties of the Taxonomy. This consists of a name value pairs defined by the user. Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.
• description(optional): string
  The description of the Taxonomy.
• id: string
  The id of the Taxonomy. This is a required property in the get response and ignored in post/put requests.
• isForSiteManagement(optional): boolean
  Whether taxonomy is for site management. A site management taxonomy is not publishable. (defaults to false)
• isPublishable(optional): boolean
  Whether taxonomy is publishable. (defaults to false)
• links(optional): array links
  Links
• name: string
  The name of the Taxonomy. It is a required property in the get response and cannot be empty in post/put request.
• publishedChannels(optional): array publishedChannels
  Read Only: true

  Taxonomy published channels.
• roleName(optional): string
  name of the role on the resource.
• shortName(optional): string
  The short name of the Taxonomy. This property is unique among all taxonomies and it is required in the get response. Up to 3 characters can be provided in a put/post request. If no value is provided, a default one will be generated.
• status(optional): string
  Allowed Values: [ "draft", "promoted" ]

  The status of the Taxonomy. This is a required property in the get response and ignored in post/put requests.
• updatedBy(optional): string
  The user who last updated the Taxonomy.
• updatedDate(optional): object date
  date
• version(optional): integer(int32)
  Minimum Value: 1

  The version of this Taxonomy. Version information is only returned for promoted taxonomies. It is ignored in post/put requests.

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Taxonomy. This is a required property in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Taxonomy. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the Taxonomy. This property is unique among all taxonomies and it is required in the get response. Up to 3 characters can be provided in a put/post request. If no value is provided, a default one will be generated."
        },
        "status":{
            "type":"string",
            "description":"The status of the Taxonomy. This is a required property in the get response and ignored in post/put requests.",
            "enum":[
                "draft",
                "promoted"
            ]
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"The version of this Taxonomy. Version information is only returned for promoted taxonomies. It is ignored in post/put requests.",
            "minimum":1
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Whether taxonomy is publishable. (defaults to false)"
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether taxonomy is for site management. A site management taxonomy is not publishable. (defaults to false)"
        },
        "availableStates":{
            "type":"array",
            "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
            "items":{
                "$ref":"#/definitions/TaxonomyStatus"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "publishedChannels":{
            "type":"array",
            "description":"Taxonomy published channels.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ChannelInTaxonomy"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the Taxonomy."
        },
        "createdDate":{
            "description":"The creation date of the Taxonomy.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the Taxonomy."
        },
        "updatedDate":{
            "description":"The date the Taxonomy was last updated.",
            "$ref":"#/definitions/date"
        },
        "categoryProperties":{
            "description":"The definition of category properties for this taxonomy. There are user defined properties and system defined properties such as synonyms, keywords and related categories. These properties are defined as a sub-resource of a single taxonomy and they cannot be expanded through read taxonomy API. They will be ignored by the server in POST and PUT requests. The sub-resource API contains additional information about parameters and available operations.",
            "$ref":"#/definitions/ItemSubResourceListCategoryPropertyDefinition"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        }
    },
    "description":"Taxonomy"
}

Nested Schema : availableStates

Type: array

List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.

Show Source

• Array of: object TaxonomyStatus
  TaxonomyStatus

{
    "type":"array",
    "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
    "items":{
        "$ref":"#/definitions/TaxonomyStatus"
    }
}

Nested Schema : ItemSubResourceListCategoryPropertyDefinition

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/CategoryPropertyDefinition"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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 : customProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
    "additionalProperties":{
        "type":"string"
    }
}

Custom properties of the Taxonomy. This consists of a name value pairs defined by the user. Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.

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 : publishedChannels

Type: array

Read Only: true

Taxonomy published channels.

Show Source

• Array of: object ChannelInTaxonomy
  ChannelInTaxonomy

{
    "type":"array",
    "description":"Taxonomy published channels.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/ChannelInTaxonomy"
    }
}

Nested Schema : TaxonomyStatus

Type: object

TaxonomyStatus

Show Source

• jobs(optional): array jobs
• published(optional): boolean
• status(optional): string
• version(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "published":{
            "type":"boolean"
        },
        "jobs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyJobInfo"
            }
        }
    },
    "description":"TaxonomyStatus"
}

Nested Schema : jobs

Type: array

Show Source

• Array of: object TaxonomyJobInfo
  TaxonomyJobInfo

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

Nested Schema : TaxonomyJobInfo

Type: object

TaxonomyJobInfo

Show Source

• errorDetails(optional): string
• id(optional): string
• status(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        }
    },
    "description":"TaxonomyJobInfo"
}

Nested Schema : data

Type: array

Show Source

• Array of: object CategoryPropertyDefinition
  Category Property Definition

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : CategoryPropertyDefinition

Type: object

Category Property Definition

Show Source

• apiName(optional): string
  Read Only: true

  Minimum Length: 1

  Maximum Length: 64

  API Name of the property.
• createdBy(optional): string
  Read Only: true

  The user who created the property.
• createdDate(optional): object date
  date
• defaultValues(optional): array defaultValues
  Default values for the property.
• description(optional): string
  Minimum Length: 0

  Maximum Length: 128

  Description of the property.
• displayName: string
  Minimum Length: 1

  Maximum Length: 128

  Display name of the property.
• id(optional): string
  Read Only: true

  id of the property. It is required in the GET response and PATCH request whereas it will be ignored in the POST request.
• isPublishable(optional): boolean
  Is the property publishable.
• isSystemManaged(optional): boolean
  Read Only: true

  Is the property managed by the system.
• links(optional): array links
  Links
• settings: object PropertySettingsBean
• updatedBy(optional): string
  Read Only: true

  The user who last updated the property.
• updatedDate(optional): object date
  date
• valueCount: string
  Allowed Values: [ "single", "list" ]

  Value count as a single or list.

{
    "type":"object",
    "required":[
        "displayName",
        "settings",
        "valueCount"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the property. It is required in the GET response and PATCH request whereas it will be ignored in the POST request.",
            "readOnly":true
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the property.",
            "readOnly":true,
            "minLength":1,
            "maxLength":64
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the property.",
            "minLength":1,
            "maxLength":128
        },
        "description":{
            "type":"string",
            "description":"Description of the property.",
            "minLength":0,
            "maxLength":128
        },
        "isSystemManaged":{
            "type":"boolean",
            "description":"Is the property managed by the system.",
            "readOnly":true
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Is the property publishable."
        },
        "valueCount":{
            "type":"string",
            "description":"Value count as a single or list.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValues":{
            "type":"array",
            "description":"Default values for the property.",
            "items":{
                "type":"string"
            }
        },
        "settings":{
            "description":"Settings for the property.",
            "$ref":"#/definitions/PropertySettingsBean"
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the property.",
            "readOnly":true
        },
        "createdDate":{
            "description":"The creation date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the property.",
            "readOnly":true
        },
        "updatedDate":{
            "description":"The last updated date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Category Property Definition"
}

Nested Schema : defaultValues

Type: array

Default values for the property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Default values for the property.",
    "items":{
        "type":"string"
    }
}

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 : PropertySettingsBean

Type: object

Show Source

• caas(optional): object PropertySettingsCaasBean

{
    "type":"object",
    "properties":{
        "caas":{
            "description":"settings of the property. It is required in the GET response and PUT request whereas it is not required in the POST request.",
            "$ref":"#/definitions/PropertySettingsCaasBean"
        }
    }
}

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 : PropertySettingsCaasBean

Type: object

Show Source

• customValidators(optional): array customValidators
  Custom validators for the property value.
• editor(optional): object PropertySettingsEditorBean
• valueCountRange(optional): object PropertySettingsValueCountRangeBean

{
    "type":"object",
    "properties":{
        "valueCountRange":{
            "description":"Value count range of the property.",
            "$ref":"#/definitions/PropertySettingsValueCountRangeBean"
        },
        "customValidators":{
            "type":"array",
            "description":"Custom validators for the property value.",
            "items":{
                "$ref":"#/definitions/PropertySettingsValidatorBean"
            }
        },
        "editor":{
            "description":"Editor for the property value.",
            "$ref":"#/definitions/PropertySettingsEditorBean"
        }
    }
}

Nested Schema : customValidators

Type: array

Custom validators for the property value.

Show Source

• Array of: object PropertySettingsValidatorBean

{
    "type":"array",
    "description":"Custom validators for the property value.",
    "items":{
        "$ref":"#/definitions/PropertySettingsValidatorBean"
    }
}

Nested Schema : PropertySettingsEditorBean

Type: object

Show Source

• name(optional): string
  Name of the editor.
• options(optional): object options
  Additional Properties Allowed: additionalProperties

  Options of the property value.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the editor."
        },
        "options":{
            "type":"object",
            "description":"Options of the property value.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : PropertySettingsValueCountRangeBean

Type: object

Show Source

• max(optional): integer(int32)
  Minimum Value: 1

  Maximum count of the property value.
• min(optional): integer(int32)
  Minimum Value: 0

  Minimum count of the property value.

{
    "type":"object",
    "properties":{
        "min":{
            "type":"integer",
            "format":"int32",
            "description":"Minimum count of the property value.",
            "minimum":0
        },
        "max":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum count of the property value.",
            "minimum":1
        }
    }
}

Nested Schema : PropertySettingsValidatorBean

Type: object

Show Source

• options(optional): object options
  Additional Properties Allowed: additionalProperties

  Validator details.
• type(optional): string
  Allowed Values: [ "length" ]

  Type of the validator.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type of the validator.",
            "enum":[
                "length"
            ]
        },
        "options":{
            "type":"object",
            "description":"Validator details.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : options

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Validator details.",
    "additionalProperties":{
        "type":"object"
    }
}

Validator details.

Nested Schema : additionalProperties

Type: object

Nested Schema : options

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Options of the property value.",
    "additionalProperties":{
        "type":"object"
    }
}

Options of the property value.

Nested Schema : additionalProperties

Type: object

Nested Schema : ChannelInTaxonomy

Type: object

ChannelInTaxonomy

Show Source

• id(optional): string
  id of the channel.
• name(optional): string
  Name of the channel.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInTaxonomy"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Taxonomy

Type: object

Taxonomy

Show Source

• availableStates(optional): array availableStates
  List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.
• categoryProperties(optional): object ItemSubResourceListCategoryPropertyDefinition
  Item SubResource.
• createdBy(optional): string
  The user who created the Taxonomy.
• createdDate(optional): object date
  date
• customProperties(optional): object customProperties
  Additional Properties Allowed: additionalProperties

  Custom properties of the Taxonomy. This consists of a name value pairs defined by the user. Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.
• description(optional): string
  The description of the Taxonomy.
• id: string
  The id of the Taxonomy. This is a required property in the get response and ignored in post/put requests.
• isForSiteManagement(optional): boolean
  Whether taxonomy is for site management. A site management taxonomy is not publishable. (defaults to false)
• isPublishable(optional): boolean
  Whether taxonomy is publishable. (defaults to false)
• links(optional): array links
  Links
• name: string
  The name of the Taxonomy. It is a required property in the get response and cannot be empty in post/put request.
• publishedChannels(optional): array publishedChannels
  Read Only: true

  Taxonomy published channels.
• roleName(optional): string
  name of the role on the resource.
• shortName(optional): string
  The short name of the Taxonomy. This property is unique among all taxonomies and it is required in the get response. Up to 3 characters can be provided in a put/post request. If no value is provided, a default one will be generated.
• status(optional): string
  Allowed Values: [ "draft", "promoted" ]

  The status of the Taxonomy. This is a required property in the get response and ignored in post/put requests.
• updatedBy(optional): string
  The user who last updated the Taxonomy.
• updatedDate(optional): object date
  date
• version(optional): integer(int32)
  Minimum Value: 1

  The version of this Taxonomy. Version information is only returned for promoted taxonomies. It is ignored in post/put requests.

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Taxonomy. This is a required property in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Taxonomy. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the Taxonomy. This property is unique among all taxonomies and it is required in the get response. Up to 3 characters can be provided in a put/post request. If no value is provided, a default one will be generated."
        },
        "status":{
            "type":"string",
            "description":"The status of the Taxonomy. This is a required property in the get response and ignored in post/put requests.",
            "enum":[
                "draft",
                "promoted"
            ]
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"The version of this Taxonomy. Version information is only returned for promoted taxonomies. It is ignored in post/put requests.",
            "minimum":1
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Whether taxonomy is publishable. (defaults to false)"
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether taxonomy is for site management. A site management taxonomy is not publishable. (defaults to false)"
        },
        "availableStates":{
            "type":"array",
            "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
            "items":{
                "$ref":"#/definitions/TaxonomyStatus"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "publishedChannels":{
            "type":"array",
            "description":"Taxonomy published channels.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ChannelInTaxonomy"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the Taxonomy."
        },
        "createdDate":{
            "description":"The creation date of the Taxonomy.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the Taxonomy."
        },
        "updatedDate":{
            "description":"The date the Taxonomy was last updated.",
            "$ref":"#/definitions/date"
        },
        "categoryProperties":{
            "description":"The definition of category properties for this taxonomy. There are user defined properties and system defined properties such as synonyms, keywords and related categories. These properties are defined as a sub-resource of a single taxonomy and they cannot be expanded through read taxonomy API. They will be ignored by the server in POST and PUT requests. The sub-resource API contains additional information about parameters and available operations.",
            "$ref":"#/definitions/ItemSubResourceListCategoryPropertyDefinition"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        }
    },
    "description":"Taxonomy"
}

Nested Schema : availableStates

Type: array

List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.

Show Source

• Array of: object TaxonomyStatus
  TaxonomyStatus

{
    "type":"array",
    "description":"List all states of the Taxonomy. This is an optional property and is only returned if requested in the fields parameter. It is ignored in post/put requests.",
    "items":{
        "$ref":"#/definitions/TaxonomyStatus"
    }
}

Nested Schema : ItemSubResourceListCategoryPropertyDefinition

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/CategoryPropertyDefinition"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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 : customProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Custom properties of the Taxonomy. This consists of a name value pairs defined by the user.  Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.",
    "additionalProperties":{
        "type":"string"
    }
}

Custom properties of the Taxonomy. This consists of a name value pairs defined by the user. Single entries cannot be updated, the entire list of custom properties have to be provided to update entries.

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 : publishedChannels

Type: array

Read Only: true

Taxonomy published channels.

Show Source

• Array of: object ChannelInTaxonomy
  ChannelInTaxonomy

{
    "type":"array",
    "description":"Taxonomy published channels.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/ChannelInTaxonomy"
    }
}

Nested Schema : TaxonomyStatus

Type: object

TaxonomyStatus

Show Source

• jobs(optional): array jobs
• published(optional): boolean
• status(optional): string
• version(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "published":{
            "type":"boolean"
        },
        "jobs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyJobInfo"
            }
        }
    },
    "description":"TaxonomyStatus"
}

Nested Schema : jobs

Type: array

Show Source

• Array of: object TaxonomyJobInfo
  TaxonomyJobInfo

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

Nested Schema : TaxonomyJobInfo

Type: object

TaxonomyJobInfo

Show Source

• errorDetails(optional): string
• id(optional): string
• status(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "errorDetails":{
            "type":"string"
        }
    },
    "description":"TaxonomyJobInfo"
}

Nested Schema : data

Type: array

Show Source

• Array of: object CategoryPropertyDefinition
  Category Property Definition

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : CategoryPropertyDefinition

Type: object

Category Property Definition

Show Source

• apiName(optional): string
  Read Only: true

  Minimum Length: 1

  Maximum Length: 64

  API Name of the property.
• createdBy(optional): string
  Read Only: true

  The user who created the property.
• createdDate(optional): object date
  date
• defaultValues(optional): array defaultValues
  Default values for the property.
• description(optional): string
  Minimum Length: 0

  Maximum Length: 128

  Description of the property.
• displayName: string
  Minimum Length: 1

  Maximum Length: 128

  Display name of the property.
• id(optional): string
  Read Only: true

  id of the property. It is required in the GET response and PATCH request whereas it will be ignored in the POST request.
• isPublishable(optional): boolean
  Is the property publishable.
• isSystemManaged(optional): boolean
  Read Only: true

  Is the property managed by the system.
• links(optional): array links
  Links
• settings: object PropertySettingsBean
• updatedBy(optional): string
  Read Only: true

  The user who last updated the property.
• updatedDate(optional): object date
  date
• valueCount: string
  Allowed Values: [ "single", "list" ]

  Value count as a single or list.

{
    "type":"object",
    "required":[
        "displayName",
        "settings",
        "valueCount"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the property. It is required in the GET response and PATCH request whereas it will be ignored in the POST request.",
            "readOnly":true
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the property.",
            "readOnly":true,
            "minLength":1,
            "maxLength":64
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the property.",
            "minLength":1,
            "maxLength":128
        },
        "description":{
            "type":"string",
            "description":"Description of the property.",
            "minLength":0,
            "maxLength":128
        },
        "isSystemManaged":{
            "type":"boolean",
            "description":"Is the property managed by the system.",
            "readOnly":true
        },
        "isPublishable":{
            "type":"boolean",
            "description":"Is the property publishable."
        },
        "valueCount":{
            "type":"string",
            "description":"Value count as a single or list.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValues":{
            "type":"array",
            "description":"Default values for the property.",
            "items":{
                "type":"string"
            }
        },
        "settings":{
            "description":"Settings for the property.",
            "$ref":"#/definitions/PropertySettingsBean"
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the property.",
            "readOnly":true
        },
        "createdDate":{
            "description":"The creation date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the property.",
            "readOnly":true
        },
        "updatedDate":{
            "description":"The last updated date of the property.",
            "readOnly":true,
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Category Property Definition"
}

Nested Schema : defaultValues

Type: array

Default values for the property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Default values for the property.",
    "items":{
        "type":"string"
    }
}

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 : PropertySettingsBean

Type: object

Show Source

• caas(optional): object PropertySettingsCaasBean

{
    "type":"object",
    "properties":{
        "caas":{
            "description":"settings of the property. It is required in the GET response and PUT request whereas it is not required in the POST request.",
            "$ref":"#/definitions/PropertySettingsCaasBean"
        }
    }
}

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 : PropertySettingsCaasBean

Type: object

Show Source

• customValidators(optional): array customValidators
  Custom validators for the property value.
• editor(optional): object PropertySettingsEditorBean
• valueCountRange(optional): object PropertySettingsValueCountRangeBean

{
    "type":"object",
    "properties":{
        "valueCountRange":{
            "description":"Value count range of the property.",
            "$ref":"#/definitions/PropertySettingsValueCountRangeBean"
        },
        "customValidators":{
            "type":"array",
            "description":"Custom validators for the property value.",
            "items":{
                "$ref":"#/definitions/PropertySettingsValidatorBean"
            }
        },
        "editor":{
            "description":"Editor for the property value.",
            "$ref":"#/definitions/PropertySettingsEditorBean"
        }
    }
}

Nested Schema : customValidators

Type: array

Custom validators for the property value.

Show Source

• Array of: object PropertySettingsValidatorBean

{
    "type":"array",
    "description":"Custom validators for the property value.",
    "items":{
        "$ref":"#/definitions/PropertySettingsValidatorBean"
    }
}

Nested Schema : PropertySettingsEditorBean

Type: object

Show Source

• name(optional): string
  Name of the editor.
• options(optional): object options
  Additional Properties Allowed: additionalProperties

  Options of the property value.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the editor."
        },
        "options":{
            "type":"object",
            "description":"Options of the property value.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : PropertySettingsValueCountRangeBean

Type: object

Show Source

• max(optional): integer(int32)
  Minimum Value: 1

  Maximum count of the property value.
• min(optional): integer(int32)
  Minimum Value: 0

  Minimum count of the property value.

{
    "type":"object",
    "properties":{
        "min":{
            "type":"integer",
            "format":"int32",
            "description":"Minimum count of the property value.",
            "minimum":0
        },
        "max":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum count of the property value.",
            "minimum":1
        }
    }
}

Nested Schema : PropertySettingsValidatorBean

Type: object

Show Source

• options(optional): object options
  Additional Properties Allowed: additionalProperties

  Validator details.
• type(optional): string
  Allowed Values: [ "length" ]

  Type of the validator.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type of the validator.",
            "enum":[
                "length"
            ]
        },
        "options":{
            "type":"object",
            "description":"Validator details.",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : options

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Validator details.",
    "additionalProperties":{
        "type":"object"
    }
}

Validator details.

Nested Schema : additionalProperties

Type: object

Nested Schema : options

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Options of the property value.",
    "additionalProperties":{
        "type":"object"
    }
}

Options of the property value.

Nested Schema : additionalProperties

Type: object

Nested Schema : ChannelInTaxonomy

Type: object

ChannelInTaxonomy

Show Source

• id(optional): string
  id of the channel.
• name(optional): string
  Name of the channel.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInTaxonomy"
}

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Taxonomy not found. The requested resource not found.

500 Response

Internal server error.

Back to Top

Examples

The following examples show how to update the existing draft taxonomies by submitting a PUT request on the REST resource using cURL.

Note:

Only draft taxonomies can be updated.

curl -X PUT -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/taxonomies/{id}?q=(status eq \"draft\")'

Example 1:

This updates the name of the taxonomy identified by the ID in the URL.

/content/management/api/v1.1/taxonomies/A261541051AF4DCDBAB127C759C5532A?q=(status eq \"draft\")

Request Body

{
  "name": "New name"
}

Example 2:

This updates the short name of the taxonomy identified by the ID in the URL.

/content/management/api/v1.1/taxonomies/A261541051AF4DCDBAB127C759C5532A?q=(status eq \"draft\")

Request Body

{
  "name": "Existing name",
  "shortName": "NEW"
}

Example 3:

This updates the name and short name of the taxonomy identified by the ID in the URL.

/content/management/api/v1.1/taxonomies/A261541051AF4DCDBAB127C759C5532A?q=(status eq \"draft\")

Request Body

{
   "name": "New name",
   "shortName": "NEW"
}

Example 4:

This updates the name, short name, and replaces all existing custom properties for the taxonomy identified by the ID in the URL.

/content/management/api/v1.1/taxonomies/A261541051AF4DCDBAB127C759C5532A?q=(status eq \"draft\")

Request Body

{
    "name": "New name",
    "shortName": "NEW",
    "customProperties": {
        "new property 1": "new value 1" 
        }
}

Example 5:

This updates the name of the taxonomy and removes any custom properties.

/content/management/api/v1.1/taxonomies/A261541051AF4DCDBAB127C759C5532A?q=(status eq \"draft\")

Request Body

{
    "name": "New name",
    "customProperties": {
        }
}

Example 6:

This updates the name and the server provides a short name for the taxonomy identified by the ID in the url.

/content/management/api/v1.1/taxonomies/A261541051AF4DCDBAB127C759C5532A?q=(status eq \"draft\")

Request Body

{
  "name": "New name",
  "shortName": ""
}

Back to Top