Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve security
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/getSecurity HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 181 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SecuritySecurityCategory": 1, "SecurityRecordSelection": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "Security": { "AttemptRecordCode": 1, "Description": "text", "EventLogCode": 1, "Level": 1, "SecurityCategory": 1, "RecordSelection": 1 } }
Returns the security with select fields
POST /nexum/627/2022.01/parameter/getSecuritySelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 377 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SecuritySecurityCategory": 1, "SecurityRecordSelection": 1, "SelectableFields": { "IncludeAllSecurityFields": true, "SecurityFields": { "AttemptRecordCode": true, "Description": true, "EventLogCode": true, "Level": true, "RecordSelection": true, "SecurityCategory": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of security
POST /nexum/627/2022.01/parameter/getSecurityPagedList 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" } } }
{ "Security": [ { "AttemptRecordCode": 1, "Description": "text", "EventLogCode": 1, "Level": 1, "SecurityCategory": 1, "RecordSelection": 1 } ], "Token": "text" }
Returns the list of security with select fields
POST /nexum/627/2022.01/parameter/getSecurityListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 320 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllSecurityFields": true, "SecurityFields": { "AttemptRecordCode": true, "Description": true, "EventLogCode": true, "Level": true, "RecordSelection": true, "SecurityCategory": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "SecurityList": { "hasReachedMaximumListSize": true, "Security": [ { "AttemptRecordCode": 1, "Description": "text", "EventLogCode": 1, "Level": 1, "SecurityCategory": 1, "RecordSelection": 1 } ] } }
Retrieve a list of select fields for security settings
POST /nexum/627/2022.01/parameter/searchSecuritySelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 352 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllSecurityFields": true, "SecurityFields": { "AttemptRecordCode": true, "Description": true, "EventLogCode": true, "Level": true, "RecordSelection": true, "SecurityCategory": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of security with select fields
POST /nexum/627/2022.01/parameter/getSecurityPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 414 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllSecurityFields": true, "SecurityFields": { "AttemptRecordCode": true, "Description": true, "EventLogCode": true, "Level": true, "RecordSelection": true, "SecurityCategory": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for security settings
POST /nexum/627/2022.01/parameter/searchSecurityPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 429 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllSecurityFields": true, "SecurityFields": { "AttemptRecordCode": true, "Description": true, "EventLogCode": true, "Level": true, "RecordSelection": true, "SecurityCategory": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update securities by ID
POST /nexum/627/2022.01/parameter/updateSecurityByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 279 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SecuritySecurityCategory": 1, "SecurityRecordSelection": 1, "SecurityUpdatableFields": { "AttemptRecordCode": 1, "Description": "text", "EventLogCode": 1, "Level": 1 }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
