REST API for Oracle Blockchain Platform Enterprise Edition

Get a New Transaction ID and Nonce

get

/restproxy/api/v2/channels/{channelName}/transaction-id

Request an asynchronous-mode transaction ID and nonce by channel name and enrollment. The transaction will be invoked later in asynchronous mode.

Request

Supported Media Types

application/json

Path Parameters

channelName(required): string

ID of the channel

Query Parameters

role: string

Name of the Hyperledger Fabric enrollment to be used

Response

Supported Media Types

application/json

200 Response

Operation successful

Root Schema : schema

Type: object

Show Source

error: string
result: object result
returnCode(required): string

Allowed Values: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string"
        },
        "result":{
            "type":"object",
            "required":[
                "txid"
            ],
            "properties":{
                "txid":{
                    "description":"Transaction ID",
                    "type":"string"
                },
                "nonce":{
                    "description":"Nonce value",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : result

Type: object

Show Source

nonce: string

Nonce value
txid(required): string

Transaction ID

{
    "type":"object",
    "required":[
        "txid"
    ],
    "properties":{
        "txid":{
            "description":"Transaction ID",
            "type":"string"
        },
        "nonce":{
            "description":"Nonce value",
            "type":"string"
        }
    }
}

400 Response

Bad request

401 Response

Not authorized

403 Response

Forbidden

404 Response

Invalid parameters

500 Response

Service unavailable

Examples

This endpoint is used to generate asynchronous-mode transaction ID and nonce by channel ID and enrollment. The transaction will be invoked later in asynchronous mode. A nonce is a randomly generated number that can be used only once in an asynchronous transaction. It derives its name from number used only once.

The following example shows how to get a new asynchronous transaction ID and nonce by submitting a GET request on the REST resource using cURL.

curl -v -u <username>:<password> -X GET \
  "https://<rest proxy of your blockchain instance>/api/v2/channels/<channel_name>/transaction-id" \
  -H "accept: application/json"

For example,

curl -v -u <username>:<password> -X GET \
  "https://myvm.oracle.com:10001/restproxy/api/v2/channels/default/transaction-id" \
  -H "accept: application/json"

Note:

You can find the REST proxy value of your blockchain instance from the Nodes tab of your instance console.

Example of the Response Body

The following example shows the contents of the response body in JSON format. The transaction ID and nonce generated in the response can be used to execute an asynchronous transaction later.

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "afb7ebae607927a7d80caafd203e380443212045cb1f60ad26ce2bddd48fb7d9",
        "nonce": "bb8367a8ebf34eef53aa0e2eaca9039c1cb0b6f3a6c840ac"
    }
}