Skip to main content

SchemaProperty

type SchemaProperty implements Node {
id: ID!
createdAt: Time!
updatedAt: Time!
companyID: String!
apiName: String!
name: String!
description: String
type: SchemaPropertyType!
default: Boolean!
regexVerification: String
computedFunction: String
required: Boolean!
unique: Boolean!
showOnCreate: Boolean!
quickView: Boolean!
hidden: Boolean!
schemaID: ID!
groupID: ID!
position: Int
group: SchemaPropertyGroup!
schema: SchemaDefinition!
options(
after: Cursor
first: Int
before: Cursor
last: Int
orderBy: SchemaPropertyOptionOrder
where: SchemaPropertyOptionWhereInput
): SchemaPropertyOptionConnection!
recordUsage: [RecordValue!]
isPrimaryProperty: SchemaDefinition
isSecondaryProperty: SchemaDefinition
widgets: [RecordWidgetProperty!]
}

Fields

SchemaProperty.id ● ID! non-null scalar

SchemaProperty.createdAt ● Time! non-null scalar

SchemaProperty.updatedAt ● Time! non-null scalar

SchemaProperty.companyID ● String! non-null scalar

SchemaProperty.apiName ● String! non-null scalar

SchemaProperty.name ● String! non-null scalar

SchemaProperty.description ● String scalar

SchemaProperty.type ● SchemaPropertyType! non-null enum

SchemaProperty.default ● Boolean! non-null scalar

SchemaProperty.regexVerification ● String scalar

SchemaProperty.computedFunction ● String scalar

SchemaProperty.required ● Boolean! non-null scalar

SchemaProperty.unique ● Boolean! non-null scalar

SchemaProperty.showOnCreate ● Boolean! non-null scalar

SchemaProperty.quickView ● Boolean! non-null scalar

SchemaProperty.hidden ● Boolean! non-null scalar

SchemaProperty.schemaID ● ID! non-null scalar

SchemaProperty.groupID ● ID! non-null scalar

SchemaProperty.position ● Int scalar

SchemaProperty.group ● SchemaPropertyGroup! non-null object

SchemaProperty.schema ● SchemaDefinition! non-null object

SchemaProperty.options ● SchemaPropertyOptionConnection! non-null object

SchemaProperty.options.after ● Cursor scalar

Returns the elements in the list that come after the specified cursor.

SchemaProperty.options.first ● Int scalar

Returns the first n elements from the list.

SchemaProperty.options.before ● Cursor scalar

Returns the elements in the list that come before the specified cursor.

SchemaProperty.options.last ● Int scalar

Returns the last n elements from the list.

SchemaProperty.options.orderBy ● SchemaPropertyOptionOrder input

Ordering options for SchemaPropertyOptions returned from the connection.

SchemaProperty.options.where ● SchemaPropertyOptionWhereInput input

Filtering options for SchemaPropertyOptions returned from the connection.

SchemaProperty.recordUsage ● [RecordValue!] list object

SchemaProperty.isPrimaryProperty ● SchemaDefinition object

SchemaProperty.isSecondaryProperty ● SchemaDefinition object

SchemaProperty.widgets ● [RecordWidgetProperty!] list object

Interfaces

Node interface

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

Returned By

createProperties mutation ● createProperty mutation ● getPropertyGroupFields query ● updateProperty mutation

Member Of

Email object ● FormField object ● ListCondition object ● RecordValue object ● RecordWidgetProperty object ● SchemaCreateInformations object ● SchemaDefinition object ● SchemaImport object ● SchemaImportAssociation object ● SchemaPropertyEdge object ● SchemaPropertyOption object