replaceCommsHub
Replace an existing Communications Hub with a new one and move existing devices to the new Hub.
Arguments
Input fields for replacing a Communications Hub.
Returns
ReplaceCommsHubReplace an existing Communications Hub with a new one and move existing devices to the new Hub.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-7899: An internal error occurred.
- KT-GB-4035: No device matching the old device ID was found.
- KT-GB-4036: The old device ID does not relate to a Communications Hub.
- KT-GB-4037: This request is not supported by the device's smartmeter adapter.
- KT-GB-4038: Error sending the request to replace the Communications Hub.
Allowed Viewers
Required Permissions
Can replace comms hubQuery Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation ReplaceCommsHub($input: ReplaceCommsHubInput!) {
replaceCommsHub(input: $input) {
requestReference
}
}
Variables
{
"input": ReplaceCommsHubInput
}
Response
{
"data": {
"replaceCommsHub": {
"requestReference": "choose-interview-walk-rest-site"
}
}
}