Query

Data fetch operations.

GraphQL Schema definition

type Query {
#   Retrieve the specified folder
# 
#   An Enterprise subscription is required to use this query
# 
#   @error not.found
#   If the folder cannot be found.
# 
# Arguments
#   id: The id of the folder to retrieve.
folder(id: ID!): Folder 
#   Fetch the root folder for the provided organization
# 
#   An Enterprise subscription is required to use this query
# 
#   @error not.found
#   If the organization provided cannot be found.
rootFolder: Folder 
#   Retrieve a single model by ID.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies when searching on a `field` other than 
#   `id`.
# 
# Arguments
#   id: The id of the model to retrieve.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   If you need to list models using a non-unique secondary identifier
#   then use the models search instead which supports both exact and partial 
#   matches.
#   For example to list all the models with an internalId of `test` the request 
#   would
#   be `models(query: "internalId: test")`.
model(id: ID!, field: ModelIdField): Model 
#   Retrieve a page of models given an optional query.
# 
# Arguments
#   include: Include additional models in non-active states, such 
#   as demo or inactive.
# 
#   If unspecified only active models will be returned.
#   query: A free text search for models.  If unspecified all 
#   models within the current organization
#   will be returned.
#   sortBy: The order to return the results in, defaults to created 
#   time, descending.
#   Default: [{ "field": score, order: desc }]
#   pageSize: The maximum number of results to return in a single 
#   page.  If the requested pageSize exceeds
#   the maximum of 1000, the value 1000 will be used.
#   Default: 10
#   offset: An offset id for the next page to retrieve.  The value 
#   from `nextOffset` in the previous result should
#   be used to grab the next page.
models(
include: [SearchInclusion!],
query: String,
sortBy: [ModelSort!],
pageSize: Int,
offset: String
): ModelSearchResultList 
#   @beta Model Event Webhooks
# 
#   Retrieve a list of model events for a particular org which are subscribed for 
#   webhook callbacks
# 
# Arguments
#   pageSize: The maximum number of results to return in a single 
#   page.  If the requested pageSize exceeds
#   the maximum of 1000, the value 1000 will be used.
#   Default: 10
#   offset: An offset id for the next page to retrieve.  The value 
#   from `nextOffset` in the previous result should
#   be used to grab the next page.
modelEventWebhookCallbacks(
pageSize: Int,
offset: String
): ModelEventWebhookCallbackList 
}
Require by

This element is not required by anyone