Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve getSymXDeviceMap data.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/parameter/getSymXDeviceMap HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 178 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SymXDeviceMapInstanceId": 1, "SymXDeviceMapDeviceId": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "SymXDeviceMap": { "InstanceId": 1, "DeviceId": 1, "ClientNumber": 1, "Description": "text", "DeviceNumber": 1, "BalanceRecordNumber": 1, "DeviceType": "text" } }
Retrieve getSymXDeviceMapSelectFields data.
POST /nexum/627/2022.01/parameter/getSymXDeviceMapSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 398 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SymXDeviceMapInstanceId": 1, "SymXDeviceMapDeviceId": 1, "SelectableFields": { "IncludeAllSymXDeviceMapFields": true, "SymXDeviceMapFields": { "BalanceRecordNumber": true, "ClientNumber": true, "Description": true, "DeviceId": true, "DeviceNumber": true, "DeviceType": true, "InstanceId": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve getSymXDeviceMapPagedList data.
POST /nexum/627/2022.01/parameter/getSymXDeviceMapPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 218 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "SymXDeviceMap": [ { "InstanceId": 1, "DeviceId": 1, "ClientNumber": 1, "Description": "text", "DeviceNumber": 1, "BalanceRecordNumber": 1, "DeviceType": "text" } ], "Token": "text" }
Retrieve getSymXDeviceMapListSelectFields data.
POST /nexum/627/2022.01/parameter/getSymXDeviceMapListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 344 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllSymXDeviceMapFields": true, "SymXDeviceMapFields": { "BalanceRecordNumber": true, "ClientNumber": true, "Description": true, "DeviceId": true, "DeviceNumber": true, "DeviceType": true, "InstanceId": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "SymXDeviceMapList": { "hasReachedMaximumListSize": true, "SymXDeviceMap": [ { "InstanceId": 1, "DeviceId": 1, "ClientNumber": 1, "Description": "text", "DeviceNumber": 1, "BalanceRecordNumber": 1, "DeviceType": "text" } ] } }
Retrieve a list of select fields for SymX device mappings
POST /nexum/627/2022.01/parameter/searchSymXDeviceMapSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 376 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllSymXDeviceMapFields": true, "SymXDeviceMapFields": { "BalanceRecordNumber": true, "ClientNumber": true, "Description": true, "DeviceId": true, "DeviceNumber": true, "DeviceType": true, "InstanceId": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve getSymXDeviceMapPagedListSelectFields data.
POST /nexum/627/2022.01/parameter/getSymXDeviceMapPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 438 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllSymXDeviceMapFields": true, "SymXDeviceMapFields": { "BalanceRecordNumber": true, "ClientNumber": true, "Description": true, "DeviceId": true, "DeviceNumber": true, "DeviceType": true, "InstanceId": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for SymX device mappings
POST /nexum/627/2022.01/parameter/searchSymXDeviceMapPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 453 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllSymXDeviceMapFields": true, "SymXDeviceMapFields": { "BalanceRecordNumber": true, "ClientNumber": true, "Description": true, "DeviceId": true, "DeviceNumber": true, "DeviceType": true, "InstanceId": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
