Jump to

• Request
• Response
• Examples

Get a New Transaction ID and Nonce

get

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

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

Request

Supported Media Types

• application/json

Path Parameters

• channelId: string
  ID of the channel

Query Parameters

• role: string
  Name of the Fabric enrollment to be used

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation successful

Body ()

Root Schema : schema

Type: object

Show Source

• error(optional): string
• result(optional): object result
• returnCode: 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(optional): string
  Nonce value
• txid: string
  Transaction ID

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

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

403 Response

Forbidden

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top

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

Back to Top