REST API for Oracle Blockchain Platform Enterprise Edition

Get Channel List

get

/console/admin/api/v2/channels

Get a list of channels, optionally filtering by whether they have a given chaincode instantiated or a given peer joined.

Request

Supported Media Types

application/json

Query Parameters

chaincode: string

List channels where this chaincode is instantiated
peerId: string

List channels that this peer has joined

Response

Supported Media Types

application/json

200 Response

List of channels meeting query criteria

Root Schema : channels

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "channelName":{
                "type":"string"
            },
            "creator":{
                "type":"string"
            },
            "mspIds":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

channelName: string
creator: string
mspIds: array mspIds

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "creator":{
            "type":"string"
        },
        "mspIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : mspIds

Type: array

Show Source

Array of: string

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

400 Response

Invalid arguments

Root Schema : 400errorModels

Type: object

Show Source

key: string
value: string

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

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

500 Response

Internal server error

Root Schema : 500errorModels

Type: object

Show Source

key: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Root Schema : errorModel

Type: object

Show Source

code(required): integer(int32)
message(required): string

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