Skip to main content

SubTemplate

BaseTemplate which is part of a Template. Defines templated fields with specific types (defined using JSON schema). Does not provide any composition features, as composition is handled by the Template it is part of.

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

Fields​

SubTemplate.description ● String! non-null scalar​

The description of this entity.

SubTemplate.hasPermission ● Boolean! non-null scalar​

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

SubTemplate.hasPermission.permission ● AllPermissionEntry enum​

The permission to check for

SubTemplate.id ● ID! non-null scalar​

The unique id of this node

SubTemplate.name ● String! non-null scalar​

The name of this entity.

SubTemplate.templateFieldSpecifications ● [JSONField!]! non-null object​

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

SubTemplate.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​

ComponentVersionTemplate object ● IMSIssueTemplate object ● IMSProjectTemplate object ● IMSUserTemplate object ● InterfacePartTemplate object ● InterfaceSpecificationVersionTemplate object