The containers GraphQL API schema retrieves a list of containers based on the specified containerType, tenantId, filter, page, and sort parameters.
The type of the container to filter the data. Required
The tenantId string specifies the client's information for identification purposes. Required
Filter string to apply on the returned containers.
The page number for the set of containers to be returned (for pagination).
Sort parameter used to order the returned list of containers.
The containers schema returns an object with the following fields:
The data field includes a list of containers, each of which has the following fields:
Attributes associated with the container.
Type of the container.
Timestamp of when the container was created.
User who created the container.
Code related to an event associated with the container.
Unique identifier for the container.
Items present in the container. Each item has fields for code, cost, name, and quantity.
ID of the parent container.
Code representing a reason associated with the container.
Current state of the container.
Identifier for the tenant that the container belongs to.
Details for tracking the container.
Timestamp of when the container was last updated.
User who last updated the container.
The pagination field includes pagination details of the container list:
Current page number in the pagination.
Boolean indicating whether there is a next page in the pagination.
The next page number in the pagination.
The number of containers per page in the pagination.
The previous page number in the pagination.
Total count of containers in the pagination.