network/list

Gets the list of networks.

Authorization

Access JSON Web Token (GetNetwork)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "name": {string},
    "namePattern": {string},
    "sortField": {string},
    "sortOrder": {string},
    "take": {integer},
    "skip": {integer}
}

Payload Parameters

Property nameRequiredTypeDescription
actionYesstringAction name: network/list
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
nameNostringFilter by network name.
namePatternNostringFilter by network name pattern. In pattern wildcards '%' and '_' can be used.
sortFieldNostringResult list sort field.
sortOrderNostringResult list sort order. Values are ASC and DES. The sortField should be specified.
takeNointegerNumber of records to take from the result list.
skipNointegerNumber of records to skip from the result list.

Response Topic and Payload

Topic

dh/response/network/[email protected]{clientId}

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "status": {string},
    "networks": [{
        "id": {string},
        "name": {string},
        "description": {string}
    }]
}

Payload Parameters

Property NameTypeDescription
actionstringAction name: network/list
requestIdobjectRequest unique identifier as specified in the request message.
statusstringOperation execution status (success or error).
networksarrayThe array of networks.
networkobjectThe Network resource representing the user network.
network.idstringNetwork unique identifier.
network.namestringNetwork display name.
network.descriptionstringNetwork short description.