Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve share 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/getShareFieldName HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 148 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ShareFieldNameField": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "ShareFieldName": { "Field": 1, "FieldName": "text" } }
Retrieve getShareFieldNameSelectFields data.
POST /nexum/627/2022.01/parameter/getShareFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 262 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ShareFieldNameField": 1, "SelectableFields": { "IncludeAllShareFieldNameFields": true, "ShareFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of share field names
POST /nexum/627/2022.01/parameter/getShareFieldNamePagedList 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" } } }
{ "ShareFieldName": [ { "Field": 1, "FieldName": "text" } ], "Token": "text" }
Returns the list of share field names with select fields
POST /nexum/627/2022.01/parameter/getShareFieldNameListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 238 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllShareFieldNameFields": true, "ShareFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ShareFieldNameList": { "hasReachedMaximumListSize": true, "ShareFieldName": [ { "Field": 1, "FieldName": "text" } ] } }
Retrieve a list of select fields for share field names
POST /nexum/627/2022.01/parameter/searchShareFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 270 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllShareFieldNameFields": true, "ShareFieldNameFields": { "Field": true, "FieldName": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of share field names with select fields
POST /nexum/627/2022.01/parameter/getShareFieldNamePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 332 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllShareFieldNameFields": true, "ShareFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for share field names
POST /nexum/627/2022.01/parameter/searchShareFieldNamePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 347 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllShareFieldNameFields": true, "ShareFieldNameFields": { "Field": true, "FieldName": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update share field names by ID
POST /nexum/627/2022.01/parameter/updateShareFieldNameByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 201 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ShareFieldNameField": 1, "ShareFieldNameUpdatableFields": { "FieldName": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
