Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
No description available.
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/getWarnings HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 150 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WarningsWarningNumber": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "Warnings": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": "text", "WarnFmPriv": 1, "WarnIqPriv": 1, "WarnTrPriv": 1, "WarningNumber": 1 } }
POST /nexum/627/2022.01/parameter/getWarningsSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 381 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WarningsWarningNumber": 1, "SelectableFields": { "IncludeAllWarningsFields": true, "WarningsFields": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": true, "WarnFmPriv": true, "WarnIqPriv": true, "WarnTrPriv": true, "WarningNumber": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getWarningsPagedList 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" } } }
{ "Warnings": [ { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": "text", "WarnFmPriv": 1, "WarnIqPriv": 1, "WarnTrPriv": 1, "WarningNumber": 1 } ], "Token": "text" }
POST /nexum/627/2022.01/parameter/getWarningsListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 355 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllWarningsFields": true, "WarningsFields": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": true, "WarnFmPriv": true, "WarnIqPriv": true, "WarnTrPriv": true, "WarningNumber": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WarningsList": { "hasReachedMaximumListSize": true, "Warnings": [ { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": "text", "WarnFmPriv": 1, "WarnIqPriv": 1, "WarnTrPriv": 1, "WarningNumber": 1 } ] } }
Fields available for selecting when retrieving Warnings data
POST /nexum/627/2022.01/parameter/searchWarningsSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 387 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllWarningsFields": true, "WarningsFields": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": true, "WarnFmPriv": true, "WarnIqPriv": true, "WarnTrPriv": true, "WarningNumber": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getWarningsPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 449 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWarningsFields": true, "WarningsFields": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": true, "WarnFmPriv": true, "WarnIqPriv": true, "WarnTrPriv": true, "WarningNumber": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Fields available for selecting when retrieving paginated Warnings data
POST /nexum/627/2022.01/parameter/searchWarningsPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 464 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWarningsFields": true, "WarningsFields": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": true, "WarnFmPriv": true, "WarnIqPriv": true, "WarnTrPriv": true, "WarningNumber": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update warnings for a specific ID.
POST /nexum/627/2022.01/parameter/updateWarningsByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 309 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WarningsWarningNumber": 1, "WarningsUpdatableFields": { "DisplayWarninginAcctMgr": true, "DisplayWarninginTlrTrn": true, "WarnDescription": "text", "WarnFmPriv": 1, "WarnIqPriv": 1, "WarnTrPriv": 1 }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
