移動

• リクエスト
• レスポンス
• 例

トランザクションの送信

post

/restproxy/api/v2/channels/{channelId}/transactions

トランザクションを送信します

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• channelId: string
  チャネルのID

本文()

トランザクションを呼び出すリクエスト

ルート・スキーマ: schema

型: object

ソースの表示

• args: array args
  チェーンコードに対する引数
• chaincode: string
  呼び出すチェーンコードのID
• endorsers(オプション): array endorsers
  チェーンコードのエンドーサ
• nonce(オプション): string
  トランザクションのnonce
• role(オプション): string
  使用するFabric登録の名前
• sync(オプション): boolean
  デフォルト値: false

  チェーンコードを同期的に呼び出すかどうか
• timeout(オプション): integer(int64)
  デフォルト値: 18000

  チェーンコードの呼出しのタイムアウト(ミリ秒)
• transientMap(オプション): object transientMap
  使用可能なその他のプロパティ: additionalProperties

  チェーンコードのtransientMap
• txid(オプション): string
  トランザクションのID

{
    "type":"object",
    "required":[
        "chaincode",
        "args"
    ],
    "properties":{
        "role":{
            "description":"Name of the Fabric enrollment to be used",
            "type":"string"
        },
        "txid":{
            "description":"ID of the transaction",
            "type":"string"
        },
        "nonce":{
            "description":"Nonce for the transaction",
            "type":"string"
        },
        "chaincode":{
            "description":"ID of the chaincode to invoke",
            "type":"string"
        },
        "args":{
            "description":"Arguments for the chaincode",
            "type":"array",
            "items":{
                "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",
            "default":18000
        },
        "transientMap":{
            "description":"TransientMap for the chaincode",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "sync":{
            "description":"Whether to invoke the chaincode synchronously",
            "type":"boolean",
            "default":false
        }
    }
}

ネストしたスキーマ: args

型: array

チェーンコードに対する引数

ソースの表示

• 配列: string

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

ネストしたスキーマ: endorsers

型: array

チェーンコードのエンドーサ

ソースの表示

• 配列: string

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

ネストしたスキーマ: transientMap

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "description":"TransientMap for the chaincode",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

チェーンコードのtransientMap

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

201レスポンス

同期トランザクションの操作の成功

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• error(オプション): string
  デフォルト値:
• result(オプション): object result
• returnCode: string
  許容値: [ "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"
                }
            }
        }
    }
}

ネストしたスキーマ: result

型: object

ソースの表示

• encode: string
  許容値: [ "UTF-8", "JSON", "base64" ]
• message(オプション): string
• payload:
• txid: string

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

202レスポンス

非同期トランザクションの操作の成功

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• error(オプション): string
  デフォルト値:
• result(オプション): object result
• returnCode: string
  許容値: [ "Success", "Failure" ]

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

ネストしたスキーマ: result

型: object

ソースの表示

• txid: string

{
    "type":"object",
    "required":[
        "txid"
    ],
    "properties":{
        "txid":{
            "type":"string"
        }
    }
}

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

401レスポンス

未認可

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

403レスポンス

禁止

404レスポンス

見つかりません

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

先頭に戻る

例

このエンドポイントは、新しいトランザクションIDおよびnonceを提供する非同期トランザクションを呼び出すために使用されます。

ノート:

このエンドポイントを起動する前に、新規トランザクションIDおよびnonceの取得エンドポイントを使用して、新しい非同期トランザクションIDおよびnonceを生成する必要があります。

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行し、非同期トランザクションを呼び出す方法を示しています。

curl -v -u <username>:<password> -X POST \
  "https://<rest proxy of your blockchain instance>/api/v2/channels/default/transactions" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  --data @<JSON file with the request parameters>

例:

curl -v -u <username>:<password> -X POST \
  "https://myvm.oracle.com:10001/restproxy/api/v2/channels/default/transactions" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" 
  --data @file.json

file.jsonの内容は次のとおりです。

{
 "txid": "bb248ef3f948cb107417c3f66ea144910644dee8086a370d44687fd9fe262233",
 "nonce": "b508e30891a738162a35ebd1b7f768f8e8520111e4201dd9",
 "chaincode": "obcs-example02",
 "args": [ "invoke","a","b","200" ],
 "timeout": 18000,
 "sync": false
}

説明:

• txidとnonceは、新規トランザクションIDおよびnonceの取得エンドポイントを使用して生成される値です。
• chaincodeは、Balance Transferサンプル・チェーンコードのチェーンコードIDです。
• argsは、呼び出すチェーンコード関数とそのパラメータを指定します。
• timeoutは、トランザクションがタイムアウトするまでの最大ミリ秒を指定します。
• syncがfalse値の場合は、これが同期トランザクションでないことを示します。

ノート:

Blockchainインスタンスのrestproxy値は、インスタンス・コンソールの「ノード」タブから確認できます。

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bb248ef3f948cb107417c3f66ea144910644dee8086a370d44687fd9fe262233",
        "payload": null,
        "encode": ""
    }
}

この場合、呼び出されたチェーンコード関数はチェーンコード問合せではなく、値を返さなかったため、payloadに返される値はnullです。

先頭に戻る