Data Collections
The information in this document is currently in BETA and subject to change.
The Data Collections resource represents a data collection defined for an Action Type. The Data Collection is replicated across all Actions of its linked Action Type.
Resource Properties
| Scope Parameter | datacollections |
|---|---|
| Location | /datacollections |
| 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 Collection. This is a ReadOnly constant used for Merge Field use. | string (50) | true | default | ||
| description | A general description of the Data Collection. | string | true | default | ||
| multipleRecords | Indicates if the Data Collection consists of a single record or multiple records. | boolean | false | default | ||
| order | The position of the Data Collection when part of a list of Data Collections. | integer | false | additional | ||
| label | The label to be used for display purposes. | string (25) | false | additional | ||
| alwaysShowDescriptions | If TRUE, must display custom HTML blocks defined by Data Collection Fields for this Data Collection. | boolean | false | additional | ||
| actionType | The ActionType that the DataCollection belongs to. | string | true | link |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| datacollections.actionType | actiontypes | /actiontypes/{datacollections.actionType} |