GraphQL RepositoriesentitySettings

`entities.entitySettings`

Read entity settings records with the entitySettings repository, and change them with the entity settings mutations. Same records as the REST EntitySettingses entity.

Example: first three entity settings recordsGraphQLcURL

query FirstEntitySettingss {
  entities {
    entitySettings {
      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 FirstEntitySettingss { entities { entitySettings { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { entitySettings { … } }.

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.	EntitySettingsEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EntitySettingsEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EntitySettingsEntity!]!
QUERY	`getByCriteria`(filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[EntitySettingsEntity!]!
QUERY	`getPublished`(limit: Int, offset: Int, filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!], includeDeleted: Boolean) Returns the published records that match the filter, paged with limit and offset.	[EntitySettingsEntity!]!
QUERY	`getDrafts`(filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!]) Returns the records that match the filter, with pending unpublished changes applied where a draft exists.	[EntitySettingsEntity!]!
QUERY	`getDraftById`(entityId: ID!) Returns the record with the given id, with its pending unpublished changes applied when a draft exists.	EntitySettingsEntity!
QUERY	`getForEntity`(entity: EntityNameEnum!, entityApiName: String) Returns the settings of the given record type (e.g. list and detail layout options).	EntitySettingsEntity

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.

EntitySettingsEntity object 12 fields: isDeleteProtected, hasDraft, id, …

Space-wide settings of an entity, such as the default columns of its lists.

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.
`hasDraft`	Boolean	True when the record has unpublished draft changes, including pending translation changes, that can be published.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`defaultListColumns`	EntitySettingsDefaultListColumns!	Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users).
`entityApiName`	String	For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them).
`isPublished`	Boolean	True when the settings are published; false while they exist only as an unpublished draft.
`revision`	Int	Revision when entity was lastly changed.
`entityName`	EntityNameEnum!	Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name).
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

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

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

Input field	Type	Description
`OR`	[EntitySettingsFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EntitySettingsFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EntitySettingsFilterInput	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.
`entityApiName`	String	For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them).
`isPublished`	Boolean	True when the settings are published; false while they exist only as an unpublished draft.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`entityName`	EntityNameEnum	Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name).

EntitySettingsOrderByInput input Asc or Desc per field

Sorting of EntitySettings 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.
`entityApiName`	OrderByEnum	For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them).
`isPublished`	OrderByEnum	True when the settings are published; false while they exist only as an unpublished draft.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`entityName`	OrderByEnum	Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name).

EntityListColumn object fieldId: String!, width: Float!, frozen: Boolean!

Column of a record list: the field shown, its relative width and whether it is frozen.

Field	Type	Description
`fieldId`	String!	Id of the field shown in the column.
`width`	Float!	Relative width of the column.
`frozen`	Boolean!	When true, the column is pinned to the left edge and stays visible while the list scrolls horizontally.

EntitySettingsDefaultListColumns object applyToExistingUsers: Boolean!, columns: [EntityListColumn!]!

Default column layout of the record list of an entity, optionally applied to existing users.

Field	Type	Description
`applyToExistingUsers`	Boolean!	When true, publishing the settings resets the column layout of existing users to these defaults; the flag is then cleared.
`columns`	[EntityListColumn!]!	Default columns of the list, in display order.