ScreenDefinition⁠

Perform various operations for Symitar parameters.

Operations⁠

getScreenDefinitionSelectFields⁠

POST

Execute the persistent ParameterService getScreenDefinitionSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ScreenDefinitionScreenSelectionintegeroptional

ScreenDefinitionTypeintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/getScreenDefinitionSelectFields

POST /nexum/627/persistent/parameter/getScreenDefinitionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "ScreenDefinitionScreenSelection": 0,
  "ScreenDefinitionType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        0
      ],
      "Field5": [
        0
      ],
      "LCol": [
        0
      ],
      "Line": [
        0
      ],
      "RCol": [
        0
      ],
      "Row": [
        0
      ],
      "ScreenSelection": true,
      "Side": [
        0
      ],
      "SubField": [
        0
      ],
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getScreenDefinitionPagedListSelectFields⁠

POST

Execute the persistent ParameterService getScreenDefinitionPagedListSelectFields 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/getScreenDefinitionPagedListSelectFields

POST /nexum/627/persistent/parameter/getScreenDefinitionPagedListSelectFields 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": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        0
      ],
      "Field5": [
        0
      ],
      "LCol": [
        0
      ],
      "Line": [
        0
      ],
      "RCol": [
        0
      ],
      "Row": [
        0
      ],
      "ScreenSelection": true,
      "Side": [
        0
      ],
      "SubField": [
        0
      ],
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchScreenDefinitionPagedSelectFields⁠

POST

Execute the persistent ParameterService searchScreenDefinitionPagedSelectFields 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/searchScreenDefinitionPagedSelectFields

POST /nexum/627/persistent/parameter/searchScreenDefinitionPagedSelectFields 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": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        0
      ],
      "Field5": [
        0
      ],
      "LCol": [
        0
      ],
      "Line": [
        0
      ],
      "RCol": [
        0
      ],
      "Row": [
        0
      ],
      "ScreenSelection": true,
      "Side": [
        0
      ],
      "SubField": [
        0
      ],
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateScreenDefinitionByID⁠

POST

Execute the persistent ParameterService updateScreenDefinitionByID operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ScreenDefinitionScreenSelectionintegeroptional

ScreenDefinitionTypeintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/updateScreenDefinitionByID

POST /nexum/627/persistent/parameter/updateScreenDefinitionByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "ScreenDefinitionScreenSelection": 0,
  "ScreenDefinitionType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "ScreenDefinitionFields": {
    "Field1": [
      {
        "EntryId": 0,
        "Field1": 0
      }
    ],
    "Field5": [
      {
        "EntryId": 0,
        "Field5": "string"
      }
    ],
    "LCol": [
      {
        "EntryId": 0,
        "LCol": 0
      }
    ],
    "Line": [
      {
        "EntryId": 0,
        "Line": 0
      }
    ],
    "RCol": [
      {
        "EntryId": 0,
        "RCol": 0
      }
    ],
    "Row": [
      {
        "EntryId": 0,
        "Row": 0
      }
    ],
    "ScreenSelection": 0,
    "Side": [
      {
        "EntryId": 0,
        "Side": 0
      }
    ],
    "SubField": [
      {
        "EntryId": 0,
        "SubField": 0
      }
    ],
    "Type": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}