GraphQL RepositoriessolutionTemplate

`entities.solutionTemplate`

Read solution template records with the solutionTemplate repository, and change them with the solution template mutations. Same records as the REST SolutionTemplates entity.

Example: first three solution template recordsGraphQLcURL

query FirstSolutionTemplates {
  entities {
    solutionTemplate {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstSolutionTemplates { entities { solutionTemplate { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { solutionTemplate { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	SolutionTemplateEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[SolutionTemplateEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: SolutionTemplateFilterInput, orderBy: [SolutionTemplateOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[SolutionTemplateEntity!]!
QUERY	`getByCriteria`(filter: SolutionTemplateFilterInput, orderBy: [SolutionTemplateOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	SolutionTemplateEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createSolutionTemplate`(input: CreateSolutionTemplateInput!, validationLevel: [ValidationLevel!])	Create one record	CreateSolutionTemplatePayload
MUTATION	`updateSolutionTemplate`(input: UpdateSolutionTemplateInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateSolutionTemplatePayload
MUTATION	`bulkUpdateSolutionTemplate`(input: [CreateOrUpdateSolutionTemplateInput!]!, deleteInput: [DeleteSolutionTemplateInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateSolutionTemplatePayload
MUTATION	`deleteSolutionTemplate`(input: DeleteSolutionTemplateInput!)	Soft-delete	DeleteSolutionTemplatePayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

SolutionTemplateEntity object 10 fields: isDeleteProtected, id, isDeleted, …

Ready-made solution offered in the template gallery as a starting point for new solutions.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description of what the template sets up.
`name`	String!	Name of the entity and its default text representation.
`previewImageUrl`	String	URL of the template preview image shown in the template gallery.
`settings`	SolutionTemplateSchema!	Preview of the template's canvas: the nodes, edges and groups the created solution will contain. Read-only.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

SolutionTemplateEdge object 5 fields: id, name, sourceNodeId, …

A directed, typed edge between two template nodes.

Field	Type	Description
`id`	ID!	Unique identifier of this edge within the template.
`name`	String	Edge label, if the template defines one.
`sourceNodeId`	ID!	Id of the node the edge starts from.
`targetNodeId`	ID!	Id of the node the edge points to.
`type`	SolutionEdgeType!	Type of connection the edge represents.

SolutionTemplateEntityConnection object pageInfo: PageInfo!, edges: [SolutionTemplateEntityEdge]!, totalCount: Int

Paginated list of SolutionTemplate records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[SolutionTemplateEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

SolutionTemplateEntityEdge object node: SolutionTemplateEntity, cursor: String!

A Relay edge containing a SolutionTemplateEntity and its cursor.

Field	Type	Description
`node`	SolutionTemplateEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

SolutionTemplateFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for SolutionTemplate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[SolutionTemplateFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[SolutionTemplateFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	SolutionTemplateFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`description`	EntityFilterStringField	Free-text description of what the template sets up.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`previewImageUrl`	EntityFilterStringField	URL of the template preview image shown in the template gallery.

SolutionTemplateOrderByInput input Asc or Desc per field

Sorting of SolutionTemplate records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`description`	OrderByEnum	Free-text description of what the template sets up.
`name`	OrderByEnum	Name of the entity and its default text representation.
`previewImageUrl`	OrderByEnum	URL of the template preview image shown in the template gallery.

CreateOrUpdateSolutionTemplateInput input 8 fields: clientMutationId, id, modified, …

Field values of a SolutionTemplate record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description of what the template sets up.
`name`	String	Name of the entity and its default text representation.
`previewImageUrl`	String	URL of the template preview image shown in the template gallery.
`settings`	JSONString	Full template definition: the blueprint canvas (placeholder record ids), per-node creation blueprints and admin prerequisites. Instantiated into real records on create-from-template; clients only ever read the derived SolutionTemplateSchema projection.

CreateSolutionTemplateInput input 7 fields: clientMutationId, modified, created, …

Field values of a new SolutionTemplate record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description of what the template sets up.
`name`	String!	Name of the entity and its default text representation.
`previewImageUrl`	String	URL of the template preview image shown in the template gallery.
`settings`	JSONString!	Full template definition: the blueprint canvas (placeholder record ids), per-node creation blueprints and admin prerequisites. Instantiated into real records on create-from-template; clients only ever read the derived SolutionTemplateSchema projection.

DeleteSolutionTemplateInput input clientMutationId: String, id: ID!

Id of the SolutionTemplate record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateSolutionTemplateInput input 8 fields: clientMutationId, id, modified, …

Id of a SolutionTemplate record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description of what the template sets up.
`name`	String	Name of the entity and its default text representation.
`previewImageUrl`	String	URL of the template preview image shown in the template gallery.
`settings`	JSONString	Full template definition: the blueprint canvas (placeholder record ids), per-node creation blueprints and admin prerequisites. Instantiated into real records on create-from-template; clients only ever read the derived SolutionTemplateSchema projection.

BulkUpdateSolutionTemplatePayload object result: BulkUpdateResults!

Result of the bulkUpdateSolutionTemplate mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateSolutionTemplatePayload object solutionTemplate: SolutionTemplateEntity, clientMutationId: String

Result of the createSolutionTemplate mutation.

Field	Type	Description
`solutionTemplate`	SolutionTemplateEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteSolutionTemplatePayload object solutionTemplate: SolutionTemplateEntity, clientMutationId: String

Result of the deleteSolutionTemplate mutation.

Field	Type	Description
`solutionTemplate`	SolutionTemplateEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateSolutionTemplatePayload object solutionTemplate: SolutionTemplateEntity, clientMutationId: String

Result of the updateSolutionTemplate mutation.

Field	Type	Description
`solutionTemplate`	SolutionTemplateEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

SolutionTemplateGroup object id: ID!, position: Rectangle!, name: String!, color: Int!

A labelled container bundling template nodes.

Field	Type	Description
`id`	ID!	Unique identifier of this group within the template.
`position`	Rectangle!	Group rectangle (position and size) on the canvas; the created solution uses the same layout.
`name`	String!	Display label of the group.
`color`	Int!	Group color.

SolutionTemplateNodeInterface interface 5 fields: id, position, groupId, …

Common shape of every node in the template preview canvas.

Field	Type	Description
`id`	ID!	Unique identifier of this node within the template.
`position`	Position!	Node position on the canvas; the created solution places the node at the same position.
`groupId`	ID	Group this node belongs to, if any.
`name`	String!	Display name of the node in the template preview.
`description`	String	Explanation of what the node does, provided by the template. Null when the template gives none; always null for entity nodes.

SolutionTemplateSchema object nodes: [SolutionTemplateNodeInterface!]!, edges: [SolutionTemplateEdge!]!, groups: [SolutionTemplateGroup!]!

Preview canvas of a solution template: the nodes, edges and groups the created solution will contain, in the layout they will have after installation.

Field	Type	Description
`nodes`	[SolutionTemplateNodeInterface!]!	Nodes of the template.
`edges`	[SolutionTemplateEdge!]!	Typed edges between nodes.
`groups`	[SolutionTemplateGroup!]!	Visual groups bundling nodes.