Jump to

• Request
• Response

Get Response of Asynchronous Transaction

get

/restproxy/api/v2/channels/{channelName}/transactions/async/{trackingID}

Gets the response of an asynchronous transaction.

Request

Supported Media Types

• application/json

Path Parameters

• channelName(required): string
  ID of the channel
• trackingID(required): string
  Tracking ID of the asynchronous transaction returned by the rest proxy

Query Parameters

• role: string
  Which Hyperledger Fabric enrollment should be used

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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",
                "status"
            ],
            "properties":{
                "txid":{
                    "description":"Transaction ID",
                    "type":"string"
                },
                "status":{
                    "description":"Transaction status",
                    "type":"string",
                    "enum":[
                        "valid",
                        "invalid",
                        "not found"
                    ]
                },
                "message":{
                    "type":"string"
                },
                "blockNumber":{
                    "type":"integer"
                },
                "payload":{
                    "$ref":"#/definitions/AnyValue"
                },
                "encode":{
                    "$ref":"#/definitions/encode"
                }
            }
        }
    }
}

Nested Schema : result

Type: object

Show Source

• blockNumber: integer
• encode: string
  Allowed Values: [ "UTF-8", "JSON", "base64" ]
• message: string
• payload:
• status(required): string
  Allowed Values: [ "valid", "invalid", "not found" ]

  Transaction status
• txid(required): string
  Transaction ID

{
    "type":"object",
    "required":[
        "txid",
        "status"
    ],
    "properties":{
        "txid":{
            "description":"Transaction ID",
            "type":"string"
        },
        "status":{
            "description":"Transaction status",
            "type":"string",
            "enum":[
                "valid",
                "invalid",
                "not found"
            ]
        },
        "message":{
            "type":"string"
        },
        "blockNumber":{
            "type":"integer"
        },
        "payload":{
            "$ref":"#/definitions/AnyValue"
        },
        "encode":{
            "$ref":"#/definitions/encode"
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

403 Response

Forbidden

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Back to Top