Skip to main content

ObjectsResponse Schema

undefined#/responses/objects

ObjectsResponse is the response of the Objects query.

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedYesUnknown statusNoForbiddenForbiddennonecw-storage.json*

objects Type

object (ObjectsResponse)

objects Properties

PropertyTypeRequiredNullableDefined by
dataarrayRequiredcannot be nullcw-storage
page_infoMergedRequiredcannot be nullcw-storage

data

The list of objects in the bucket.

data

  • is required

  • Type: unknown[]

  • cannot be null

  • defined in: cw-storage

data Type

unknown[]

page_info

The page information.

page_info

page_info Type

merged type (Details)

all of

ObjectsResponse Definitions

Definitions group ObjectResponse

Reference this group by using

{"$ref":"undefined#/responses/objects/definitions/ObjectResponse"}
PropertyTypeRequiredNullableDefined by
idstringRequiredcannot be nullcw-storage
is_pinnedbooleanRequiredcannot be nullcw-storage
ownerstringRequiredcannot be nullcw-storage
sizeMergedRequiredcannot be nullcw-storage

id

The id of the object.

id

  • is required

  • Type: string

  • cannot be null

  • defined in: cw-storage

id Type

string

is_pinned

Tells if the object is pinned by at least one address.

is_pinned

  • is required

  • Type: boolean

  • cannot be null

  • defined in: cw-storage

is_pinned Type

boolean

owner

The owner of the object.

owner

  • is required

  • Type: string

  • cannot be null

  • defined in: cw-storage

owner Type

string

size

The size of the object.

size

size Type

merged type (Details)

all of

Definitions group PageInfo

Reference this group by using

{"$ref":"undefined#/responses/objects/definitions/PageInfo"}
PropertyTypeRequiredNullableDefined by
end_cursorstringRequiredcannot be nullcw-storage
has_next_pagebooleanRequiredcannot be nullcw-storage
has_previous_pagebooleanRequiredcannot be nullcw-storage
start_cursorstringRequiredcannot be nullcw-storage

end_cursor

The cursor to the previous page.

end_cursor

  • is required

  • Type: string

  • cannot be null

  • defined in: cw-storage

end_cursor Type

string

has_next_page

Tells if there is a next page.

has_next_page

  • is required

  • Type: boolean

  • cannot be null

  • defined in: cw-storage

has_next_page Type

boolean

has_previous_page

Tells if there is a previous page.

has_previous_page

  • is required

  • Type: boolean

  • cannot be null

  • defined in: cw-storage

has_previous_page Type

boolean

start_cursor

The cursor to the next page.

start_cursor

  • is required

  • Type: string

  • cannot be null

  • defined in: cw-storage

start_cursor Type

string

Definitions group Uint128

Reference this group by using

{"$ref":"undefined#/responses/objects/definitions/Uint128"}
PropertyTypeRequiredNullableDefined by