Skip to content

ArtefactTemplate

Template for Artefacts Defines templated fields with specific types (defined using JSON schema).

graphql
type ArtefactTemplate implements BaseNode, BaseTemplate, Named, NamedNode, Node, Template {
  description: String!
  extendedBy(
    after: String
    before: String
    filter: ArtefactTemplateFilterInput
    first: Int
    last: Int
    orderBy: [ArtefactTemplateOrder!]
    skip: Int
  ): ArtefactTemplateConnection!
  extends(
    after: String
    before: String
    filter: ArtefactTemplateFilterInput
    first: Int
    last: Int
    orderBy: [ArtefactTemplateOrder!]
    skip: Int
  ): ArtefactTemplateConnection!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  isAbstract: Boolean!
  isDeprecated: Boolean!
  name: String!
  templateFieldSpecifications(
    namePrefix: String
  ): [JSONField!]!
  usedIn(
    after: String
    before: String
    filter: ArtefactFilterInput
    first: Int
    last: Int
    orderBy: [ArtefactOrder!]
    skip: Int
  ): ArtefactConnection!
}

Fields

ArtefactTemplate.description ● String! non-null scalar

The description of this entity.

ArtefactTemplate.extendedBy ● ArtefactTemplateConnection! non-null object

Templates that extend this template.

ArtefactTemplate.extendedBy.after ● String scalar

Get only items after the cursor

ArtefactTemplate.extendedBy.before ● String scalar

Get only items before the cursor

ArtefactTemplate.extendedBy.filter ● ArtefactTemplateFilterInput input

Filter for specific items in the connection

ArtefactTemplate.extendedBy.first ● Int scalar

Get the first n items. Must not be used if before is specified

ArtefactTemplate.extendedBy.last ● Int scalar

Get the last n items. Must not be used if after is specified

ArtefactTemplate.extendedBy.orderBy ● [ArtefactTemplateOrder!] list input

Order in which the items are sorted

ArtefactTemplate.extendedBy.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ArtefactTemplate.extends ● ArtefactTemplateConnection! non-null object

Template this template extends.

ArtefactTemplate.extends.after ● String scalar

Get only items after the cursor

ArtefactTemplate.extends.before ● String scalar

Get only items before the cursor

ArtefactTemplate.extends.filter ● ArtefactTemplateFilterInput input

Filter for specific items in the connection

ArtefactTemplate.extends.first ● Int scalar

Get the first n items. Must not be used if before is specified

ArtefactTemplate.extends.last ● Int scalar

Get the last n items. Must not be used if after is specified

ArtefactTemplate.extends.orderBy ● [ArtefactTemplateOrder!] list input

Order in which the items are sorted

ArtefactTemplate.extends.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

ArtefactTemplate.hasPermission ● Boolean! non-null scalar

Checks if the current user has a specific permission on this Node

ArtefactTemplate.hasPermission.permission ● AllPermissionEntry enum

The permission to check for

ArtefactTemplate.id ● ID! non-null scalar

The unique id of this node

ArtefactTemplate.isAbstract ● Boolean! non-null scalar

If true, this template is abstract and cannot be used for new entities.

ArtefactTemplate.isDeprecated ● Boolean! non-null scalar

If true, this template is deprecated and cannot be used for new entities any more.

ArtefactTemplate.name ● String! non-null scalar

The name of this entity.

ArtefactTemplate.templateFieldSpecifications ● [JSONField!]! non-null object

All template field specifications, if a namePrefix is provided, only those matching it

ArtefactTemplate.templateFieldSpecifications.namePrefix ● String scalar

Name of the extension field.

ArtefactTemplate.usedIn ● ArtefactConnection! non-null object

Entities which use this template.

ArtefactTemplate.usedIn.after ● String scalar

Get only items after the cursor

ArtefactTemplate.usedIn.before ● String scalar

Get only items before the cursor

ArtefactTemplate.usedIn.filter ● ArtefactFilterInput input

Filter for specific items in the connection

ArtefactTemplate.usedIn.first ● Int scalar

Get the first n items. Must not be used if before is specified

ArtefactTemplate.usedIn.last ● Int scalar

Get the last n items. Must not be used if after is specified

ArtefactTemplate.usedIn.orderBy ● [ArtefactOrder!] list input

Order in which the items are sorted

ArtefactTemplate.usedIn.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

Interfaces

BaseNode interface

Shared extensions to the node type.

BaseTemplate interface

Base type for both Template and SubTemplate. Defines templated fields with specific types (defined using JSON schema). READ is always granted.

Named interface

Entity with a name and a description.

NamedNode interface

Node with a name and description

Node interface

Base class of all nodes

Template interface

BaseTemplate with composition features. Can have SubTemplates. Defines templated fields with specific types (defined using JSON schema).

Member Of

Artefact object ● ArtefactTemplateConnection object ● ArtefactTemplateEdge object ● CreateArtefactTemplatePayload object ● UpdateArtefactTemplatePayload object

Released under the MIT License.