Choose a version:

MetaobjectDefinition

object

Requires read_metaobject_definitions access scope.

Provides the definition of a generic object structure composed of metafields.

Anchor to Fields and connectionsFields and connections

Anchor to accessaccess •MetaobjectAccess!non-null: Access configuration for the metaobject definition.
Anchor to capabilitiescapabilities •MetaobjectCapabilities!non-null: The capabilities of the metaobject definition.
Anchor to createdByAppcreatedByApp •App!non-null: The app used to create the metaobject definition.
Anchor to createdByStaffcreatedByStaff •StaffMember: The staff member who created the metaobject definition.
Anchor to descriptiondescription •String: The administrative description.
Anchor to displayNameKeydisplayNameKey •String: The key of a field to reference as the display name for each object.
Anchor to fieldDefinitionsfieldDefinitions •[MetaobjectFieldDefinition!]!non-null: The fields defined for this object type.
Anchor to hasThumbnailFieldhasThumbnailField •Boolean!non-null: Whether this metaobject definition has field whose type can visually represent a metaobject with the thumbnailField.
Anchor to idid •ID!non-null: A globally-unique ID.
Anchor to metaobjectsmetaobjects •MetaobjectConnection!non-null: A paginated connection to the metaobjects associated with the definition.
Anchor to metaobjectsCountmetaobjectsCount •Int!non-null: The count of metaobjects created for the definition.
Anchor to namename •String!non-null: The human-readable name.
Anchor to typetype •String!non-null: The type of the object definition. Defines the namespace of associated metafields.

Was this section helpful?

Anchor to metaobjectDefinition metaobjectDefinition •query: Retrieves a metaobject definition by ID.
Anchor to metaobjectDefinitionByType metaobjectDefinitionByType •query: Finds a metaobject definition by type.
Anchor to metaobjectDefinitions metaobjectDefinitions •query: All metaobject definitions.

Was this section helpful?

•mutation

Creates a new metaobject definition.

Anchor to definitiondefinition •MetaobjectDefinitionCreateInput!required: The input fields for creating a metaobject definition.

Anchor to metaobjectDefinitionmetaobjectDefinition •MetaobjectDefinition: The created metaobject definition.
Anchor to userErrorsuserErrors •[MetaobjectUserError!]!non-null: The list of errors that occurred from executing the mutation.

•mutation

Updates a metaobject definition with new settings and metafield definitions.

Anchor to definitiondefinition •MetaobjectDefinitionUpdateInput!required: The input fields for updating a metaobject definition.
Anchor to idid •ID!required: The ID of the metaobject definition to update.

Anchor to metaobjectDefinitionmetaobjectDefinition •MetaobjectDefinition: The updated metaobject definition.
Anchor to userErrorsuserErrors •[MetaobjectUserError!]!non-null: The list of errors that occurred from executing the mutation.

•mutation

Enables the specified standard metaobject definition from its template.

Anchor to typetype •String!required: The type of the metaobject definition to enable.

Anchor to metaobjectDefinitionmetaobjectDefinition •MetaobjectDefinition: The metaobject definition that was enabled using the standard template.
Anchor to userErrorsuserErrors •[MetaobjectUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Was this section helpful?