network/get

Gets a network by ID.

Request Message

Authorization

Access JSON Web Token (GetNetwork)

Message Representation

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

Message Parameters

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

Server Message

Message Representation

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

Message 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.