customCollectionCreate Mutation

Creates a new custom collection.

Input Argument

customCollectionCreate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

Description of the collection.

descriptionAttachments ([AttachmentInput!])

The attachments used in the description field.

disabled (Boolean)

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

name (String!)

Name of the collection.

newCollectionElements ([CustomCollectionElementInput!])

Elements of this custom collection.

pictureUri (String)

The hyperlink to the image file for the record.

reference (String)

The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character. 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.

uiExtensionId (ID)

UI extension that is to be applied to the record.

Return Fields

clientMutationId (String)

A unique identifier for the client performing the mutation.

customCollection (CustomCollection)

Record after mutation.

errors ([ValidationError!])

Errors encountered during the mutation.