SymXDeviceMap

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXDeviceMap

post

Retrieve getSymXDeviceMap data.

Authorizations
Body
SymXDeviceMapInstanceIdintegerOptional
SymXDeviceMapDeviceIdintegerOptional
Responses
200

Successful operation.

application/json
post
/getSymXDeviceMap
POST /nexum/627/2022.01/parameter/getSymXDeviceMap HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXDeviceMapInstanceId": 1,
  "SymXDeviceMapDeviceId": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMap": {
    "InstanceId": 1,
    "DeviceId": 1,
    "ClientNumber": 1,
    "Description": "text",
    "DeviceNumber": 1,
    "BalanceRecordNumber": 1,
    "DeviceType": "text"
  }
}

getSymXDeviceMapSelectFields

post

Retrieve getSymXDeviceMapSelectFields data.

Authorizations
Body
SymXDeviceMapInstanceIdintegerOptional
SymXDeviceMapDeviceIdintegerOptional
Responses
200

Successful operation.

application/json
post
/getSymXDeviceMapSelectFields
POST /nexum/627/2022.01/parameter/getSymXDeviceMapSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 398

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXDeviceMapInstanceId": 1,
  "SymXDeviceMapDeviceId": 1,
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true,
    "SymXDeviceMapFields": {
      "BalanceRecordNumber": true,
      "ClientNumber": true,
      "Description": true,
      "DeviceId": true,
      "DeviceNumber": true,
      "DeviceType": true,
      "InstanceId": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMap": {
    "InstanceId": 1,
    "DeviceId": 1,
    "ClientNumber": 1,
    "Description": "text",
    "DeviceNumber": 1,
    "BalanceRecordNumber": 1,
    "DeviceType": "text"
  }
}

getSymXDeviceMapPagedList

post

Retrieve getSymXDeviceMapPagedList data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getSymXDeviceMapPagedList
POST /nexum/627/2022.01/parameter/getSymXDeviceMapPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMap": [
    {
      "InstanceId": 1,
      "DeviceId": 1,
      "ClientNumber": 1,
      "Description": "text",
      "DeviceNumber": 1,
      "BalanceRecordNumber": 1,
      "DeviceType": "text"
    }
  ],
  "Token": "text"
}

getSymXDeviceMapListSelectFields

post

Retrieve getSymXDeviceMapListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getSymXDeviceMapListSelectFields
POST /nexum/627/2022.01/parameter/getSymXDeviceMapListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 344

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true,
    "SymXDeviceMapFields": {
      "BalanceRecordNumber": true,
      "ClientNumber": true,
      "Description": true,
      "DeviceId": true,
      "DeviceNumber": true,
      "DeviceType": true,
      "InstanceId": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMapList": {
    "hasReachedMaximumListSize": true,
    "SymXDeviceMap": [
      {
        "InstanceId": 1,
        "DeviceId": 1,
        "ClientNumber": 1,
        "Description": "text",
        "DeviceNumber": 1,
        "BalanceRecordNumber": 1,
        "DeviceType": "text"
      }
    ]
  }
}

searchSymXDeviceMapSelectFields

post

Retrieve a list of select fields for SymX device mappings

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchSymXDeviceMapSelectFields
POST /nexum/627/2022.01/parameter/searchSymXDeviceMapSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true,
    "SymXDeviceMapFields": {
      "BalanceRecordNumber": true,
      "ClientNumber": true,
      "Description": true,
      "DeviceId": true,
      "DeviceNumber": true,
      "DeviceType": true,
      "InstanceId": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMapList": {
    "hasReachedMaximumListSize": true,
    "SymXDeviceMap": [
      {
        "InstanceId": 1,
        "DeviceId": 1,
        "ClientNumber": 1,
        "Description": "text",
        "DeviceNumber": 1,
        "BalanceRecordNumber": 1,
        "DeviceType": "text"
      }
    ]
  }
}

getSymXDeviceMapPagedListSelectFields

post

Retrieve getSymXDeviceMapPagedListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getSymXDeviceMapPagedListSelectFields
POST /nexum/627/2022.01/parameter/getSymXDeviceMapPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 438

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true,
    "SymXDeviceMapFields": {
      "BalanceRecordNumber": true,
      "ClientNumber": true,
      "Description": true,
      "DeviceId": true,
      "DeviceNumber": true,
      "DeviceType": true,
      "InstanceId": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMap": [
    {
      "InstanceId": 1,
      "DeviceId": 1,
      "ClientNumber": 1,
      "Description": "text",
      "DeviceNumber": 1,
      "BalanceRecordNumber": 1,
      "DeviceType": "text"
    }
  ],
  "Token": "text"
}

searchSymXDeviceMapPagedSelectFields

post

Retrieve a paged list of select fields for SymX device mappings

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchSymXDeviceMapPagedSelectFields
POST /nexum/627/2022.01/parameter/searchSymXDeviceMapPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true,
    "SymXDeviceMapFields": {
      "BalanceRecordNumber": true,
      "ClientNumber": true,
      "Description": true,
      "DeviceId": true,
      "DeviceNumber": true,
      "DeviceType": true,
      "InstanceId": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXDeviceMap": [
    {
      "InstanceId": 1,
      "DeviceId": 1,
      "ClientNumber": 1,
      "Description": "text",
      "DeviceNumber": 1,
      "BalanceRecordNumber": 1,
      "DeviceType": "text"
    }
  ],
  "Token": "text"
}
PreviousSymXClientNextSymXGeneral

Last updated

Was this helpful?