Using the GraphQL API

Each node in a Uni hosts a GraphQL API that provides full CRUD support for your data model in addition to extended functionality such as working with Files.


Vendia generates the following GraphQL queries for the top-level entities in your data model.


Supports retrieving an item by id.


Supports listing items. Returns a nextToken that can be used for pagination.


Vendia generates the following GraphQL mutations for the top-level entities in your data model.

Note: Mutations containing "_async" execute asynchronously and return a transactionId that can be used for status polling and correlation purposes. To configure failure notifications for asynchronous mutations, see Dead-letter notifications.

add_X_async / remove_X_async

Supports adding and removing items for array types.

create_X_async / delete_X_async

Supports creating and deleting items for object types.


Put mutations update an item by replacing the entire item with the input specified in the mutation. All required fields must be specified in the input, and any absent fields will be removed in the datastore.


   id: "234160b5-58f1-485c-9745-737e539eb20f", 
   input: { 
       name: "square", 
       color: "red", 
       numSides: 4 
) {error}


Supports partial update of an item. Only the fields specified in the input will be updated. Fields absent in the input are preserved in the datastore. Fields can be explicitly removed by specifying a null value.


   id: "234160b5-58f1-485c-9745-737e539eb20f", 
   input: { 
       name: null, 
       numSides: 5
) {error}

This mutation removes the name field, preserves the existing value of the color field, and updates the numSides field.

Note: Nested objects can be explicitly removed if they do not contain required fields. i.e.

   id: "234160b5-58f1-485c-9745-737e539eb20f", 
   input: { 
       nestedObject: null
) {error}

Next Steps

Using File Storage

Integrating a Vendia chain with other Cloud, Web, and Mobile Services

Learning More

Terms and Definitions

Show table of contents
Edit this page