Data Collection Record Values

Owned by Jeremy Bruce (Unlicensed)
Last updated: May 29, 2019 by Terra Yi (Unlicensed)
2 min read
The information in this document is currently in BETA and subject to change.


The Data Collection Records Values resource represents the Field Values on a Record belonging to a Data Collection in an Action. 

Resource Properties
Scope Parameterdatacollectionrecordvalues
Location/datacollectionrecordvalues
MethodsGET,PUT,POST
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
stringValueThe string representation of the field value.stringtruedefault

dataCollectionFieldThe DataCollectionField associated with the stringValue.stringtruelink

dataCollectionRecordThe DataCollectionRecord associated with the stringValue.stringtruelink

actionThe Action associated with the stringValue.stringtruelink

dataCollectionThe DataCollection that the data collection belongs to.string
link


Link Templates
IdentifierResourceLocation Template
datacollectionrecordvalues.dataCollectionFielddatacollectionfields/datacollectionfields/{datacollectionrecordvalues.dataCollectionField}
datacollectionrecordvalues.dataCollectionRecorddatacollectionrecords/datacollectionrecords/{datacollectionrecordvalues.dataCollectionRecord}
datacollectionrecordvalues.actionactions/actions/{datacollectionrecordvalues.action}
datacollectionrecordvalues.dataCollectiondatacollections/datacollections/{datacollectionrecordvalues.dataCollection}

Example:

In this example, we'll create an action which has a lot of information configured.

GET example 
GET  https://ap-southeast-2.actionstepstaging.com/api/rest/datacollectionrecordvalues
Response:
{
    "links": {
        "datacollectionrecordvalues.action": {
            "href": "https://ap-southeast-2.actionstepstaging.com.actionstep.com/api/rest/actions/{datacollectionrecordvalues.action}",
        "type": "actions"
    },
    "datacollectionrecordvalues.dataCollectionField": {
        "href": "https://ap-southeast-2.actionstepstaging.com.actionstep.com/api/rest/datacollectionfields/{datacollectionrecordvalues.dataCollectionField}",
    "type": "datacollectionfields"
    },
    "datacollectionrecordvalues.dataCollectionRecord": {
        "href": "https://ap-southeast-2.actionstepstaging.com.actionstep.com/api/rest/datacollectionrecords/{datacollectionrecordvalues.dataCollectionRecord}",
    "type": "datacollectionrecords"
    },
    "datacollectionrecordvalues.dataCollection": {
        "href": "https://ap-southeast-2.actionstepstaging.com.actionstep.com/api/rest/datacollections/{datacollectionrecordvalues.dataCollection}",
    "type": "datacollections"
    }
},
"datacollectionrecordvalues": [ {
    "id": "15--NewDataField--1",
    "stringValue": "override one",
    "links": {
        "action": "1",
        "dataCollectionField": "15--NewDataField",
        "dataCollectionRecord": "1",
        "dataCollection": "15"
    }
},
{
    "id": "15--NewDataField--2",
    "stringValue": "override two",
    "links": {
        "action": "1",
        "dataCollectionField": "15--NewDataField",
        "dataCollectionRecord": "2",
        "dataCollection": "15"
    }
} ]
}
PUT example 
PUT   https://ap-southeast-2.actionstepstaging.com/api/rest/datacollectionrecordvalues/15--NewDataField--1,15--NewDataField--2

JSON:
{
    "datacollectionrecordvalues": [ {
        "id": "15--NewDataField--1",
        "stringValue": "override one",
        "links": {
            "action": "1",
            "dataCollectionField": "15--NewDataField",
            "dataCollectionRecord": "1",
            "dataCollection": "15"
        }
    },
    {
        "id": "15--NewDataField--2",
        "stringValue": "override two",
        "links": {
            "action": "1",
            "dataCollectionField": "15--NewDataField",
            "dataCollectionRecord": "2",
            "dataCollection": "15"
        }
    }
] }