ExtraFields
Queryable, Introduced in version 2.18
GET https://localhost:8001/sv/001.1/api/v1/Common/ExtraFields
Represents an extra field.
GUID
3726A06F-153C-404A-A625-17B3F47477AC
Required permission
Show extra fields
Properties
Name | Type | Summary | Introduced in |
---|---|---|---|
Id | Int64 | The business key identifier of the extra field. |
|
ParentClass | Guid | The GUID of the parent type. |
|
ParentId | Int64 | The business key identifier of the parent. |
|
Identifier | String | The alphanumeric identifier of the extra field template. |
|
Type | Int32 | The extra field template type. |
|
StringValue | String | The string value of the extra field. |
|
IntegerValue | Int32? | The integer value of the extra field. |
|
DecimalValue | Decimal? | The decimal value of the extra field. |
|
DateOnlyValue | DateTimeOffset? | The date-only value of the extra field. |
|
DateTimeValue | DateTimeOffset? | The date-time value of the extra field. |
|
SelectedOptionId | Int64? | The business key identifier of the selected option. References ExtraFieldOptionTemplates. |
|
SelectedOption | ExtraFieldOptionTemplates | The selected option of the extra field. Only applicable to extra fields of type 6 (Options).
|
|
SelectedOptionIds | String | A comma separated value list of the selected options. References multiple ExtraFieldOptionTemplates. |
|
SelectedOptions | ExtraFieldOptionTemplates[] | The selected options of the extra field. Only applicable to extra fields of type 7 (Multiple options).
|
|
CommentId | Int64? | The business key identifier of the comment value of the extra field. References Comments |
Introduced in version 2.36 |
Comment | Comments | The comment value of the extra field.
|
Introduced in version 2.36 |
Example
{
"Id": 0,
"ParentClass": "00000000-0000-0000-0000-000000000000",
"ParentId": 0,
"Identifier": null,
"Type": 0,
"StringValue": null,
"IntegerValue": null,
"DecimalValue": null,
"DateOnlyValue": null,
"DateTimeValue": null,
"SelectedOptionId": null,
"SelectedOption": null,
"SelectedOptionIds": null,
"SelectedOptions": null,
"CommentId": null,
"Comment": null
}