GraphQL RepositoriesclientSetting

`entities.clientSetting`

Read client setting records with the clientSetting repository, and change them with the client setting mutations. Same records as the REST ClientSettings entity.

Example: first three client setting recordsGraphQLcURL

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

Queries

Fields of entities { clientSetting { … } }.

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.	ClientSettingEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ClientSettingEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ClientSettingFilterInput, orderBy: [ClientSettingOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ClientSettingEntity!]!
QUERY	`getByCriteria`(filter: ClientSettingFilterInput, orderBy: [ClientSettingOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ClientSettingEntityConnection
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!]!
QUERY	`get`(name: String!) Returns the value of the current user's setting with the given name, or null when the setting does not exist.	String

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.

ClientSettingEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Personal setting of a user, stored as a named value.

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.
`owner`	ClientEntity	User the setting belongs to.
`name`	String!	Setting key (unique per user).
`ownerId`	ID!	Id of the owning user.
`value`	JSONString!	Setting value, stored as a JSON document.
`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.

ClientSettingEntityConnection object pageInfo: PageInfo!, edges: [ClientSettingEntityEdge]!, totalCount: Int

Paginated list of ClientSetting records.

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

ClientSettingEntityEdge object node: ClientSettingEntity, cursor: String!

A Relay edge containing a ClientSettingEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ClientSettingFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ClientSettingFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ClientSettingFilterInput	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.
`name`	EntityFilterStringField	Setting key (unique per user).
`ownerId`	EntityFilterStringField	Id of the owning user.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`owner`	ClientFilterInput	User the setting belongs to. Matches records where a related record meets these conditions.

ClientSettingOrderByInput input Asc or Desc per field

Sorting of ClientSetting 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.
`owner`	[ClientOrderByNestedInput!]	User the setting belongs to. Sorts by fields of the related record, listed in order of priority.
`ownerId`	OrderByEnum	Id of the owning user.
`revision`	OrderByEnum	Revision when entity was lastly changed.