Last updated 10 months ago
Was this helpful?
Perform various operations on wire service message records.
Symitar eDocs References: Coming soon.
Retrieves a wire service message
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/wire/getWireServiceMessage HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 177 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "WireServiceMessageLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "WireServiceMessage": { "Locator": 1, "Text": [ { "EntryId": 1, "Text": "text" } ] } }
Retrieves a wire service message with selected fields
POST /nexum/627/2022.01/wire/getWireServiceMessageSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 295 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "WireServiceMessageLocator": 1, "SelectableFields": { "IncludeAllWireServiceMessageFields": true, "WireServiceMessageFields": { "Locator": true, "Text": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieves a paged list of wire service messages
POST /nexum/627/2022.01/wire/getWireServiceMessagePagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 241 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WireServiceMessage": [ { "Locator": 1, "Text": [ { "EntryId": 1, "Text": "text" } ] } ], "Token": "text" }
Retrieves a list of wire service messages with selected fields
POST /nexum/627/2022.01/wire/getWireServiceMessageListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 265 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "SelectableFields": { "IncludeAllWireServiceMessageFields": true, "WireServiceMessageFields": { "Locator": true, "Text": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WireServiceMessageList": { "hasReachedMaximumListSize": true, "WireServiceMessage": [ { "Locator": 1, "Text": [ { "EntryId": 1, "Text": "text" } ] } ] } }
Searches for wire service message with selected fields
POST /nexum/627/2022.01/wire/searchWireServiceMessageSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 297 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "SelectableFields": { "IncludeAllWireServiceMessageFields": true, "WireServiceMessageFields": { "Locator": true, "Text": [ 1 ] } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieves a paged list of wire service messages with selected fields
POST /nexum/627/2022.01/wire/getWireServiceMessagePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 359 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWireServiceMessageFields": true, "WireServiceMessageFields": { "Locator": true, "Text": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Searches for wire service message paged with selected fields
POST /nexum/627/2022.01/wire/searchWireServiceMessagePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 374 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWireServiceMessageFields": true, "WireServiceMessageFields": { "Locator": true, "Text": [ 1 ] } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Updates service message for a wire by ID
POST /nexum/627/2022.01/wire/updateWireServiceMessageByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 252 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireServiceMessageLocator": 1, "WireServiceMessageUpdatableFields": { "Text": [ { "EntryId": 1, "Text": "text" } ] }, "WireSequenceNumber": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
