Custom Fields
Get all extended types
get /api/http/custom-fields/extended-types
Get all types that support custom fields
Get all values
get /api/http/custom-fields/{typeKey}/all-values
Get all custom field values for a type. Optionally, extendedEntityIds can be used to get data for one or more entity IDs.
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| $skip : string (Query) ( Nullable and Optional , defaults to null )
| $top : integer (format: int32) (Query) ( Nullable and Optional , defaults to 100 )
| extendedEntityIds : array of string (Query) ( Nullable and Optional , defaults to null )
| scope : string in one of the formats
(Query) ( Optional ) |
Response |
---|
object with fields: next : string ( Required )
totalCount : integer (format: int32) ( Nullable and Optional , defaults to null )
data : array of CustomFieldsRecord ( Required )
|
|
Create enum value
post /api/http/custom-fields/{typeKey}/enum-values/{customFieldId}
Add new option to custom field of Select from options
type. Options can only be added via this API call if custom field has the Open-ended
flag set. Returns saved records.
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| customFieldId : string (Path) ( Required )
| object with fields: |
|
Get all enum values
get /api/http/custom-fields/{typeKey}/enum-values/{customFieldId}
Get a page of options for custom field of Select from options
type with Open-ended
flag set
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| customFieldId : string (Path) ( Required )
| $skip : string (Query) ( Nullable and Optional , defaults to null )
| $top : integer (format: int32) (Query) ( Nullable and Optional , defaults to 100 )
| query : string (Query) ( Nullable and Optional , defaults to null )
| ordering : EnumValueOrdering (Query) ( Optional , defaults to "NAME_ASC" )
| countRecords : boolean (Query) ( Nullable and Optional , defaults to null )
| addedByProfileId : string (Query) ( Nullable and Optional , defaults to null )
| scope : string in one of the formats
(Query) ( Optional ) |
Response |
---|
object with fields: next : string ( Required )
totalCount : integer (format: int32) ( Nullable and Optional , defaults to null )
data : array of EnumValueData ( Required )
|
|
Create field
post /api/http/custom-fields/{typeKey}/fields
Create custom field for a type
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| object with fields: name : string ( Required )
description : string ( Nullable and Optional , defaults to null )
type : CFType ( Required )
constraint : CFConstraint ( Nullable and Optional , defaults to null )
required : boolean ( Required )
private : boolean ( Required )
access : AccessType ( Nullable and Optional , defaults to null )
defaultValue : CFInputValue ( Required )
openEnumValuesModification : CFEnumValuesModification ( Nullable and Optional , defaults to null )
cfParameters : CFCreateParameters ( Nullable and Optional , defaults to null )
scope : ExtendedTypeScope ( Required )
|
|
Get all fields
get /api/http/custom-fields/{typeKey}/fields
Get custom fields for a type
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| withArchived : boolean (Query) ( Optional , defaults to false )
| scope : string in one of the formats
(Query) ( Optional ) |
|
Reorder fields
post /api/http/custom-fields/{typeKey}/fields/reorder
Re-order custom fields. Pass IDs of the custom fields in the order you wish the custom fields to be.
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| object with fields: |
|
Archive field
post /api/http/custom-fields/{typeKey}/fields/{id}/archive
Archive a custom field for a type
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| id : string (Path) ( Required )
| object with fields: |
|
Restore field
post /api/http/custom-fields/{typeKey}/fields/{id}/restore
Restore custom field for a type
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| id : string (Path) ( Required )
| object with fields: |
|
Update field
patch /api/http/custom-fields/{typeKey}/fields/{id}
Update custom field for a type. Optional parameters will be ignored when not specified and updated otherwise.
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| id : string (Path) ( Required )
| object with fields: name : string ( Nullable and Optional , defaults to null )
description : string ( Nullable and Optional , defaults to null )
constraint : CFConstraint ( Nullable and Optional , defaults to null )
required : boolean ( Nullable and Optional , defaults to null )
private : boolean ( Nullable and Optional , defaults to null )
access : AccessType ( Nullable and Optional , defaults to null )
defaultValue : CFInputValue ( Nullable and Optional , defaults to null )
enumValues : array of EnumValueData ( Nullable and Optional , defaults to null )
openEnumValuesModification : CFEnumValuesModification ( Nullable and Optional , defaults to null )
cfParameters : CFUpdateParameters ( Nullable and Optional , defaults to null )
scope : ExtendedTypeScope ( Required )
|
|
Delete field
delete /api/http/custom-fields/{typeKey}/fields/{id}
Remove custom field for a type
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| id : string (Path) ( Required )
| scope : string in one of the formats
(Query) ( Required ) |
|
Get all filter values
get /api/http/custom-fields/{typeKey}/fields/{id}/filter-values
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| id : string (Path) ( Required )
| $skip : string (Query) ( Nullable and Optional , defaults to null )
| $top : integer (format: int32) (Query) ( Nullable and Optional , defaults to 100 )
| scope : string in one of the formats
(Query) ( Optional ) | calculateTotal : boolean (Query) ( Optional , defaults to false )
|
Response |
---|
object with fields: next : string ( Required )
totalCount : integer (format: int32) ( Nullable and Optional , defaults to null )
data : array of CFValue ( Required )
|
|
Get value
get /api/http/custom-fields/{typeKey}/{entityId}/values
Get custom field value for a type and entity ID
|
Request arguments |
---|
typeKey : string (Path) ( Required )
| entityId : string (Path) ( Required )
| scope : string in one of the formats
(Query) ( Optional ) |
|
Update value
patch /api/http/custom-fields/{typeKey}/{entityId}/values
Update custom field value ( s ) for a type and entity ID
|
Request arguments |
---|
entityId : string (Path) ( Required )
| typeKey : string (Path) ( Required )
| object with fields: |
|
Last modified: 06 September 2023