Skip to main content

SchemaDefinition

type SchemaDefinition implements Node {
  id: ID!
  createdAt: Time!
  updatedAt: Time!
  companyID: String!
  apiName: String!
  name: String!
  pluralName: String!
  type: SchemaDefinitionType!
  displayOnSidebar: Boolean!
  invoicable: Boolean!
  enableNotes: Boolean!
  enableFiles: Boolean!
  enableTasks: Boolean!
  enableFeeds: Boolean!
  enableWidgets: Boolean!
  position: Int
  enableFinanceConnections: Boolean
  properties: [SchemaProperty!]
  propertyGroups: [SchemaPropertyGroup!]
  toSchemaAssociations: [SchemaAssociation!]
  fromSchemaAssociations: [SchemaAssociation!]
  primaryProperty: SchemaProperty
  secondaryProperty: SchemaProperty
  records: [Record!]
  fullNameProperty: SchemaProperty
  emailProperty: SchemaProperty
  phoneProperty: SchemaProperty
  addressProperty: SchemaProperty
  recordViews: [RecordView!]
  hotspots: [Hotspot!]
  shortcuts: [Shortcut!]
  defaultRecordView: RecordView
}

Fields​

SchemaDefinition.id ● ID! non-null scalar​

SchemaDefinition.createdAt ● Time! non-null scalar​

SchemaDefinition.updatedAt ● Time! non-null scalar​

SchemaDefinition.companyID ● String! non-null scalar​

SchemaDefinition.apiName ● String! non-null scalar​

SchemaDefinition.name ● String! non-null scalar​

SchemaDefinition.pluralName ● String! non-null scalar​

SchemaDefinition.type ● SchemaDefinitionType! non-null enum​

SchemaDefinition.displayOnSidebar ● Boolean! non-null scalar​

SchemaDefinition.invoicable ● Boolean! non-null scalar​

SchemaDefinition.enableNotes ● Boolean! non-null scalar​

SchemaDefinition.enableFiles ● Boolean! non-null scalar​

SchemaDefinition.enableTasks ● Boolean! non-null scalar​

SchemaDefinition.enableFeeds ● Boolean! non-null scalar​

SchemaDefinition.enableWidgets ● Boolean! non-null scalar​

SchemaDefinition.position ● Int scalar​

SchemaDefinition.enableFinanceConnections ● Boolean scalar​

SchemaDefinition.properties ● [SchemaProperty!] list object​

SchemaDefinition.propertyGroups ● [SchemaPropertyGroup!] list object​

SchemaDefinition.toSchemaAssociations ● [SchemaAssociation!] list object​

SchemaDefinition.fromSchemaAssociations ● [SchemaAssociation!] list object​

SchemaDefinition.primaryProperty ● SchemaProperty object​

SchemaDefinition.secondaryProperty ● SchemaProperty object​

SchemaDefinition.records ● [Record!] list object​

SchemaDefinition.fullNameProperty ● SchemaProperty object​

SchemaDefinition.emailProperty ● SchemaProperty object​

SchemaDefinition.phoneProperty ● SchemaProperty object​

SchemaDefinition.addressProperty ● SchemaProperty object​

SchemaDefinition.recordViews ● [RecordView!] list object​

SchemaDefinition.hotspots ● [Hotspot!] list object​

SchemaDefinition.shortcuts ● [Shortcut!] list object​

SchemaDefinition.defaultRecordView ● RecordView object​

Interfaces​

Node interface​

An object with an ID. Follows the Relay Global Object Identification Specification

Returned By​

createSchema mutation ● getSchema query ● updateSchema mutation

Member Of​

Email object ● Form object ● GdprOptions object ● Hotspot object ● List object ● Record object ● RecordView object ● SchemaAssociation object ● SchemaDefinitionEdge object ● SchemaFlow object ● SchemaImport object ● SchemaImportSheet object ● SchemaProperty object ● SchemaPropertyGroup object ● Shortcut object