REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

Get Transaction Scheduler Details

get

/restproxy/api/v2/channels/{channelName}/scheduleTransactions

Get the transaction scheduler details.

Request

Supported Media Types

application/json

Path Parameters

channelName(required): string

ID of the channel

Query Parameters

role: string

Which Hyperledger Fabric enrollment should be used
schedulerID: string

ID of the scheduler that needs to be retrieved
userID: string

User's name. It should be the same as user defined in basic auth.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: object

Show Source

error: string

Default Value:

Error message when it fails
result: object result
returnCode(required): string

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

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string",
            "description":"Error message when it fails",
            "default":""
        },
        "result":{
            "type":"object",
            "properties":{
                "schedulerID":{
                    "description":"The ID associated with the scheduler",
                    "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"
                    }
                },
                "sameOrgEndorser":{
                    "description":"Whether it should select endorsers of this org only. When set to true, endorsers field cannot be specified.",
                    "type":"boolean",
                    "default":false
                },
                "expires":{
                    "description":"Expiration of the scheduler",
                    "type":"string"
                },
                "interval":{
                    "description":"Interval at which the scheduler will run the transaction. It can be either based on number of blocks or number of minutes.",
                    "type":"object",
                    "properties":{
                        "blocks":{
                            "description":"Run the transaction every 'n' number of blocks",
                            "type":"integer"
                        },
                        "time":{
                            "description":"Run the transaction every 'n' minutes",
                            "type":"integer"
                        }
                    }
                },
                "lastProcessedAt":{
                    "description":"Latest point at which the scheduler ran the transaction",
                    "type":"object",
                    "properties":{
                        "blockNum":{
                            "description":"Latest block number at which the scheduler ran the transaction",
                            "type":"integer"
                        },
                        "time":{
                            "description":"Latest time at which the scheduler ran the transaction",
                            "type":"integer"
                        }
                    }
                },
                "lastTransactionResult":{
                    "description":"Results of the last transaction run",
                    "type":"object",
                    "properties":{
                        "result":{
                            "type":"object",
                            "properties":{
                                "txid":{
                                    "description":"Transaction ID",
                                    "type":"string"
                                },
                                "message":{
                                    "type":"string"
                                },
                                "blockNumber":{
                                    "type":"integer"
                                },
                                "payload":{
                                    "$ref":"#/definitions/AnyValue"
                                },
                                "encode":{
                                    "$ref":"#/definitions/encode"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : result

Type: object

Show Source

args: array args

Arguments for the chaincode
chaincode: string

ID of the chaincode to invoke
endorsers: array endorsers

Endorsers for the chaincode
expires: string

Expiration of the scheduler
interval: object interval

Interval at which the scheduler will run the transaction. It can be either based on number of blocks or number of minutes.
lastProcessedAt: object lastProcessedAt

Latest point at which the scheduler ran the transaction
lastTransactionResult: object lastTransactionResult

Results of the last transaction run
sameOrgEndorser: boolean

Default Value: false

Whether it should select endorsers of this org only. When set to true, endorsers field cannot be specified.
schedulerID: string

The ID associated with the scheduler
timeout: integer(int64)

Default Value: 18000

Timeout in ms for the chaincode to invoke
transientMap: object transientMap

Additional Properties Allowed: additionalProperties

TransientMap for the chaincode

{
    "type":"object",
    "properties":{
        "schedulerID":{
            "description":"The ID associated with the scheduler",
            "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"
            }
        },
        "sameOrgEndorser":{
            "description":"Whether it should select endorsers of this org only. When set to true, endorsers field cannot be specified.",
            "type":"boolean",
            "default":false
        },
        "expires":{
            "description":"Expiration of the scheduler",
            "type":"string"
        },
        "interval":{
            "description":"Interval at which the scheduler will run the transaction. It can be either based on number of blocks or number of minutes.",
            "type":"object",
            "properties":{
                "blocks":{
                    "description":"Run the transaction every 'n' number of blocks",
                    "type":"integer"
                },
                "time":{
                    "description":"Run the transaction every 'n' minutes",
                    "type":"integer"
                }
            }
        },
        "lastProcessedAt":{
            "description":"Latest point at which the scheduler ran the transaction",
            "type":"object",
            "properties":{
                "blockNum":{
                    "description":"Latest block number at which the scheduler ran the transaction",
                    "type":"integer"
                },
                "time":{
                    "description":"Latest time at which the scheduler ran the transaction",
                    "type":"integer"
                }
            }
        },
        "lastTransactionResult":{
            "description":"Results of the last transaction run",
            "type":"object",
            "properties":{
                "result":{
                    "type":"object",
                    "properties":{
                        "txid":{
                            "description":"Transaction ID",
                            "type":"string"
                        },
                        "message":{
                            "type":"string"
                        },
                        "blockNumber":{
                            "type":"integer"
                        },
                        "payload":{
                            "$ref":"#/definitions/AnyValue"
                        },
                        "encode":{
                            "$ref":"#/definitions/encode"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : args

Type: array

Arguments for the chaincode

Show Source

Array of: string

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

Nested Schema : endorsers

Type: array

Endorsers for the chaincode

Show Source

Array of: string

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

Nested Schema : interval

Type: object

Interval at which the scheduler will run the transaction. It can be either based on number of blocks or number of minutes.

Show Source

blocks: integer

Run the transaction every 'n' number of blocks
time: integer

Run the transaction every 'n' minutes

{
    "description":"Interval at which the scheduler will run the transaction. It can be either based on number of blocks or number of minutes.",
    "type":"object",
    "properties":{
        "blocks":{
            "description":"Run the transaction every 'n' number of blocks",
            "type":"integer"
        },
        "time":{
            "description":"Run the transaction every 'n' minutes",
            "type":"integer"
        }
    }
}

Nested Schema : lastProcessedAt

Type: object

Latest point at which the scheduler ran the transaction

Show Source

blockNum: integer

Latest block number at which the scheduler ran the transaction
time: integer

Latest time at which the scheduler ran the transaction

{
    "description":"Latest point at which the scheduler ran the transaction",
    "type":"object",
    "properties":{
        "blockNum":{
            "description":"Latest block number at which the scheduler ran the transaction",
            "type":"integer"
        },
        "time":{
            "description":"Latest time at which the scheduler ran the transaction",
            "type":"integer"
        }
    }
}

Nested Schema : lastTransactionResult

Type: object

Results of the last transaction run

Show Source

result: object result

{
    "description":"Results of the last transaction run",
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "properties":{
                "txid":{
                    "description":"Transaction ID",
                    "type":"string"
                },
                "message":{
                    "type":"string"
                },
                "blockNumber":{
                    "type":"integer"
                },
                "payload":{
                    "$ref":"#/definitions/AnyValue"
                },
                "encode":{
                    "$ref":"#/definitions/encode"
                }
            }
        }
    }
}

Nested Schema : transientMap

Type: object

Additional Properties Allowed

Show Source

string

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

TransientMap for the chaincode

Nested Schema : result

Type: object

Show Source

blockNumber: integer
encode: string

Allowed Values: [ "UTF-8", "JSON", "base64" ]
message: string
payload:
txid: string

Transaction ID

{
    "type":"object",
    "properties":{
        "txid":{
            "description":"Transaction ID",
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "blockNumber":{
            "type":"integer"
        },
        "payload":{
            "$ref":"#/definitions/AnyValue"
        },
        "encode":{
            "$ref":"#/definitions/encode"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

403 Response

Forbidden

404 Response

Invalid parameters

500 Response

Service unavailable