Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Get the getInqDefinition data.
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/getInqDefinition HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 155 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "InqDefinitionInquiryNumber": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "InqDefinition": { "CardNameRecord": [ { "EntryId": 1, "CardNameRecord": 1 } ], "InqField": [ { "EntryId": 1, "InqField": 1 } ], "InquiryName": "text", "Selection": 1, "SubField": [ { "EntryId": 1, "SubField": 1 } ], "InquiryNumber": 1 } }
Get the getInqDefinitionSelectFields data.
POST /nexum/627/2022.01/parameter/getInqDefinitionSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 345 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "InqDefinitionInquiryNumber": 1, "SelectableFields": { "IncludeAllInqDefinitionFields": true, "InqDefinitionFields": { "CardNameRecord": [ 1 ], "InqField": [ 1 ], "InquiryName": true, "InquiryNumber": true, "Selection": true, "SubField": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Get the getInqDefinitionPagedList data.
POST /nexum/627/2022.01/parameter/getInqDefinitionPagedList 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" } } }
{ "InqDefinition": [ { "CardNameRecord": [ { "EntryId": 1, "CardNameRecord": 1 } ], "InqField": [ { "EntryId": 1, "InqField": 1 } ], "InquiryName": "text", "Selection": 1, "SubField": [ { "EntryId": 1, "SubField": 1 } ], "InquiryNumber": 1 } ], "Token": "text" }
Get the getInqDefinitionListSelectFields data.
POST /nexum/627/2022.01/parameter/getInqDefinitionListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 314 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllInqDefinitionFields": true, "InqDefinitionFields": { "CardNameRecord": [ 1 ], "InqField": [ 1 ], "InquiryName": true, "InquiryNumber": true, "Selection": true, "SubField": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "InqDefinitionList": { "hasReachedMaximumListSize": true, "InqDefinition": [ { "CardNameRecord": [ { "EntryId": 1, "CardNameRecord": 1 } ], "InqField": [ { "EntryId": 1, "InqField": 1 } ], "InquiryName": "text", "Selection": 1, "SubField": [ { "EntryId": 1, "SubField": 1 } ], "InquiryNumber": 1 } ] } }
Field for selecting various options related to searchinqdefinitionselectfields
POST /nexum/627/2022.01/parameter/searchInqDefinitionSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 346 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllInqDefinitionFields": true, "InqDefinitionFields": { "CardNameRecord": [ 1 ], "InqField": [ 1 ], "InquiryName": true, "InquiryNumber": true, "Selection": true, "SubField": [ 1 ] } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Get the getInqDefinitionPagedListSelectFields data.
POST /nexum/627/2022.01/parameter/getInqDefinitionPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 408 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllInqDefinitionFields": true, "InqDefinitionFields": { "CardNameRecord": [ 1 ], "InqField": [ 1 ], "InquiryName": true, "InquiryNumber": true, "Selection": true, "SubField": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Field for selecting various options related to searchinqdefinitionpagedselectfields
POST /nexum/627/2022.01/parameter/searchInqDefinitionPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 423 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllInqDefinitionFields": true, "InqDefinitionFields": { "CardNameRecord": [ 1 ], "InqField": [ 1 ], "InquiryName": true, "InquiryNumber": true, "Selection": true, "SubField": [ 1 ] } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/updateInqDefinitionByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 355 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "InqDefinitionInquiryNumber": 1, "InqDefinitionUpdatableFields": { "CardNameRecord": [ { "EntryId": 1, "CardNameRecord": 1 } ], "InqField": [ { "EntryId": 1, "InqField": 1 } ], "InquiryName": "text", "Selection": 1, "SubField": [ { "EntryId": 1, "SubField": 1 } ] }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
