Skip to content
NexumAPI Docs

InqDefinition⁠

Perform various operations for Symitar parameters.

Operations⁠

getInqDefinitionSelectFields⁠

POST

Execute the persistent ParameterService getInqDefinitionSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InqDefinitionInquiryNumberintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getInqDefinitionSelectFields
POST /nexum/627/persistent/parameter/getInqDefinitionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "InqDefinitionInquiryNumber": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        0
      ],
      "InqField": [
        0
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getInqDefinitionPagedListSelectFields⁠

POST

Execute the persistent ParameterService getInqDefinitionPagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getInqDefinitionPagedListSelectFields
POST /nexum/627/persistent/parameter/getInqDefinitionPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        0
      ],
      "InqField": [
        0
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchInqDefinitionPagedSelectFields⁠

POST

Execute the persistent ParameterService searchInqDefinitionPagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchInqDefinitionPagedSelectFields
POST /nexum/627/persistent/parameter/searchInqDefinitionPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        0
      ],
      "InqField": [
        0
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        0
      ]
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateInqDefinitionByID⁠

POST

Execute the persistent ParameterService updateInqDefinitionByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
InqDefinitionInquiryNumberintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updateInqDefinitionByID
POST /nexum/627/persistent/parameter/updateInqDefinitionByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "InqDefinitionInquiryNumber": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "InqDefinitionFields": {
    "CardNameRecord": [
      {
        "EntryId": 0,
        "CardNameRecord": 0
      }
    ],
    "InqField": [
      {
        "EntryId": 0,
        "InqField": 0
      }
    ],
    "InquiryName": "string",
    "InquiryNumber": 0,
    "Selection": 0,
    "SubField": [
      {
        "EntryId": 0,
        "SubField": 0
      }
    ]
  },
  "nxAttributes": {
    "customFields": {}
  }
}