Skip to main content

InterfaceTemplate

SubTemplate for Interface. Part of a InterfaceSpecificationTemplate. Defines templated fields with specific types (defined using JSON schema). All templatedFieldSpecifications must allow null as value.

type InterfaceTemplate implements BaseNode, BaseTemplate, Named, NamedNode, Node, SubTemplate {
  description: String!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  name: String!
  partOf: InterfaceSpecificationTemplate!
  templateFieldSpecifications(
    namePrefix: String
  ): [JSONField!]!
  usedIn(
    after: String
    before: String
    filter: InterfaceFilterInput
    first: Int
    last: Int
    orderBy: [InterfaceOrder!]
    skip: Int
  ): InterfaceConnection!
}

Fields​

InterfaceTemplate.description ● String! non-null scalar​

The description of this entity.

InterfaceTemplate.hasPermission ● Boolean! non-null scalar​

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

InterfaceTemplate.hasPermission.permission ● AllPermissionEntry enum​

The permission to check for

InterfaceTemplate.id ● ID! non-null scalar​

The unique id of this node

InterfaceTemplate.name ● String! non-null scalar​

The name of this entity.

InterfaceTemplate.partOf ● InterfaceSpecificationTemplate! non-null object​

The Template this SubTemplate is part of

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

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

InterfaceTemplate.templateFieldSpecifications.namePrefix ● String scalar​

Name of the extension field.

InterfaceTemplate.usedIn ● InterfaceConnection! non-null object​

Entities which use this template.

InterfaceTemplate.usedIn.after ● String scalar​

Get only items after the cursor

InterfaceTemplate.usedIn.before ● String scalar​

Get only items before the cursor

InterfaceTemplate.usedIn.filter ● InterfaceFilterInput input​

Filter for specific items in the connection

InterfaceTemplate.usedIn.first ● Int scalar​

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

InterfaceTemplate.usedIn.last ● Int scalar​

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

InterfaceTemplate.usedIn.orderBy ● [InterfaceOrder!] list input​

Order in which the items are sorted

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

SubTemplate interface​

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.

Member of​

Interface object ● InterfaceSpecificationTemplate object