Jump to

• Request
• Response
• Examples

Get Current Number and List of Channels Joined by the Specified Peer

get

/console/admin/api/v1.1/dashboard/statistics/channelsJoined

Get the current number and list of channels joined by the specified peer.

Request

Supported Media Types

• application/json

Query Parameters

• nodeID(optional): string
  Node ID of a specific peer

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with a total number and a list of channel names for each peer by restriction

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsChannelsJoined"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object StatsChannelsJoined

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StatsChannelsJoined"
    }
}

Nested Schema : StatsChannelsJoined

Type: object

Show Source

• channelNum(optional): number
• channels(optional): array channels
• nodeID(optional): string

{
    "type":"object",
    "properties":{
        "nodeID":{
            "type":"string"
        },
        "channelNum":{
            "type":"number"
        },
        "channels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : channels

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top

Examples

This endpoint is used to get the current number and list of channels joined by the specified peer (if the peer is specified using nodeID), or on all peers if not specified. The result contains the total number and the list of channel names for each peer. Time range is not supported for channelsJoined.

The following example shows how to generate the channel list by submitting a GET request on the REST resource using cURL.

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v1.1/dashboard/statistics/channelsJoined?nodeID=<nodeID>"

For example,

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v1.1/dashboard/statistics/channelsJoined?nodeID=peer0-1"

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "data": [
    {
      "nodeID": "peer0-1",
      "channelNum": 4,
      "channels": [
        "tfzch01",
        "default",
        "mych01",
        "test"
      ]
    }
  ]
} 

Back to Top