Jump to

• Request
• Response

Install a Chaincode

post

/console/admin/api/v2/chaincodes

Installs a chaincode. The chaincode must be BASE64 encoded zip file of source code, or a BASE64 encoded TAR.GZ of packaged chaincode (new in Oracle Blockchain Platform 22.2.1).

Request

Supported Media Types

• application/json

Body ()

Root Schema : installChaincode

Type: object

Show Source

• label(optional): string
  Required when the value of 'source.content' represents the chaincode source (.zip). Not allowed when 'source.isPackaged' is true.
• peers: array peers
• source: object source
• type(optional): string
  Allowed Values: [ "golang", "node", "java" ]

  Required when the value of 'source.content' represents the chaincode source (.zip). Not allowed when 'source.isPackaged' is true.

{
    "type":"object",
    "required":[
        "source",
        "peers"
    ],
    "properties":{
        "source":{
            "type":"object",
            "required":[
                "content",
                "fileName"
            ],
            "properties":{
                "content":{
                    "type":"string",
                    "description":"The content should be base64 encoded string of chaincode source (.zip) or chaincode package (tar.gz)."
                },
                "fileName":{
                    "type":"string"
                },
                "isPackaged":{
                    "type":"boolean",
                    "description":"True, if the value of 'source.content' represents chaincode package (tar.gz), or false, if it represents chaincode source (.zip)."
                }
            }
        },
        "label":{
            "type":"string",
            "description":"Required when the value of 'source.content' represents the chaincode source (.zip). Not allowed when 'source.isPackaged' is true."
        },
        "type":{
            "type":"string",
            "enum":[
                "golang",
                "node",
                "java"
            ],
            "description":"Required when the value of 'source.content' represents the chaincode source (.zip). Not allowed when 'source.isPackaged' is true."
        },
        "peers":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "url"
                ],
                "properties":{
                    "url":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "source":{
            "fileName":"example_cc",
            "content":"example chaincode code"
        },
        "label":"example",
        "type":"golang",
        "peers":[
            {
                "url":"grpcs://peer0.org1.example.com:7051"
            }
        ]
    }
}

Example:

{
    "source":{
        "fileName":"example_cc",
        "content":"example chaincode code"
    },
    "label":"example",
    "type":"golang",
    "peers":[
        {
            "url":"grpcs://peer0.org1.example.com:7051"
        }
    ]
}

Nested Schema : peers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "url"
        ],
        "properties":{
            "url":{
                "type":"string"
            }
        }
    }
}

Nested Schema : source

Type: object

Show Source

• content: string
  The content should be base64 encoded string of chaincode source (.zip) or chaincode package (tar.gz).
• fileName: string
• isPackaged(optional): boolean
  True, if the value of 'source.content' represents chaincode package (tar.gz), or false, if it represents chaincode source (.zip).

{
    "type":"object",
    "required":[
        "content",
        "fileName"
    ],
    "properties":{
        "content":{
            "type":"string",
            "description":"The content should be base64 encoded string of chaincode source (.zip) or chaincode package (tar.gz)."
        },
        "fileName":{
            "type":"string"
        },
        "isPackaged":{
            "type":"boolean",
            "description":"True, if the value of 'source.content' represents chaincode package (tar.gz), or false, if it represents chaincode source (.zip)."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• url: string

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Installed chaincode successfully

Body ()

Root Schema : installCCResp

Type: object

Show Source

• package_id(optional): string
• respMesg(optional): string

{
    "type":"object",
    "properties":{
        "respMesg":{
            "type":"string"
        },
        "package_id":{
            "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"
}

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