containerInstanceList
The containerInstanceList GraphQL API schema retrieves a list of container instances based on the specified entityName, tenant, filter, page, size, and sort parameters.
Argument | Description |
entityName | The name of the entity related to the container instances. Required |
tenant | The tenant string specifies the client's information for identification purposes. Required |
filter | Filter string to apply on the returned container instances. |
page | The page number for the set of container instances to be returned (for pagination). |
size | The number of container instances to be returned per page (for pagination). |
sort | Sort parameter used to order the returned list of container instances. |
The containerInstanceList schema returns an object with the following fields:
The data field includes a list of container instances, each of which has the following fields:
Field | Description |
createdAt | Timestamp of when the container instance was created. |
createdBy | User who created the container instance. |
data | Data associated with the container instance. |
entityInstanceId | Unique identifier for the container instance. |
entityName | Name of the entity related to the container instance. |
id | Unique identifier for the container instance. |
tenantId | Identifier for the tenant that the container instance belongs to. |
updatedAt | Timestamp of when the container instance was last updated. |
updatedBy | User who last updated the container instance. |
version | Version of the container instance. |
The pagination field includes pagination details of the container instance list:
Field | Description |
currPage | Current page number in the pagination. |
hasNextPage | Boolean indicating whether there is a next page in the pagination. |
nextPage | The next page number in the pagination. |
pageSize | The number of container instances per page in the pagination. |
prevPage | The previous page number in the pagination. |
totalCount | Total count of container instances in the pagination. |