Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve security field
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/getSecField HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 152 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SecFieldRecordSelection": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "SecField": { "CreSecField": [ { "EntryId": 1, "CreSecField": 1 } ], "ReqSecField": [ { "EntryId": 1, "ReqSecField": 1 } ], "RequireField": [ { "EntryId": 1, "RequireField": 1 } ], "RevSecField": [ { "EntryId": 1, "RevSecField": 1 } ], "RecordSelection": 1 } }
Returns the security fields with select fields
POST /nexum/627/2022.01/parameter/getSecFieldSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 320 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SecFieldRecordSelection": 1, "SelectableFields": { "IncludeAllSecFieldFields": true, "SecFieldFields": { "CreSecField": [ 1 ], "RecordSelection": true, "ReqSecField": [ 1 ], "RequireField": [ 1 ], "RevSecField": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of security fields
POST /nexum/627/2022.01/parameter/getSecFieldPagedList 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" } } }
{ "SecField": [ { "CreSecField": [ { "EntryId": 1, "CreSecField": 1 } ], "ReqSecField": [ { "EntryId": 1, "ReqSecField": 1 } ], "RequireField": [ { "EntryId": 1, "RequireField": 1 } ], "RevSecField": [ { "EntryId": 1, "RevSecField": 1 } ], "RecordSelection": 1 } ], "Token": "text" }
Returns the list of security fields with select fields
POST /nexum/627/2022.01/parameter/getSecFieldListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 292 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllSecFieldFields": true, "SecFieldFields": { "CreSecField": [ 1 ], "RecordSelection": true, "ReqSecField": [ 1 ], "RequireField": [ 1 ], "RevSecField": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "SecFieldList": { "hasReachedMaximumListSize": true, "SecField": [ { "CreSecField": [ { "EntryId": 1, "CreSecField": 1 } ], "ReqSecField": [ { "EntryId": 1, "ReqSecField": 1 } ], "RequireField": [ { "EntryId": 1, "RequireField": 1 } ], "RevSecField": [ { "EntryId": 1, "RevSecField": 1 } ], "RecordSelection": 1 } ] } }
Retrieve a list of select fields for security fields
POST /nexum/627/2022.01/parameter/searchSecFieldSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 324 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllSecFieldFields": true, "SecFieldFields": { "CreSecField": [ 1 ], "RecordSelection": true, "ReqSecField": [ 1 ], "RequireField": [ 1 ], "RevSecField": [ 1 ] } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of security fields with select fields
POST /nexum/627/2022.01/parameter/getSecFieldPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 386 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllSecFieldFields": true, "SecFieldFields": { "CreSecField": [ 1 ], "RecordSelection": true, "ReqSecField": [ 1 ], "RequireField": [ 1 ], "RevSecField": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for security fields
POST /nexum/627/2022.01/parameter/searchSecFieldPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 401 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllSecFieldFields": true, "SecFieldFields": { "CreSecField": [ 1 ], "RecordSelection": true, "ReqSecField": [ 1 ], "RequireField": [ 1 ], "RevSecField": [ 1 ] } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update security fields by ID
POST /nexum/627/2022.01/parameter/updateSecFieldByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 366 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SecFieldRecordSelection": 1, "SecFieldUpdatableFields": { "CreSecField": [ { "EntryId": 1, "CreSecField": 1 } ], "ReqSecField": [ { "EntryId": 1, "ReqSecField": 1 } ], "RequireField": [ { "EntryId": 1, "RequireField": 1 } ], "RevSecField": [ { "EntryId": 1, "RevSecField": 1 } ] }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
