Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

Entity - Custom property type

Page version:

Page info
infoTypeCurrent version
dateFormatdd MMMM yy - hh:mm aa
count1
page@self
typeFlat
, last updated:
Page info
infoTypeModified date
dateFormath:mmaa, dd-MMM-yy
count1
page@self
typeFlat



VerbRequestNotesPermissions required
GET - All/Consumer/CustomPropertyTypesGets list of all available custom property types

Following product pack related permissions

  • Questioner
  • Actioner

Following custom property related permission

  • Read

Returns Unauthorized (401) if user does not have the required permissions.

GET - individual by id/Consumer/CustomPropertyTypes/Id/{id}Gets individual by id

Following product pack related permissions

  • Questioner
  • Actioner

Following custom property related permission

  • Read

Returns Unauthorized (401) if user does not have the required permissions.

GET - individual by name/Consumer/CustomPropertyTypes/Name/{name}Gets individual by name

Following product pack related permissions

  • Questioner
  • Actioner

Following custom property related permission

  • Read

Returns Unauthorized (401) if user does not have the required permissions.

POST/Consumer/CustomPropertyTypes

Minimum API version 4.0

Creates a new custom property type

Only non-system custom property types can be created.

FieldDescription
NameName of the custom property type
DescriptionDescription of the custom property type


Requires 'Write' permissions on 'CustomProperty' securable type
PUT/Consumer/CustomPropertyTypes

Minimum API version 4.0

Updates an existing custom property type.

System custom property types cannot be modified.

FieldDescription
IdId of the custom property type to be updated
NameName of the custom property type
DescriptionDescription of the custom property type


Requires 'Write' permissions on 'CustomProperty' securable type
DELETE/Consumer/CustomPropertyTypes/Id/{id}

Minimum API version 4.0

Deletes an individual custom property type by its id.

System custom property types cannot be deleted.

Deleting a custom property type will cause all custom properties of this type and all of their values to be deleted.

Requires 'Write' permissions on 'CustomProperty' securable type
DELETE/Consumer/CustomPropertyTypes/Name/{name}

Minimum API version 4.0

Deletes an individual custom property type by its name.

System custom property types cannot be deleted.

Deleting a custom property type will cause all custom properties of this type and all of their values to be deleted.

Requires 'Write' permissions on 'CustomProperty' securable type
DELETE/Consumer/CustomPropertyTypes

Minimum API version 4.0

Deletes multiple custom property types.

System custom property types cannot be deleted.

Body of the request should contain an array of custom property types

Requires 'Write' permissions on 'CustomProperty' securable type