Skip to main content

Template

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

interface Template implements BaseNode, BaseTemplate, Named, NamedNode, Node {
description: String!
hasPermission(
permission: AllPermissionEntry
): Boolean!
id: ID!
isDeprecated: Boolean!
name: String!
templateFieldSpecifications(
namePrefix: String
): [JSONField!]!
}

Fields

Template.description ● String! non-null scalar

The description of this entity.

Template.hasPermission ● Boolean! non-null scalar

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

Template.hasPermission.permission ● AllPermissionEntry enum

The permission to check for

Template.id ● ID! non-null scalar

The unique id of this node

Template.isDeprecated ● Boolean! non-null scalar

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

Template.name ● String! non-null scalar

The name of this entity.

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

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

Template.templateFieldSpecifications.namePrefix ● String scalar

Name of the extension field.

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

Implemented by

ArtefactTemplate object ● ComponentTemplate object ● IMSTemplate object ● InterfaceSpecificationTemplate object ● IssueTemplate object ● RelationPartnerTemplate interface ● RelationTemplate object