Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve a CP letter.
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/getCpLetter HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 147 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "CpLetterLetterCode": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "CpLetter": { "Description": "text", "LetterCode": 1, "NextWorkDays": 1, "Specfile": "text" } }
Retrieve select fields for a specific CP letter.
POST /nexum/627/2022.01/parameter/getCpLetterSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 292 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "CpLetterLetterCode": 1, "SelectableFields": { "IncludeAllCpLetterFields": true, "CpLetterFields": { "Description": true, "LetterCode": true, "NextWorkDays": true, "Specfile": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve CP letters in a paged list.
POST /nexum/627/2022.01/parameter/getCpLetterPagedList 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" } } }
{ "CpLetter": [ { "Description": "text", "LetterCode": 1, "NextWorkDays": 1, "Specfile": "text" } ], "Token": "text" }
Retrieve a list of select fields for CP letters.
POST /nexum/627/2022.01/parameter/getCpLetterListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 269 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllCpLetterFields": true, "CpLetterFields": { "Description": true, "LetterCode": true, "NextWorkDays": true, "Specfile": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "CpLetterList": { "hasReachedMaximumListSize": true, "CpLetter": [ { "Description": "text", "LetterCode": 1, "NextWorkDays": 1, "Specfile": "text" } ] } }
Field for selecting various options related to searchcpletterselectfields
POST /nexum/627/2022.01/parameter/searchCpLetterSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 301 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllCpLetterFields": true, "CpLetterFields": { "Description": true, "LetterCode": true, "NextWorkDays": true, "Specfile": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for CP letters.
POST /nexum/627/2022.01/parameter/getCpLetterPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 363 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllCpLetterFields": true, "CpLetterFields": { "Description": true, "LetterCode": true, "NextWorkDays": true, "Specfile": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Field for selecting various options related to searchcpletterpagedselectfields
POST /nexum/627/2022.01/parameter/searchCpLetterPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 378 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllCpLetterFields": true, "CpLetterFields": { "Description": true, "LetterCode": true, "NextWorkDays": true, "Specfile": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update CP Letter by ID
POST /nexum/627/2022.01/parameter/updateCpLetterByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 231 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "CpLetterLetterCode": 1, "CpLetterUpdatableFields": { "Description": "text", "NextWorkDays": 1, "Specfile": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
