Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Participant 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/getParticipantFieldName HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 154 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ParticipantFieldNameField": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "ParticipantFieldName": { "Field": 1, "FieldName": "text" } }
Participant field name select fields
POST /nexum/627/2022.01/parameter/getParticipantFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 280 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ParticipantFieldNameField": 1, "SelectableFields": { "IncludeAllParticipantFieldNameFields": true, "ParticipantFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Participant field name paged list
POST /nexum/627/2022.01/parameter/getParticipantFieldNamePagedList 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" } } }
{ "ParticipantFieldName": [ { "Field": 1, "FieldName": "text" } ], "Token": "text" }
Participant field name list select fields
POST /nexum/627/2022.01/parameter/getParticipantFieldNameListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 250 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllParticipantFieldNameFields": true, "ParticipantFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ParticipantFieldNameList": { "hasReachedMaximumListSize": true, "ParticipantFieldName": [ { "Field": 1, "FieldName": "text" } ] } }
Retrieve a list of select fields for participant field names
POST /nexum/627/2022.01/parameter/searchParticipantFieldNameSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 282 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllParticipantFieldNameFields": true, "ParticipantFieldNameFields": { "Field": true, "FieldName": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Participant field name paged list select fields
POST /nexum/627/2022.01/parameter/getParticipantFieldNamePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 344 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllParticipantFieldNameFields": true, "ParticipantFieldNameFields": { "Field": true, "FieldName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for participant field names
POST /nexum/627/2022.01/parameter/searchParticipantFieldNamePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 359 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllParticipantFieldNameFields": true, "ParticipantFieldNameFields": { "Field": true, "FieldName": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update participant field names by ID
POST /nexum/627/2022.01/parameter/updateParticipantFieldNameByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 213 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ParticipantFieldNameField": 1, "ParticipantFieldNameUpdatableFields": { "FieldName": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
