UiExtension Object

Root Connection
Fields
Connections
Implemented Interfaces

Root Connection

All UiExtension objects of an account are accessible by a query on the root connection uiExtensions . Such a query will return a UiExtensionConnection! , which contains the UiExtension objects in its nodes field.

uiExtensions ( UiExtensionConnection! )

Root connection for retrieving UiExtension records.

Argument	Type	Description
`after`	`String`	Returns the elements in the list that come after the specified cursor.
`before`	`String`	Returns the elements in the list that come before the specified cursor.
`filter`	`UiExtensionFilter`	Filter to determine which UiExtension records are returned.
`first`	`Int`	Returns the first n elements from the list.
`last`	`Int`	Returns the last n elements from the list.
`order`	`UiExtensionOrder`	Order of the UiExtension records returned.
`view`	`UiExtensionView`	View name. The default value is `current_account` .

Fields

The fields in this section list which values can be retrieved when querying UiExtension records.

account ( Account )

The account this record belongs to.

activeVersion ( UiExtensionVersion )

The version with Status active .

category ( UiExtensionCategory )

The type of record in which the UI extension can be selected.

createdAt ( ISO8601Timestamp )

The date and time at which the record was created.

createdBy ( Person )

The person who created the UI extension.

description ( String )

Description of the UI Extension.

disabled ( Boolean )

Whether the UI extension is inactive.

id ( ID! )

Unique identifier of the record.

name ( String )

The name of the UI extension.

showOnComplete ( Boolean )

Whether the UI extension is shown on completion of the related record.

source ( String )

An identifier for the client application submitting the resource or the name of an external system.

sourceID ( String )

The unique identifier of the resource in an external system.

title ( String )

The text that is to be displayed as the section header above the UI extension when the UI extension is presented within a form.

updatedAt ( ISO8601Timestamp )

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

updatedBy ( Person )

The person who last updated the UI extension.

Connections

The connection fields in this section allow (paged) access to objects related to a specific UiExtension record. The actual objects will be in the nodes field of the connection.

descriptionAttachments ( AttachmentConnection )

Files and inline images linked to the Description field.

Argument	Type	Description
`after`	`String`	Returns the elements in the list that come after the specified cursor.
`before`	`String`	Returns the elements in the list that come before the specified cursor.
`first`	`Int`	Returns the first n elements from the list.
`last`	`Int`	Returns the last n elements from the list.

translations ( TranslationConnection )

Translations associated with this object.

Argument	Type	Description
`after`	`String`	Returns the elements in the list that come after the specified cursor.
`before`	`String`	Returns the elements in the list that come before the specified cursor.
`first`	`Int`	Returns the first n elements from the list.
`last`	`Int`	Returns the last n elements from the list.

versions ( UiExtensionVersionConnection )

Versions of the UI extension.

Argument	Type	Description
`after`	`String`	Returns the elements in the list that come after the specified cursor.
`before`	`String`	Returns the elements in the list that come before the specified cursor.
`first`	`Int`	Returns the first n elements from the list.
`last`	`Int`	Returns the last n elements from the list.

Implements

UiExtension implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a UiExtension.