network/update

Updates a network.

Authorization

Access JSON Web Token (ManageNetwork)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "networkId": {string},
    "network": {
        "name": {string},
        "description": {string}
    }
}

Payload Parameters

actionYesstringAction name: network/update
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
networkIdYesstringNetwork unique identifier.
networkYesobjectNetwork resource to insert.
network.nameNostringNetwork display name.
network.descriptionNostringNetwork short description.

Response Topic and Payload

Topic

dh/response/network/update@{clientId}

Payload Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object}
}

Payload Parameters

Property NameTypeDescription
actionstringAction name: network/update
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.