Jump to

• Request
• Response

Get Channel Block Data

get

/console/admin/api/v2/channels/{channelName}/blocks/{blockId}

If you have the channel name and block ID, you can get one block of data from a channel.

Request

Supported Media Types

• application/json

Path Parameters

• blockId: string
  Block ID
• channelName: string
  Channel name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Block data

Body ()

Root Schema : blockData

Type: object

Show Source

• data(optional): object data
• header(optional): object header

{
    "type":"object",
    "properties":{
        "header":{
            "type":"object"
        },
        "data":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : header

Type: object

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"
}

401 Response

Unauthorized

500 Response

Internal server error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

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

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

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