Get Machine Custom Data Definitions
Retrieves the custom data definitions for machine models. Definitions describe the meaning, type, and constraints for each of a machine model's five custom data slots.
| Verb | POST |
|---|---|
| Endpoint | {base-url}/machines/models/custom-data-definitions |
| Max Page Size | 1000 |
Request Body
{
"routeFilter": {
"definitionIds": [1],
"modelIdentifiers": ["VCController"]
}
}
Filters Honored
- definitionIds: filter by specific definition IDs
- modelIdentifiers: filter by machine model ID or model number (both accepted)
Returns
On Success
The requested list of custom data definitions.
Response Body
[
{
"id": 1,
"machineModelId": 42,
"number": 1,
"friendlyName": "Asset Tag",
"description": "The asset tag applied to the physical machine.",
"dataType": "string",
"machineKey": "asset_tag"
}
]
See MachineCustomDataDefinition for the full field reference.