REST API for Oracle Blockchain Platform Enterprise Edition

Add an OSN to a Channel

post

/console/admin/api/v2/channels/{channelName}/orderers/joinOSN

Add an ordering service node (OSN) to a channel.

Request

Supported Media Types

application/json

Path Parameters

channelName(required): string

the specified channel name

New orderer (identified by orderer ID) to be joined

Root Schema : joinOSNBody

Type: object

Show Source

orderer: string

{
    "type":"object",
    "properties":{
        "orderer":{
            "type":"string"
        }
    },
    "example":{
        "orderer":"example-org-orderer0"
    }
}

Example:

{
    "orderer":"example-org-orderer0"
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : 200successModels

Type: object

Show Source

key: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "status":"success"
    }
}

Example:

{
    "status":"success"
}

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

403 Response

Forbidden

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