Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
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/getBatchRc HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 151 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "BatchRcBatchReturnCode": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "BatchRc": { "BatchReturnCodeDefinedType": 1, "BatchReturnCodeDescription": "text", "BatchReturnCode": 1 } }
POST /nexum/627/2022.01/parameter/getBatchRcSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 312 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "BatchRcBatchReturnCode": 1, "SelectableFields": { "IncludeAllBatchRcFields": true, "BatchRcFields": { "BatchReturnCode": true, "BatchReturnCodeDefinedType": true, "BatchReturnCodeDescription": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getBatchRcPagedList 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" } } }
{ "BatchRc": [ { "BatchReturnCodeDefinedType": 1, "BatchReturnCodeDescription": "text", "BatchReturnCode": 1 } ], "Token": "text" }
POST /nexum/627/2022.01/parameter/getBatchRcListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 285 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllBatchRcFields": true, "BatchRcFields": { "BatchReturnCode": true, "BatchReturnCodeDefinedType": true, "BatchReturnCodeDescription": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "BatchRcList": { "hasReachedMaximumListSize": true, "BatchRc": [ { "BatchReturnCodeDefinedType": 1, "BatchReturnCodeDescription": "text", "BatchReturnCode": 1 } ] } }
Search batch record select fields
POST /nexum/627/2022.01/parameter/searchBatchRcSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 317 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllBatchRcFields": true, "BatchRcFields": { "BatchReturnCode": true, "BatchReturnCodeDefinedType": true, "BatchReturnCodeDescription": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getBatchRcPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 379 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllBatchRcFields": true, "BatchRcFields": { "BatchReturnCode": true, "BatchReturnCodeDefinedType": true, "BatchReturnCodeDescription": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Search batch record paged select fields
POST /nexum/627/2022.01/parameter/searchBatchRcPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 394 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllBatchRcFields": true, "BatchRcFields": { "BatchReturnCode": true, "BatchReturnCodeDefinedType": true, "BatchReturnCodeDescription": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update Batch RC by ID
POST /nexum/627/2022.01/parameter/updateBatchRcByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 245 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "BatchRcBatchReturnCode": 1, "BatchRcUpdatableFields": { "BatchReturnCodeDefinedType": 1, "BatchReturnCodeDescription": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
