IndexItem

Item represents a graph node within an Index. It serves as a structured way to organize and store data related to specific contexts.

Furthermore, any node within the ComposeDB ecosystem can be effectively indexed thanks to the Item schema. It provides a standardized approach to representing and managing various types of data, making it possible to seamlessly integrate and index diverse components.

Below is a description of the Item schema and its primary functions:

Item Schema

The Item schema consists of several key properties:

Property	Type	Description
indexId	StreamID	Identifier of the Index to which this item belongs.
index	Index	The actual Index object that this item is associated with, accessed through the indexId.
itemId	StreamID	Identifier of the item (node) represented in the Index.
node	Node	The actual Node object that this item represents, accessed through the itemId.
type	string	ComposeDB Model name of the indexed node. eg: WebPage
updatedAt	DateTime	The timestamp when the IndexItem was last updated, ensuring data accuracy.
deletedAt	DateTime	The timestamp when the IndexItem was deleted (if applicable).
indexedAt	DateTime	The timestamp of the Item's last index time.

List items in an index

get

/indexes/{indexId}/items

Path parameters

indexIdstringrequired

Index ID

Query parameters

querystring

cursorstring

limitinteger · default: 24

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://dev.index.network/api/indexes/{indexId}/items'

200

200

No body

Successful operation

Add item to index

post

/indexes/{indexId}/items/{itemId}

Authorizations

Path parameters

indexIdstringrequired

Index ID

itemIdstringrequired

Item ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev.index.network/api/indexes/{indexId}/items/{itemId}' \
  --header 'Authorization: Bearer DID_SESSION_SERIALIZED'

201

201

No body

Item added

Remove item from index

delete

/indexes/{indexId}/items/{itemId}

Authorizations

Path parameters

indexIdstringrequired

Index ID

itemIdstringrequired

Item ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://dev.index.network/api/indexes/{indexId}/items/{itemId}' \
  --header 'Authorization: Bearer DID_SESSION_SERIALIZED'

200

200

No body

Item removed