SymXDeviceMap

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXDeviceMap

post

Retrieve SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SymXDeviceMapInstanceIdintegerOptional

SymXDeviceMapDeviceIdintegerOptional

Responses

200

Successful operation.

application/json

post/getSymXDeviceMap

HTTPcURLJavaScriptPython

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: 211

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SymXDeviceMapInstanceId": 1,
  "SymXDeviceMapDeviceId": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXDeviceMap": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXDeviceMap"
}

getSymXDeviceMapSelectFields

post

Retrieve SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SymXDeviceMapInstanceIdintegerOptional

SymXDeviceMapDeviceIdintegerOptional

Responses

200

Successful operation.

application/json

post/getSymXDeviceMapSelectFields

HTTPcURLJavaScriptPython

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: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true
  }
}

200

Successful operation.

{
  "SymXDeviceMap": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXDeviceMapSelectFields"
}

getSymXDeviceMapPagedList

post

Retrieve SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSymXDeviceMapPagedList

HTTPcURLJavaScriptPython

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: 260

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXDeviceMap": [],
  "Token": null,
  "MessageId": "getSymXDeviceMapPagedList"
}

getSymXDeviceMapListSelectFields

post

Retrieve SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getSymXDeviceMapListSelectFields

HTTPcURLJavaScriptPython

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: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true
  }
}

200

Successful operation.

{
  "SymXDeviceMapList": [],
  "MessageId": "getSymXDeviceMapListSelectFields"
}

searchSymXDeviceMapSelectFields

post

Search SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchSymXDeviceMapSelectFields

HTTPcURLJavaScriptPython

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: 256

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllSymXDeviceMapFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXDeviceMapList": [],
  "MessageId": "searchSymXDeviceMapSelectFields"
}

getSymXDeviceMapPagedListSelectFields

post

Retrieve SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSymXDeviceMapPagedListSelectFields

HTTPcURLJavaScriptPython

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: 337

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "SymXDeviceMapFields": {
      "InstanceId": true,
      "DeviceId": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "SymXDeviceMap": [
    {
      "Description": "Note",
      "DeviceId": 0,
      "InstanceId": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getSymXDeviceMapPagedListSelectFields"
}

searchSymXDeviceMapPagedSelectFields

post

Search SymXDeviceMap parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchSymXDeviceMapPagedSelectFields

HTTPcURLJavaScriptPython

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: 348

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "SymXDeviceMapFields": {
      "InstanceId": true,
      "DeviceId": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "SymXDeviceMap": [
    {
      "Description": "Note",
      "DeviceId": 0,
      "InstanceId": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchSymXDeviceMapPagedSelectFields"
}