Skip to main content

RelationTemplate

Template for Relations. Defines templated fields with specific types (defined using JSON schema). Defines which Relations can use this Template. At least one RelationCondition has to match.

type RelationTemplate implements BaseNode, BaseTemplate, Named, NamedNode, Node, Template {
  description: String!
  extendedBy(
    after: String
    before: String
    filter: RelationTemplateFilterInput
    first: Int
    last: Int
    orderBy: [RelationTemplateOrder!]
    skip: Int
  ): RelationTemplateConnection!
  extends(
    after: String
    before: String
    filter: RelationTemplateFilterInput
    first: Int
    last: Int
    orderBy: [RelationTemplateOrder!]
    skip: Int
  ): RelationTemplateConnection!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  isDeprecated: Boolean!
  markerType: MarkerType!
  name: String!
  relationConditions(
    after: String
    before: String
    filter: RelationConditionFilterInput
    first: Int
    last: Int
    orderBy: [RelationConditionOrder!]
    skip: Int
  ): RelationConditionConnection!
  stroke: StrokeStyle
  templateFieldSpecifications(
    namePrefix: String
  ): [JSONField!]!
  usedIn(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
}

Fields​

RelationTemplate.description ● String! non-null scalar​

The description of this entity.

RelationTemplate.extendedBy ● RelationTemplateConnection! non-null object​

Templates that extend this template.

RelationTemplate.extendedBy.after ● String scalar​

Get only items after the cursor

RelationTemplate.extendedBy.before ● String scalar​

Get only items before the cursor

RelationTemplate.extendedBy.filter ● RelationTemplateFilterInput input​

Filter for specific items in the connection

RelationTemplate.extendedBy.first ● Int scalar​

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

RelationTemplate.extendedBy.last ● Int scalar​

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

RelationTemplate.extendedBy.orderBy ● [RelationTemplateOrder!] list input​

Order in which the items are sorted

RelationTemplate.extendedBy.skip ● Int scalar​

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

RelationTemplate.extends ● RelationTemplateConnection! non-null object​

Template this template extends.

RelationTemplate.extends.after ● String scalar​

Get only items after the cursor

RelationTemplate.extends.before ● String scalar​

Get only items before the cursor

RelationTemplate.extends.filter ● RelationTemplateFilterInput input​

Filter for specific items in the connection

RelationTemplate.extends.first ● Int scalar​

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

RelationTemplate.extends.last ● Int scalar​

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

RelationTemplate.extends.orderBy ● [RelationTemplateOrder!] list input​

Order in which the items are sorted

RelationTemplate.extends.skip ● Int scalar​

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

RelationTemplate.hasPermission ● Boolean! non-null scalar​

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

RelationTemplate.hasPermission.permission ● AllPermissionEntry enum​

The permission to check for

RelationTemplate.id ● ID! non-null scalar​

The unique id of this node

RelationTemplate.isDeprecated ● Boolean! non-null scalar​

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

RelationTemplate.markerType ● MarkerType! non-null enum​

The type of the marker at the end of the relation.

RelationTemplate.name ● String! non-null scalar​

The name of this entity.

RelationTemplate.relationConditions ● RelationConditionConnection! non-null object​

Defines which Relations can use this template, at least one RelationCondition has to match

RelationTemplate.relationConditions.after ● String scalar​

Get only items after the cursor

RelationTemplate.relationConditions.before ● String scalar​

Get only items before the cursor

RelationTemplate.relationConditions.filter ● RelationConditionFilterInput input​

Filter for specific items in the connection

RelationTemplate.relationConditions.first ● Int scalar​

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

RelationTemplate.relationConditions.last ● Int scalar​

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

RelationTemplate.relationConditions.orderBy ● [RelationConditionOrder!] list input​

Order in which the items are sorted

RelationTemplate.relationConditions.skip ● Int scalar​

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

RelationTemplate.stroke ● StrokeStyle object​

Style of the stroke

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

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

RelationTemplate.templateFieldSpecifications.namePrefix ● String scalar​

Name of the extension field.

RelationTemplate.usedIn ● RelationConnection! non-null object​

Entities which use this template.

RelationTemplate.usedIn.after ● String scalar​

Get only items after the cursor

RelationTemplate.usedIn.before ● String scalar​

Get only items before the cursor

RelationTemplate.usedIn.filter ● RelationFilterInput input​

Filter for specific items in the connection

RelationTemplate.usedIn.first ● Int scalar​

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

RelationTemplate.usedIn.last ● Int scalar​

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

RelationTemplate.usedIn.orderBy ● [RelationOrder!] list input​

Order in which the items are sorted

RelationTemplate.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).

Returned by​

searchRelationTemplates query

Member of​

Relation object ● RelationTemplateConnection object ● RelationTemplateEdge object