The Data Collection Fields represents the Fields that make up a Data Collection. As part of a Data Collection, these Fields will display in every Action that shares its Action Type with the Data Collection.
Resource Properties
| Scope Parameter | datacollectionfields |
|---|
| Location | /datacollectionfields |
|---|
| Methods | GET,PUT,POST,DELETE |
|---|
| Default Page Size | 50 |
|---|
| Max Page Size | 200 |
|---|
| Default Includes | None |
|---|
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|
| name | The name of the data field. ReadOnly value used to identify the Field for use as Merge Field. | string (50) | true | default |
|
|
| dataType | The field type. (i.e. String, appointment, DateTime, etc.) | string (20) | true | default |
|
|
| label | Use for display purposes. | string (50) | false | default |
|
|
| formOrder | The position of the field when displayed in a form with sibling Fields. | integer | false | default |
|
|
| listOrder | The position of the field when displayed in a list with sibling Fields. | integer | false | default |
|
|
| required | Indicated if the field must be populated when the Data Collection Record is saved. | boolean | false | default |
|
|
| description | A general description of the field and its purpose. | string | false | default |
|
|
| customHtmlBelow | Custom HTML that may be inserted below the Field when displayed. | string | false | default |
|
|
| customHtmlAbove | Custom HTML that may be inserted above the Field when displayed. | string | false | default |
|
|
| dataCollection | The DataCollection that the datafield belongs to. | string | true | link |
|
|
| tag | The Tag associated with this datafield. | string | false | link |
|
|
Link Templates
| Identifier | Resource | Location Template |
|---|
| datafields.dataCollection | datacollections | /datacollections/ |
| datafields.tag | tags | /tags/{datafields.tag} |