Term

Also known as Knowledge page, a Term is used to document your data.

type Term {
  id: ID!
  deprecatedAt: Timestamp
  depthLevel: Int
  descriptionRaw: String
  descriptionStateLexical: JSON
  externalDescription: String
  externalDescriptionSource: TermExternalDescriptionSource
  externalId: String
  icon: String
  isDescriptionGenerated: Boolean
  lastEditedAt: Timestamp
  name: String
  slug: String!
  url: String
  verifiedAt: Timestamp
  childrenTerms: [Term!]!
  deprecatedByUserId: String
  entityEditors: [EntityEditor!]!
  lastDescribedByUserId: String
  lastDescribedBy: User
  linkedTag: Tag
  ownerEntities: [OwnerEntity!]!
  parentTermId: String
  parentTerm: Term
  tagEntities: [TagEntity!]!
  teamOwnerEntities: [TeamOwnerEntity!]!
  verifiedByUserId: String
  verifiedBy: User
  createdAt: Timestamp!
  deletedAt: Timestamp
  updatedAt: Timestamp!
  description: String!
  isDeprecated: Boolean!
  isVerified: Boolean!
}

Fields

Term.id ● ID! non-null scalar general

Unique Catalog identifier of the resource

Term.deprecatedAt ● Timestamp scalar general

The time at which the term was deprecated

Term.depthLevel ● Int scalar general

The term depth - Default 0 is highest in hierarchy

Term.descriptionRaw ● String scalar general

The Catalog documentation for this term, as raw text

Term.descriptionStateLexical ● JSON scalar general

Rich-text description of this term as lexical JSON

Term.externalDescription ● String scalar general

The documentation from the external source for this term

Term.externalDescriptionSource ● TermExternalDescriptionSource enum general

The source of the documentation for this term

Term.externalId ● String scalar general

External ID of the term when synchronized from a source

Term.icon ● String scalar general

The icon associated to the term

Term.isDescriptionGenerated ● Boolean scalar general

True if the description has been generated, false otherwise

Term.lastEditedAt ● Timestamp scalar general

The time at which the term was last edited

Term.name ● String scalar general

The term name

Term.slug ● String! non-null scalar general

The unique slug of the term

Term.url ● String scalar general

The term's url in the external source

Term.verifiedAt ● Timestamp scalar general

The time at which the term was verified

Term.childrenTerms ● [Term!]! non-null object general

The children terms of this term

Term.deprecatedByUserId ● String scalar general

The term was deprecated by the user belonging to this ID

Term.entityEditors ● [EntityEditor!]! non-null object general

The entity editors this term points to

Term.lastDescribedByUserId ● String scalar general

The term was last described be the user belonging to this ID

Term.lastDescribedBy ● User object general

The term was last described by this user

Term.linkedTag ● Tag object general

The tag to which this term is linked

Term.ownerEntities ● [OwnerEntity!]! non-null object general

The individual owners of the term

Term.parentTermId ● String scalar general

The id of the parent term of this term

Term.parentTerm ● Term object general

The parent term of this term

Term.tagEntities ● [TagEntity!]! non-null object general

The tag entities belonging to this term

Term.teamOwnerEntities ● [TeamOwnerEntity!]! non-null object general

The team owners of the term

Term.verifiedByUserId ● String scalar general

The term is verified by the user belonging to this ID

Term.verifiedBy ● User object general

The term is verified by this user

Term.createdAt ● Timestamp! non-null scalar general

Date and time the resource was created

Term.deletedAt ● Timestamp scalar general

Date and time the resource was deleted

Term.updatedAt ● Timestamp! non-null scalar general

Date and time the resource was last updated

Term.description ● String! non-null scalar general

The term's raw description or the external one if empty

Term.isDeprecated ● Boolean! non-null scalar general

Whether this term has been marked as deprecated

Term.isVerified ● Boolean! non-null scalar general

Is the term verified?

Example

{
  "childrenTerms": [],
  "entityEditors": [
    {
      "sourceUser": {
        "unifiedUser": {
          "teamIds": []
        }
      }
    }
  ],
  "lastDescribedBy": {
    "ownerEntities": [
      {
        "ownerLabel": {}
      }
    ]
  },
  "linkedTag": {},
  "ownerEntities": [],
  "tagEntities": [
    {}
  ],
  "teamOwnerEntities": [
    {
      "team": {
        "teamOwnerEntities": []
      }
    }
  ]
}

Returned By

• createTerm mutation
• updateTerm mutation

Member Of

• DataProduct object
• EntitiesLink object
• GetTermsOutput object
• Term object