Skip to content
NexumAPI Docs

Comment⁠

Perform various operations for Symitar parameters.

Operations⁠

getCommentSelectFields⁠

POST

Execute the persistent ParameterService getCommentSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "CommentCommentType": 0,
  "CommentComment": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        0
      ],
      "DefaultChar": [
        0
      ],
      "DefaultNum": [
        0
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        0
      ],
      "Line1": [
        0
      ],
      "Line2": [
        0
      ],
      "MaxCode": [
        0
      ],
      "MaxLength": [
        0
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        0
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCommentPagedListSelectFields⁠

POST

Execute the persistent ParameterService getCommentPagedListSelectFields 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/getCommentPagedListSelectFields
POST /nexum/627/persistent/parameter/getCommentPagedListSelectFields 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": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        0
      ],
      "DefaultChar": [
        0
      ],
      "DefaultNum": [
        0
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        0
      ],
      "Line1": [
        0
      ],
      "Line2": [
        0
      ],
      "MaxCode": [
        0
      ],
      "MaxLength": [
        0
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        0
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCommentPagedSelectFields⁠

POST

Execute the persistent ParameterService searchCommentPagedSelectFields 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/searchCommentPagedSelectFields
POST /nexum/627/persistent/parameter/searchCommentPagedSelectFields 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": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        0
      ],
      "DefaultChar": [
        0
      ],
      "DefaultNum": [
        0
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        0
      ],
      "Line1": [
        0
      ],
      "Line2": [
        0
      ],
      "MaxCode": [
        0
      ],
      "MaxLength": [
        0
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        0
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        0
      ]
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateCommentByID⁠

POST

Execute the persistent ParameterService updateCommentByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "CommentCommentType": 0,
  "CommentComment": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "CommentFields": {
    "Comment": 0,
    "CommentType": 0,
    "DataType": [
      {
        "EntryId": 0,
        "DataType": 0
      }
    ],
    "DefaultChar": [
      {
        "EntryId": 0,
        "DefaultChar": "string"
      }
    ],
    "DefaultNum": [
      {
        "EntryId": 0,
        "DefaultNum": 0
      }
    ],
    "Description": "string",
    "Format": 0,
    "KeyCodePurpose": "string",
    "Line": [
      {
        "EntryId": 0,
        "Line": "string"
      }
    ],
    "Line1": [
      {
        "EntryId": 0,
        "Line1": "string"
      }
    ],
    "Line2": [
      {
        "EntryId": 0,
        "Line2": "string"
      }
    ],
    "MaxCode": [
      {
        "EntryId": 0,
        "MaxCode": 0
      }
    ],
    "MaxLength": [
      {
        "EntryId": 0,
        "MaxLength": 0
      }
    ],
    "MemberBillingCode": "string",
    "NonMemberBillingCode": "string",
    "Prompt": [
      {
        "EntryId": 0,
        "Prompt": "string"
      }
    ],
    "ReportingCode": "string",
    "ReportingDescription": "string",
    "Status": 0,
    "UserHelp": [
      {
        "EntryId": 0,
        "UserHelp": 0
      }
    ]
  },
  "nxAttributes": {
    "customFields": {}
  }
}