| Info |
|---|
| 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 Parameter | datacollectionrecordvalues |
|---|
| Location | /datacollectionrecordvalues |
|---|
| Methods | GET,PUT,POST |
|---|
| Default Page Size | 50 |
|---|
| Max Page Size | 200 |
|---|
| Default Includes | None |
|---|
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|
| stringValue | The string representation of the field value. | string | true | default |
|
|
| dataCollectionField | The DataCollectionField associated with the stringValue. | string | true | link |
|
|
| dataCollectionRecord | The DataCollectionRecord associated with the stringValue. | string | true | link |
|
|
| action | The Action associated with the stringValue. | string | true | link |
|
|
Link Templates
| Identifier | Resource | Location Template |
|---|
| datacollectionrecordvalues.dataCollectionField | datacollectionfields | /datacollectionfields/{datacollectionrecordvalues.dataCollectionField} |
| datacollectionrecordvalues.dataCollectionRecord | datacollectionrecords | /datacollectionrecords/{datacollectionrecordvalues.dataCollectionRecord} |
| datacollectionrecordvalues.action | actions | /actions/{datacollectionrecordvalues.action} |
Example:
In this example, we'll create an action which has a lot of information configured.
| Code Block |
|---|
| language | php |
|---|
| title | GET example |
|---|
| collapse | true |
|---|
|
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"
}
} ]
} |
| Code Block |
|---|
| language | php |
|---|
| title | PUT example |
|---|
| collapse | true |
|---|
|
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"
}
}
] } |