/
Data Collections

Data Collections

Owned by Aaron Pettit (Unlicensed)
Last updated: Sept 23, 2015 by Jeremy Bruce (Unlicensed)
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 Parameterdatacollections
Location/datacollections
MethodsGET,PUT,POST,DELETE
Default Page Size50
Max Page Size200
Default IncludesNone

 

Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
nameThe name of the Data Collection. This is a ReadOnly constant used for Merge Field use.string (50)truedefault  
descriptionA general description of the Data Collection.stringtruedefault  
multipleRecordsIndicates if the Data Collection consists of a single record or multiple records.booleanfalsedefault  
orderThe position of the Data Collection when part of a list of Data Collections.integerfalseadditional  
labelThe label to be used for display purposes.string (25)falseadditional  
alwaysShowDescriptionsIf TRUE, must display custom HTML blocks defined by Data Collection Fields for this Data Collection.booleanfalseadditional  
actionTypeThe ActionType that the DataCollection belongs to.stringtruelink  

 

Link Templates
IdentifierResourceLocation Template
datacollections.actionTypeactiontypes/actiontypes/{datacollections.actionType}

Related content

Data Collection Fields
Data Collection Fields
API Guide
More like this
Participant Type Data Fields
Participant Type Data Fields
API Guide
More like this
Participants
Participants
API Guide
Read with this
Data Collection Records
Data Collection Records
API Guide
More like this
Participant Data Field Values
Participant Data Field Values
API Guide
Read with this
Data Collection Record Values
Data Collection Record Values
API Guide
More like this