Model: contentTypeProperty

1 min

Model Parameters

contentTypeProperty
- namestringrequired
  Description
  The name of the property.
  Max Length
  100
  Pattern
  [a-zA-Z][\w]*
- dataTypestringrequired
  Description
  The main data type name.
  Max Length
  255
  Pattern
  [a-zA-Z][(\w\s*\w?),\.]*
- branchSpecificboolean
  Description
  Indicates if the property has specific values for each content branch or if values are shared between all branches.
- requiredboolean
  Description
  Indicates if the property is required.
- editSettingspropertyEditSettings
  Description
  Defines settings for content type properties that affects how the property is displayed when edited.
  - visibilityvisibilityStatus
    Description
    Specifies the visibility status of a property in edit view.
  - displayNamestring
    Description
    The name that should be used when editing the property.
    Max Length
    255
  - groupNamestring
    Description
    Name of the property group that this property should be displayed in.
    Max Length
    100
    Pattern
    [a-zA-Z][\w]*
  - sortOrderinteger<int32>
    Description
    The field order used for ordering the properties when editing.
    Format
    int32
    Minimum
    0
    Maximum
    2147483647
  - helpTextstring
    Description
    The text that should be used as help when editing the property.
    Max Length
    2000
  - hintstring
    Description
    A hint that will be used when resolving which editor that should be used when editing this property.
    Max Length
    255
- imageDescriptorpropertyImageDescriptor
  Description
  Defines a thumbnail image format.
  - heightinteger<int32>
    Description
    Thumbnail image height
    Format
    int32
    Minimum
    0
    Maximum
    2147483647
  - widthinteger<int32>
    Description
    Thumbnail image width
    Format
    int32
    Minimum
    0
    Maximum
    2147483647
  - pregeneratedboolean
    Description
    If the thumbnail should be pregenerated when a new image is uploaded rather than when first requested
- validationpropertyValidationSettings[]
  Description
  The validation settings of the property.
  - namestringrequired
    Description
    The name of the validation type that should be performed.
  - severityvalidationErrorSeverity
  - errorMessagestring
    Description
    The error message to use for any validation error.
- itemTypestring
  Description
  The item type for cases when the 'dataType' is 'PropertyBlock'.
  Max Length
  255
  Pattern
  [a-zA-Z][(\w\s*\w?),\.]*

A content type property definition describes a property of a content items.