GraphQL RepositoriescustomEntityDataExRelation

`entities.customEntityDataExRelation`

Read custom entity data ex relation records with the customEntityDataExRelation repository, and change them with the custom entity data ex relation mutations.

5 queries
4 mutations

Example: first three custom entity data ex relation recordsGraphQLcURL

query FirstCustomEntityDataExRelations {
  entities {
    customEntityDataExRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstCustomEntityDataExRelations { entities { customEntityDataExRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { customEntityDataExRelation { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	CustomEntityDataExRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CustomEntityDataExRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CustomEntityDataExRelationFilterInput, orderBy: [CustomEntityDataExRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CustomEntityDataExRelationEntity!]!
QUERY	`getByCriteria`(filter: CustomEntityDataExRelationFilterInput, orderBy: [CustomEntityDataExRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CustomEntityDataExRelationEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createCustomEntityDataExRelation`(input: CreateCustomEntityDataExRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCustomEntityDataExRelationPayload
MUTATION	`updateCustomEntityDataExRelation`(input: UpdateCustomEntityDataExRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCustomEntityDataExRelationPayload
MUTATION	`bulkUpdateCustomEntityDataExRelation`(input: [CreateOrUpdateCustomEntityDataExRelationInput!]!, deleteInput: [DeleteCustomEntityDataExRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCustomEntityDataExRelationPayload
MUTATION	`deleteCustomEntityDataExRelation`(input: DeleteCustomEntityDataExRelationInput!)	Soft-delete	DeleteCustomEntityDataExRelationPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

CustomEntityDataExRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Option selected in a multi-select checkbox field of a custom entity record; there is one link per selected option.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`customEntity`	CustomEntityEntity	Custom entity record on which the option is selected.
`data`	DataEntity	Option selected in the multi-select field; it belongs to the data set given by dataSetId.
`customEntityId`	ID!	Id of the custom entity record on which the option is selected.
`dataId`	ID!	Id of the selected option.
`dataSetId`	ID!	Id of the data set (the option list of a multi-select field) the selected option belongs to.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CustomEntityDataExRelationEntityConnection object pageInfo: PageInfo!, edges: [CustomEntityDataExRelationEntityEdge]!, totalCount: Int

Paginated list of CustomEntityDataExRelation records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[CustomEntityDataExRelationEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

CustomEntityDataExRelationEntityEdge object node: CustomEntityDataExRelationEntity, cursor: String!

A Relay edge containing a CustomEntityDataExRelationEntity and its cursor.

Field	Type	Description
`node`	CustomEntityDataExRelationEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

CustomEntityDataExRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for CustomEntityDataExRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[CustomEntityDataExRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CustomEntityDataExRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CustomEntityDataExRelationFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`customEntityId`	EntityFilterStringField	Id of the custom entity record on which the option is selected.
`dataId`	EntityFilterStringField	Id of the selected option.
`dataSetId`	EntityFilterStringField	Id of the data set (the option list of a multi-select field) the selected option belongs to.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`customEntity`	CustomEntityFilterInput	Custom entity record on which the option is selected. Matches records where a related record meets these conditions.
`data`	DataFilterInput	Option selected in the multi-select field; it belongs to the data set given by dataSetId. Matches records where a related record meets these conditions.

CustomEntityDataExRelationOrderByInput input Asc or Desc per field

Sorting of CustomEntityDataExRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record on which the option is selected. Sorts by fields of the related record, listed in order of priority.
`data`	[DataOrderByNestedInput!]	Option selected in the multi-select field; it belongs to the data set given by dataSetId. Sorts by fields of the related record, listed in order of priority.
`customEntityId`	OrderByEnum	Id of the custom entity record on which the option is selected.
`dataId`	OrderByEnum	Id of the selected option.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateCustomEntityDataExRelationInput input 7 fields: clientMutationId, modified, created, …

Field values of a new CustomEntityDataExRelation record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`customEntityId`	ID!	Id of the custom entity record on which the option is selected.
`dataId`	ID!	Id of the selected option.
`dataSetId`	ID!	Id of the data set (the option list of a multi-select field) the selected option belongs to.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateCustomEntityDataExRelationInput input 8 fields: clientMutationId, id, modified, …

Field values of a CustomEntityDataExRelation record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`customEntityId`	ID	Id of the custom entity record on which the option is selected.
`dataId`	ID	Id of the selected option.
`dataSetId`	ID	Id of the data set (the option list of a multi-select field) the selected option belongs to.
`revision`	Int	Revision when entity was lastly changed.

DeleteCustomEntityDataExRelationInput input clientMutationId: String, id: ID!

Id of the CustomEntityDataExRelation record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateCustomEntityDataExRelationInput input 8 fields: clientMutationId, id, modified, …

Id of a CustomEntityDataExRelation record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`customEntityId`	ID	Id of the custom entity record on which the option is selected.
`dataId`	ID	Id of the selected option.
`dataSetId`	ID	Id of the data set (the option list of a multi-select field) the selected option belongs to.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCustomEntityDataExRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateCustomEntityDataExRelation mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateCustomEntityDataExRelationPayload object customEntityDataExRelation: CustomEntityDataExRelationEntity, clientMutationId: String

Result of the createCustomEntityDataExRelation mutation.

Field	Type	Description
`customEntityDataExRelation`	CustomEntityDataExRelationEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteCustomEntityDataExRelationPayload object customEntityDataExRelation: CustomEntityDataExRelationEntity, clientMutationId: String

Result of the deleteCustomEntityDataExRelation mutation.

Field	Type	Description
`customEntityDataExRelation`	CustomEntityDataExRelationEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateCustomEntityDataExRelationPayload object customEntityDataExRelation: CustomEntityDataExRelationEntity, clientMutationId: String

Result of the updateCustomEntityDataExRelation mutation.

Field	Type	Description
`customEntityDataExRelation`	CustomEntityDataExRelationEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).