Jump to

• Request
• Response

Query Chaincode Definition in a Channel

get

/console/admin/api/v2/channels/{channelName}/chaincodeDefinitions

Query approved or committed chaincode definitions in a channel. The new chaincode lifecycle in Hyperledger Fabric 2.x involves approving and committing the chaincode during the deployment. The chaincode definition needs to be approved by a sufficient number of organizations to satisfy the channel's LifecycleEndorsement policy before the chaincode can be committed on the channel.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  ID of the channel

Query Parameters

• chaincodeName(optional): string
  Optionally query a specific chaincode name for approved or committed status in a channel
• sequence(optional): string
  Optionally query a specific chaincode sequence number for approved or committed status in a channel
• status: string
  Select if the query will return a list of approved or committed chaincode definitions in a channel

  Allowed Values: [ "Approved", "Committed" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object queryChaincodeInfo

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

Nested Schema : queryChaincodeInfo

Type: object

Show Source

• approvals(optional): object approvals
• collections(optional): object collections
• endorsement_plugin(optional): string
• sequence(optional): string
• source(optional): object source
• validation_plugin(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "endorsement_plugin":{
            "type":"string"
        },
        "validation_plugin":{
            "type":"string"
        },
        "collections":{
            "type":"object"
        },
        "source":{
            "type":"object"
        },
        "approvals":{
            "type":"object"
        }
    }
}

Nested Schema : approvals

Type: object

Nested Schema : collections

Type: object

Nested Schema : source

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

403 Response

Forbidden

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