Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve name field name
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/getNameFieldName HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 147 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "NameFieldNameField": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "NameFieldName": { "Field": 1, "FieldName": "text" } }
Retrieve name field name select fields
POST /nexum/627/2022.01/parameter/getNameFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 259 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "NameFieldNameField": 1, "SelectableFields": { "IncludeAllNameFieldNameFields": true, "NameFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve paged list of name field names
POST /nexum/627/2022.01/parameter/getNameFieldNamePagedList 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" } } }
{ "NameFieldName": [ { "Field": 1, "FieldName": "text" } ], "Token": "text" }
Retrieve name field name list select fields
POST /nexum/627/2022.01/parameter/getNameFieldNameListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 236 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllNameFieldNameFields": true, "NameFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "NameFieldNameList": { "hasReachedMaximumListSize": true, "NameFieldName": [ { "Field": 1, "FieldName": "text" } ] } }
Retrieve a list of select fields for searching by name field names.
POST /nexum/627/2022.01/parameter/searchNameFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 268 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllNameFieldNameFields": true, "NameFieldNameFields": { "Field": true, "FieldName": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve paged list select fields of name field names
POST /nexum/627/2022.01/parameter/getNameFieldNamePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 330 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllNameFieldNameFields": true, "NameFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a list of paged select fields for searching by name field names.
POST /nexum/627/2022.01/parameter/searchNameFieldNamePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 345 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllNameFieldNameFields": true, "NameFieldNameFields": { "Field": true, "FieldName": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update name field names by ID
POST /nexum/627/2022.01/parameter/updateNameFieldNameByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 199 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "NameFieldNameField": 1, "NameFieldNameUpdatableFields": { "FieldName": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
