CustomCollection Object

Root Connection

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

customCollections (CustomCollectionConnection!)

Root connection for retrieving CustomCollection 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 CustomCollectionFilter

Filter to determine which CustomCollection records are returned.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.

Fields

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

account (Account)

The account this record belongs to.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

description (String)

Description of the collection.

disabled (Boolean)

Whether the collection may not be used for new custom views.

id (ID!)

Unique identifier of the record.

name (String)

Name of the collection.

pictureUri (String)

The hyperlink to the image file for the record.

reference (String)

This reference can be used to link the collection to an element using the Xurrent APIs or the Xurrent Import functionality.

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.

uiExtension (UiExtension)

UI extension that is linked to the collection.

updatedAt (ISO8601Timestamp)

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

Connections

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

collectionElements (CustomCollectionElementConnection)

Elements of this custom collection.

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

Implements

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