Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve the field name for the account
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/getAccountFieldName HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 150 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "AccountFieldNameField": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "AccountFieldName": { "Field": 1, "FieldName": "text" } }
Retrieve field names for accounts with selected fields
POST /nexum/627/2022.01/parameter/getAccountFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 268 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "AccountFieldNameField": 1, "SelectableFields": { "IncludeAllAccountFieldNameFields": true, "AccountFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of field names for accounts
POST /nexum/627/2022.01/parameter/getAccountFieldNamePagedList 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" } } }
{ "AccountFieldName": [ { "Field": 1, "FieldName": "text" } ], "Token": "text" }
Retrieve the list of field names with selectable fields for accounts
POST /nexum/627/2022.01/parameter/getAccountFieldNameListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 242 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllAccountFieldNameFields": true, "AccountFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "AccountFieldNameList": { "hasReachedMaximumListSize": true, "AccountFieldName": [ { "Field": 1, "FieldName": "text" } ] } }
Search account field name select fields
POST /nexum/627/2022.01/parameter/searchAccountFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 274 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllAccountFieldNameFields": true, "AccountFieldNameFields": { "Field": true, "FieldName": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of field names for accounts with selected fields
POST /nexum/627/2022.01/parameter/getAccountFieldNamePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 336 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllAccountFieldNameFields": true, "AccountFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Search account field name paged select fields
POST /nexum/627/2022.01/parameter/searchAccountFieldNamePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 351 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllAccountFieldNameFields": true, "AccountFieldNameFields": { "Field": true, "FieldName": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update Account Field Name by ID
POST /nexum/627/2022.01/parameter/updateAccountFieldNameByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 205 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "AccountFieldNameField": 1, "AccountFieldNameUpdatableFields": { "FieldName": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
