Dispatchables

Get a list of dispatchables for a pallet.

get

Returns a list of dispatchable item metadata for distpachable items of the specified palletId.

Path parameters

palletIdstringRequired

Name or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.

Query parameters

onlyIdsbooleanOptional

Only return the names (IDs) of the dispatchable items instead of every dispatchable's metadata.

Responses

200

successful operation

application/json

400

invalid blockId supplied for at query param

application/json

404

could not find pallet with palletId

application/json

get

HTTPcURLJavaScriptPython

GET /pallets/{palletId}/dispatchables HTTP/1.1
Host: dot-playbook.nownodes.io
Accept: */*

{
  "at": {
    "hash": "text",
    "height": "text"
  },
  "pallet": "democracy",
  "palletIndex": "14",
  "items": [
    {
      "name": "propose",
      "fields": [
        "text"
      ],
      "index": "0",
      "docs": "Information concerning any given dispatchable.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control.",
      "args": [
        "text"
      ]
    }
  ]
}

Get the value of a dispatchable item.

get

Returns the value stored under the dispatchableItemId.

Path parameters

palletIdstringRequired

Name or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.

dispatchableItemIdstringRequired

Id of the dispatchable item to query for.

Query parameters

metadatabooleanOptional

Include the dispatchable items metadata (including documentation) if set to true.

Default: false

Responses

200

successful operation

application/json

400

invalid blockId supplied for at query param

application/json

404

could not find resource with id

application/json

get

HTTPcURLJavaScriptPython

GET /pallets/{palletId}/dispatchables/{dispatchableItemId} HTTP/1.1
Host: dot-playbook.nownodes.io
Accept: */*

{
  "pallet": "democracy",
  "palletIndex": "14",
  "dispatchableItem": "vote",
  "metadata": {
    "name": "propose",
    "fields": [
      "text"
    ],
    "index": "0",
    "docs": "Information concerning any given dispatchable.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control.",
    "args": [
      "text"
    ]
  }
}