fields

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<FieldDefinitionDto>.

Field	Declared type	Nullable
Id	Guid	no
BaseFieldId	Guid?	yes
Code	string	no
Name	string	no
DataType	int	no
IsArray	bool	no
IsMaskable	bool	no
IsEncrypted	bool	no
ParameterId	Guid?	yes
ParameterDomainId	Guid?	yes

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
Id	id	Guid	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_CORE_129	400	PARAMETER_DOMAIN_ID_CANNOT_BE_NOT_NULL	Parameter domain cannot be left blank.
ERR_CORE_130	400	PARAMETER_ID_CANNOT_BE_NOT_NULL	Parameter cannot be left blank.
ERR_CORE_148	400	IS_MASKABLE_MUST_BE_USE_WITH_STRING	Only string type fields can be maskable.
ERR_CORE_149	400	FIELD_CODE_NOT_CORRECT_FORMAT	Field Code is not in correct format
ERR_CORE_24	400	CODE_FIELD_CANNOT_CONTAIN_SPACE	Code field cannot contain space.
ERR_CORE_61	400	FIELD_DEFINITION_CODE_ALREADY_EXISTS	There is already a field with this code.
ERR_CORE_62	400	BASE_FIELD_DEFINITION_MUST_BE_NOT_NULL	Base field cannot be found.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as FieldDefinitionDto.

Field	Declared type	Nullable
Id	Guid	no
BaseFieldId	Guid?	yes
Code	string	no
Name	string	no
DataType	int	no
IsArray	bool	no
IsMaskable	bool	no
IsEncrypted	bool	no
ParameterId	Guid?	yes
ParameterDomainId	Guid?	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_CORE_66	400	FIELD_ID_IS_NOT_FOUND	Field cannot be found.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_CORE_129	400	PARAMETER_DOMAIN_ID_CANNOT_BE_NOT_NULL	Parameter domain cannot be left blank.
ERR_CORE_130	400	PARAMETER_ID_CANNOT_BE_NOT_NULL	Parameter cannot be left blank.
ERR_CORE_148	400	IS_MASKABLE_MUST_BE_USE_WITH_STRING	Only string type fields can be maskable.
ERR_CORE_54	400	CANNOT_DEFINE_ID_AS_BASEID	Cannot define id as parentId.
ERR_CORE_62	400	BASE_FIELD_DEFINITION_MUST_BE_NOT_NULL	Base field cannot be found.
ERR_CORE_66	400	FIELD_ID_IS_NOT_FOUND	Field cannot be found.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_CORE_138	400	THIS_RECORD_IS_DEFINED_AS_BASE	This field is defined as base field
ERR_CORE_66	400	FIELD_ID_IS_NOT_FOUND	Field cannot be found.