Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve lookup type name
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/getLookupTypeName HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 153 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "LookupTypeNameLookupType": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "LookupTypeName": { "LookupType": 1, "LookupTypeValue": "text" } }
Retrieve lookup type name select fields
POST /nexum/627/2022.01/parameter/getLookupTypeNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 278 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "LookupTypeNameLookupType": 1, "SelectableFields": { "IncludeAllLookupTypeNameFields": true, "LookupTypeNameFields": { "LookupType": true, "LookupTypeValue": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve paged list of lookup type names
POST /nexum/627/2022.01/parameter/getLookupTypeNamePagedList 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" } } }
{ "LookupTypeName": [ { "LookupType": 1, "LookupTypeValue": "text" } ], "Token": "text" }
Retrieve lookup type name list select fields
POST /nexum/627/2022.01/parameter/getLookupTypeNameListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 249 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllLookupTypeNameFields": true, "LookupTypeNameFields": { "LookupType": true, "LookupTypeValue": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "LookupTypeNameList": { "hasReachedMaximumListSize": true, "LookupTypeName": [ { "LookupType": 1, "LookupTypeValue": "text" } ] } }
Retrieve a list of select fields for searching by lookup type names.
POST /nexum/627/2022.01/parameter/searchLookupTypeNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 281 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllLookupTypeNameFields": true, "LookupTypeNameFields": { "LookupType": true, "LookupTypeValue": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve paged list select fields of lookup type names
POST /nexum/627/2022.01/parameter/getLookupTypeNamePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 343 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllLookupTypeNameFields": true, "LookupTypeNameFields": { "LookupType": true, "LookupTypeValue": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a list of paged select fields for searching by lookup type names.
POST /nexum/627/2022.01/parameter/searchLookupTypeNamePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 358 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllLookupTypeNameFields": true, "LookupTypeNameFields": { "LookupType": true, "LookupTypeValue": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/updateLookupTypeNameByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 212 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "LookupTypeNameLookupType": 1, "LookupTypeNameUpdatableFields": { "LookupTypeValue": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }