Map fields from list of values
Fields within a step may contain a set of pre-defined values that can be selected from, returned in the “Values” array below:
Get field values
Request:
CODE
GET /v1.0/steps/{Step ID}/fieldmappings/{Field ID}
Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000
X-Cyclr-Account: 00000000-0000-0000-0000-000000000000
Response:
CODE
{
"Field": {
"Id": 283792,
"Name": "Email",
"Description": null,
"IsOptional": false,
"DataType": "Undefined",
"TriggerName": null,
"Values": [
"List Option 1",
"List Option 2",
"List Option 3"
],
"DisplayOrder": 1,
"Triggers": []
},
"MappingType": "Ignore",
"SourceFieldId": null,
"SourceStepId": null,
"TriggerValue": null,
"TriggerValueDisplayName": null,
"Value": null
}
Update field values
For these steps, the list of valid values should be presented to your user for them to make a selection. Their selection should then be used to update the field value.
Request:
CODE
POST /v1.0/steps/{Step ID}/fieldmappings/{Field ID}
Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000
X-Cyclr-Account: 00000000-0000-0000-0000-000000000000
{
"MappingType": "ValueList",
"Value": "List Option 1"
}
Response:
CODE
{
"Field": {
"Id": 283792,
"Name": "Email",
"Description": null,
"IsOptional": false,
"DataType": undefined,
"TriggerName": null,
"Values": [],
"DisplayOrder": 1,
"Triggers": []
},
"MappingType": "ValueList",
"SourceFieldId": null,
"SourceStepId": null,
"TriggerValue": null,
"TriggerValueDisplayName": null,
"Value": "List Option 1"
}
Related pages
Static Value Field Mapping
Field Mapping with Step Data
Cycle Activation