Jump to

• Request
• Response

Unlock Atomic Transaction

put

/restproxy/api/v2/atomicTransactions/{globalTransactionId}

Unlock an atomic transaction. Sends a request to unlock chaincode keys locked by a previous atomic transaction.

Request

Supported Media Types

• application/json

Path Parameters

• globalTransactionId(required): string
  Global transaction ID

Body ()

Request to unlock chaincode keys locked by a previous atomic transaction

Root Schema : schema

Type: object

Show Source

• chaincode(required): string
  ID of the chaincode to invoke
• channel(required): string
  ID of the channel to invoke the transaction
• endorsers: array endorsers
  Endorsers for the chaincode
• isCommit: boolean
  Default Value: false

  Specify whether to commit or rollback the transaction. Optional.
• prepareTxid(required): string
  Transaction ID of the prepared transaction
• timeout: integer(int64)
  Timeout in ms for the chaincode to invoke

{
    "type":"object",
    "required":[
        "chaincode",
        "channel",
        "prepareTxid"
    ],
    "properties":{
        "channel":{
            "description":"ID of the channel to invoke the transaction",
            "type":"string"
        },
        "chaincode":{
            "description":"ID of the chaincode to invoke",
            "type":"string"
        },
        "endorsers":{
            "description":"Endorsers for the chaincode",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "timeout":{
            "description":"Timeout in ms for the chaincode to invoke",
            "type":"integer",
            "format":"int64"
        },
        "prepareTxid":{
            "description":"Transaction ID of the prepared transaction",
            "type":"string"
        },
        "isCommit":{
            "description":"Specify whether to commit or rollback the transaction. Optional.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : endorsers

Type: array

Endorsers for the chaincode

Show Source

• Array of: string

{
    "description":"Endorsers for the chaincode",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation for synchronous transaction

Body ()

Root Schema : schema

Type: object

Show Source

• error: string
  Default Value:
• result: object result
• returnCode(required): string
  Allowed Values: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string",
            "default":""
        },
        "result":{
            "type":"object",
            "required":[
                "txid",
                "payload",
                "encode"
            ],
            "properties":{
                "txid":{
                    "type":"string"
                },
                "message":{
                    "type":"string"
                },
                "payload":{
                    "$ref":"#/definitions/AnyValue"
                },
                "encode":{
                    "$ref":"#/definitions/encode"
                }
            }
        }
    }
}

Nested Schema : result

Type: object

Show Source

• encode(required): string
  Allowed Values: [ "UTF-8", "JSON", "base64" ]
• message: string
• payload(required):
• txid(required): string

{
    "type":"object",
    "required":[
        "txid",
        "payload",
        "encode"
    ],
    "properties":{
        "txid":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "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