Read a category property
get
/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}
Read a specific category property by taxonomy id and category property id.
Request
Path Parameters
-
id: string
id of the taxonomy.
-
propertyId: string
Unique identifier (id) for a category property definition.
Query Parameters
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : CategoryPropertyDefinition
Type:
objectCategory Property Definition
Show Source
-
apiName(optional):
string
Read Only:
trueMinimum Length:1Maximum Length:64API Name of the property. -
createdBy(optional):
string
Read Only:
trueThe user who created the property. -
createdDate(optional):
object date
date
-
defaultValues(optional):
array defaultValues
Default values for the property.
-
description(optional):
string
Minimum Length:
0Maximum Length:128Description of the property. -
displayName:
string
Minimum Length:
1Maximum Length:128Display name of the property. -
id(optional):
string
Read Only:
trueid 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:
trueIs the property managed by the system. -
links(optional):
array links
Links
-
settings:
object PropertySettingsBean
-
updatedBy(optional):
string
Read Only:
trueThe user who last updated the property. -
updatedDate(optional):
object date
date
-
valueCount:
string
Allowed Values:
[ "single", "list" ]Value count as a single or list.
Nested Schema : Link
Type:
objectLink 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.
Nested Schema : PropertySettingsCaasBean
Type:
Show Source
object-
customValidators(optional):
array customValidators
Custom validators for the property value.
-
editor(optional):
object PropertySettingsEditorBean
-
valueCountRange(optional):
object PropertySettingsValueCountRangeBean
Nested Schema : PropertySettingsEditorBean
Type:
Show Source
object-
name(optional):
string
Name of the editor.
-
options(optional):
object options
Additional Properties Allowed: additionalPropertiesOptions of the property value.
Nested Schema : PropertySettingsValueCountRangeBean
Type:
Show Source
object-
max(optional):
integer(int32)
Minimum Value:
1Maximum count of the property value. -
min(optional):
integer(int32)
Minimum Value:
0Minimum count of the property value.
Nested Schema : PropertySettingsValidatorBean
Type:
Show Source
object-
options(optional):
object options
Additional Properties Allowed: additionalPropertiesValidator details.
-
type(optional):
string
Allowed Values:
[ "length" ]Type of the validator.
Nested Schema : additionalProperties
Type:
objectNested Schema : options
Type:
objectAdditional Properties Allowed
Show Source
Options of the property value.
Nested Schema : additionalProperties
Type:
object400 Response
Bad request.
404 Response
The requested resource was not found.
500 Response
Internal server error.