CustomCollectionElement Object
Root Connection
Section titled “Root Connection”All CustomCollectionElement objects of an account are accessible by a query on the root connection
customCollectionElements
.
Such a query will return a
CustomCollectionElementConnection!
, which contains the CustomCollectionElement objects in its
nodes
field.
customCollectionElements (
CustomCollectionElementConnection!
)
Root connection for retrieving CustomCollectionElement 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 | CustomCollectionElementFilter | Filter to determine which CustomCollectionElement records are returned. |
first | Int | Returns the first n elements from the list. |
last | Int | Returns the last n elements from the list. |
order | CustomCollectionElementOrder | Order of the CustomCollectionElement records returned. |
view | CustomCollectionElementView | View name. The default value is current_account . |
Fields
Section titled “Fields”The fields in this section list which values can be retrieved when querying CustomCollectionElement records.
account (
Account
)
The account this record belongs to.
createdAt (
ISO8601Timestamp
)
The date and time at which the record was created.
customCollection (
CustomCollection
)
Collection of this element.
customFields (
CustomField
)
Values of custom fields.
description (
String
)
Description of the collection element.
disabled (
Boolean
)
Whether the collection element may not be referenced from custom fields of other records.
id (
ID!
)
Unique identifier of the record.
information (
String
)
Any additional information about the element that might prove useful.
name (
String
)
Name of the collection element.
pictureUri (
String
)
The hyperlink to the image file for the record.
reference (
String
)
The Reference field is automatically set to the Name field value, written in lower case characters and with all spaces replaced by the underscore character.
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.
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
Section titled “Connections”The connection fields in this section allow (paged) access to objects related to a specific CustomCollectionElement record.
The actual objects will be in the
nodes
field of the connection.
customFieldsAttachments (
AttachmentConnection
)
Inline images linked to one of the custom fields.
| 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. |
informationAttachments (
AttachmentConnection
)
Files and inline images linked to the Information 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. |
Implements
Section titled “Implements”CustomCollectionElement implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a CustomCollectionElement.