Jump to

• Request
• Response

Create a category property

post

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

with given payload.

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

Header Parameters

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

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Creates a category property with the given information in the payload. The fields id, apiName, isSystemManaged, createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.

The fields apiName and displayName are unique within the taxonomy and case-insensitive, i.e., user can not create a property with existing apiName or displayName in the same taxonomy even in a different case.

The field displayName will have all leading and trailing whitespace characters removed. Example:

• displayName = " model year "
• Result displayName = "model year"

apiName will be generated based on the value of displayName. Any non-alphanumeric characters in displayName will be removed. If resulting value is an empty string, timestamp (in format of 'yyyyMMddHHmmssSSS') will be used. If resulting value starts with a number, it will be prefixed with 'property'.

Example:

• displayName = " model_year "
• Result apiName = "modelYear"

Example:

• displayName = "2022 models"
• Result apiName = "property2022Models"

Example:

• displayName = "??????"
• Result apiName = "property20230101103022589"

The field isPublishable indicates whether the category property is publishable or not.

The field valueCount can accept the values single or list, and any other value is not allowed. If the value for valueCount is single, only one property value will be allowed per category. If the value for valueCount is list, more than one property value will be allowed per category, and the limit of values will be given by the settings.caas.valueCountRange field.

The field defaultValues accepts a comma-separated list of values, and these values are going to be applied by default if no value is provided for the category property when a category is created. If the value for valueCount is single, only one default value will be allowed. If the value for valueCount is list, more than one default value will be allowed, and the limit of default values will be given by the settings.caas.valueCountRange field.

The field settings.caas.valueCountRange defines the lower and upper limit of values allowed for the category property, where the field settings.caas.valueCountRange.min is the lower limit and the field settings.caas.valueCountRange.max is the upper limit.

The field settings.caas.editor indicates the editor that will be used to assign values to the category property. The field settings.caas.editor.name supports one of the following values:

• Text box
• Single-select menu
• Multi-select menu

For Single-select or Multi-select menu it will be allowed to define menu options in the field settings.caas.editor.options

The field settings.caas.customValidators is a list of validations that will be applied to the values of the category property, where the field settings.caas.customValidators.type indicates the type of validation and the field settings.caas.customValidators.options indicates the specific rules that the validation should apply.

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

Body ()

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

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Taxonomy not found. The requested resource not found.

409 Response

The requested resource operation is temporarily unavailable

500 Response

Internal server error.

Back to Top