v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2022-07-19176455.9 KB
state
table

Get table item by handle and key.

Gets a table item for a table identified by the handle and the key for the item. Key and value types need to be passed in to help with key serialization and value deserialization.

post/tables/{table_handle}/item

Path parameters

table_handlestring uint128 required

the table handle

Request body

key_typestring required

String representation of an on-chain Move type identifier defined by the Move language.

Values:

  • bool
  • u8
  • u64
  • u128
  • address
  • signer
  • vector: vector<{non-reference MoveTypeId}>
  • struct: {address}::{module_name}::{struct_name}::<{generic types}>
  • reference: immutable & and mutable &mut references.
  • generic_type_parameter: it is always start with T and following an index number, which is the position of the generic type parameter in the struct or function generic type parameters definition.

Vector type value examples:

  • vector<u8>
  • vector<vector<u64>>
  • vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>

Struct type value examples:

  • 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
  • 0x1::account::Account

Reference type value examples:

  • &signer
  • &mut address
  • &mut vector<u8>
value_typestring required

String representation of an on-chain Move type identifier defined by the Move language.

Values:

  • bool
  • u8
  • u64
  • u128
  • address
  • signer
  • vector: vector<{non-reference MoveTypeId}>
  • struct: {address}::{module_name}::{struct_name}::<{generic types}>
  • reference: immutable & and mutable &mut references.
  • generic_type_parameter: it is always start with T and following an index number, which is the position of the generic type parameter in the struct or function generic type parameters definition.

Vector type value examples:

  • vector<u8>
  • vector<vector<u64>>
  • vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>

Struct type value examples:

  • 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
  • 0x1::account::Account

Reference type value examples:

  • &signer
  • &mut address
  • &mut vector<u8>
keystring required

Move bool type value is serialized into boolean.

Move u8 type value is serialized into integer.

Move u64 and u128 type value is serialized into string.

Move address type value(16 bytes Aptos account address) is serialized into hex-encoded string, which is prefixed with 0x and leading zeros are trimmed.

For example:

  • 0x1
  • 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into hex-encoded string with 0x prefix.

For example:

  • vector<u64>{255, 255} => ["255", "255"]
  • vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

  • 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"hello world"} is serialized as "hello world" in JSON.

Example request

{
  "key_type": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>",
  "value_type": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>",
  "key": "3344000000"
}

Response

Returns the table item value rendered in JSON.

object required