---
title: entities.solutionTemplate
description: Read solution template records with the solutionTemplate repository, and change them with the solution template mutations. Same records as the REST SolutionTemplates entity.
canonical: https://developers.coevera.com/reference/graphql/solution-template/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# 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.

REST: [SolutionTemplates](https://developers.coevera.com/reference/rest/solution-templates.md).

## Queries

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

## Mutations

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

## Types

### SolutionTemplateEntity (object)

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

- `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)

A directed, typed edge between two template nodes.

- `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)

Paginated list of SolutionTemplate records.

- `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)

A Relay edge containing a `SolutionTemplateEntity` and its cursor.

- `node: SolutionTemplateEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### SolutionTemplateFilterInput (input)

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

- `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)

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

- `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)

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

- `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)

Field values of a new SolutionTemplate 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).
- `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)

Id of the SolutionTemplate record to delete.

- `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)

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

- `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 of the bulkUpdateSolutionTemplate mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateSolutionTemplatePayload (object)

Result of the createSolutionTemplate mutation.

- `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)

Result of the deleteSolutionTemplate mutation.

- `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)

Result of the updateSolutionTemplate mutation.

- `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)

A labelled container bundling template nodes.

- `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)

Common shape of every node in the template preview canvas.

- `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)

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

- `nodes: [SolutionTemplateNodeInterface!]!` Nodes of the template.
- `edges: [SolutionTemplateEdge!]!` Typed edges between nodes.
- `groups: [SolutionTemplateGroup!]!` Visual groups bundling nodes.

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

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

```bash
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 } } } } } }"}'
```
