Field
Object: Field
Section titled “Object: Field”A field is an extra, custom piece of data captured some time in a booking.
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id* | UUID! | The ID of the field. |
key* | EntityKey! | A user-defined, stable identifier for the field. |
label* | String! | The label of the field. |
description | String | The description of the field. |
type* | FieldType! | The type of data the field accepts. |
regex | String | A regular expression to validate this field. Not applicable if options are defined. The choice you pick will not be validated against the regex. This regular expression will be executed in single-line mode, so '.' will match \\n characters. Only applicable on String fields. |
maxLength* | Int! | The maximum length of this field. Not applicable if options are defined. The choice you pick will not be validated against the maximum length. Only applicable on String fields. |
multiLine* | Boolean! | Whether a string field should be displayed as multiple lines or not. Has no effect on processing the field, only display. Not applicable if options are defined. Only applicable on String fields. |
options | [Option!] | A list of options, defining valid return values. If set, you can only submit any of the 'value' fields in any option when submitting the field. Only applicable on String fields. |
capturePoints* | [FieldCapturePoint!]! | A set of capture points to be captured relative to this status. |
allowedFileTypes | [String!] | A list of approved file types that can be uploaded to this field. Only globally-approved file types can be included. Can only be set if type is 'Field'. If no value is provided, all globally-approved file types are allowed. |
maxFileSize | Int | The maximum file size (in bytes) that can be uploaded to this field. This value cannot exceed the maximum file size approved for this organisation. Can only be set if type is 'Field'. If no value is provided, the maximum approved file size for the organisation will be used. |
internal* | Boolean! | If true, this field & corresponding data is visible only to the location. |
passType | PassType | If its a pass type, get some info |
autoPurgeValue* | Boolean! | If true, values captured are automatically removed in accordance with organisation field data removal policy. |
highlighted* | Boolean! | If true, the field will be displayed with higher priority |
customFileTypes | Boolean | If true, allowedFileTypes were specified. |
class | FieldClass | The classification of this field. Null if unclassified. |