WireServiceMessage

Perform various operations on wire service message records.

Symitar eDocs References: Coming soon.

Operations

getWireServiceMessage

post

Retrieves a wire service message

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

WireServiceMessageLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getWireServiceMessage

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/getWireServiceMessage HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "WireServiceMessageLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessage": {
    "Locator": 1,
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ]
  }
}

getWireServiceMessageSelectFields

post

Retrieves a wire service message with selected fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

WireServiceMessageLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getWireServiceMessageSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/getWireServiceMessageSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessage": {
    "Locator": 1,
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ]
  }
}

getWireServiceMessagePagedList

post

Retrieves a paged list of wire service messages

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/getWireServiceMessagePagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/getWireServiceMessagePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessage": [
    {
      "Locator": 1,
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

getWireServiceMessageListSelectFields

post

Retrieves a list of wire service messages with selected fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/getWireServiceMessageListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/getWireServiceMessageListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessageList": {
    "hasReachedMaximumListSize": true,
    "WireServiceMessage": [
      {
        "Locator": 1,
        "Text": [
          {
            "EntryId": 1,
            "Text": "text"
          }
        ]
      }
    ]
  }
}

searchWireServiceMessageSelectFields

post

Searches for wire service message with selected fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/searchWireServiceMessageSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/searchWireServiceMessageSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessageList": {
    "hasReachedMaximumListSize": true,
    "WireServiceMessage": [
      {
        "Locator": 1,
        "Text": [
          {
            "EntryId": 1,
            "Text": "text"
          }
        ]
      }
    ]
  }
}

getWireServiceMessagePagedListSelectFields

post

Retrieves a paged list of wire service messages with selected fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/getWireServiceMessagePagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/getWireServiceMessagePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessage": [
    {
      "Locator": 1,
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

searchWireServiceMessagePagedSelectFields

post

Searches for wire service message paged with selected fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireSequenceNumberintegerOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchWireServiceMessagePagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/searchWireServiceMessagePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "WireServiceMessage": [
    {
      "Locator": 1,
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

updateWireServiceMessageByID

post

Updates service message for a wire by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

WireServiceMessageLocatorintegerOptional

WireSequenceNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/updateWireServiceMessageByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/wire/updateWireServiceMessageByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}