network/get

Gets a network by ID.

Authorization

Access JSON Web Token (GetNetwork)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "networkId": {int}
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: network/get
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
networkIdYesintNetwork unique identifier.

Response Topic and Payload

Topic

dh/response/network/get@{clientId}

Payload Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "network": {
        "id": {int},
        "name": {string},
        "description": {string},
        "devices": [{object}]
    }
}

Payload Parameters

Property NameTypeDescription
actionstringAction name: network/get
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
networkobjectThe Network resource representing the current network.
network.idintNetwork unique identifier.
network.namestringNetwork display name.
network.descriptionstringNetwork short description.
network.devicesobjectNetwork's devices list.