GraphQL RepositoriesclientStoryRead

`entities.clientStoryRead`

Read client story read records with the clientStoryRead repository, and change them with the client story read mutations. Same records as the REST ClientStoryReads entity.

Example: first three client story read recordsGraphQLcURL

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

Queries

Fields of entities { clientStoryRead { … } }.

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.	ClientStoryReadEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ClientStoryReadEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ClientStoryReadFilterInput, orderBy: [ClientStoryReadOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ClientStoryReadEntity!]!
QUERY	`getByCriteria`(filter: ClientStoryReadFilterInput, orderBy: [ClientStoryReadOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ClientStoryReadEntityConnection
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	`createClientStoryRead`(input: CreateClientStoryReadInput!, validationLevel: [ValidationLevel!])	Create one record	CreateClientStoryReadPayload
MUTATION	`updateClientStoryRead`(input: UpdateClientStoryReadInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateClientStoryReadPayload
MUTATION	`bulkUpdateClientStoryRead`(input: [CreateOrUpdateClientStoryReadInput!]!, deleteInput: [DeleteClientStoryReadInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateClientStoryReadPayload
MUTATION	`deleteClientStoryRead`(input: DeleteClientStoryReadInput!)	Soft-delete	DeleteClientStoryReadPayload

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.

ClientStoryReadEntity object 17 fields: isDeleteProtected, id, isDeleted, …

Mark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it.

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.
`appointment`	AppointmentEntity	Appointment that was read. Set when activityId resolves to an Appointment.
`task`	TaskEntity	Task that was read. Set when activityId resolves to a Task.
`email`	EmailEntity	Email that was read. Set when messageId resolves to an Email.
`memo`	MemoEntity	Memo that was read. Set when messageId resolves to a Memo.
`owner`	ClientEntity	User who read the activity or message.
`activityId`	ID	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	ID	Id of the read email or memo, or empty when this read points to an activity.
`noFollow`	Boolean	When true, the user explicitly chose not to follow up on this item.
`ownerId`	ID!	Id of the reading user.
`readAt`	DateTime!	Timestamp the user marked the item as read.
`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.

ClientStoryReadEntityConnection object pageInfo: PageInfo!, edges: [ClientStoryReadEntityEdge]!, totalCount: Int

Paginated list of ClientStoryRead records.

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

ClientStoryReadEntityEdge object node: ClientStoryReadEntity, cursor: String!

A Relay edge containing a ClientStoryReadEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ClientStoryReadFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ClientStoryReadFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ClientStoryReadFilterInput	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.
`activityId`	EntityFilterStringField	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	EntityFilterStringField	Id of the read email or memo, or empty when this read points to an activity.
`noFollow`	Boolean	When true, the user explicitly chose not to follow up on this item.
`ownerId`	EntityFilterStringField	Id of the reading user.
`readAt`	EntityFilterDateTimeField	Timestamp the user marked the item as read.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`appointment`	AppointmentFilterInput	Appointment that was read. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions.
`task`	TaskFilterInput	Task that was read. Set when activityId resolves to a Task. Matches records where a related record meets these conditions.
`email`	EmailFilterInput	Email that was read. Set when messageId resolves to an Email. Matches records where a related record meets these conditions.
`memo`	MemoFilterInput	Memo that was read. Set when messageId resolves to a Memo. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	User who read the activity or message. Matches records where a related record meets these conditions.

ClientStoryReadOrderByInput input Asc or Desc per field

Sorting of ClientStoryRead 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.
`appointment`	[AppointmentOrderByNestedInput!]	Appointment that was read. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority.
`task`	[TaskOrderByNestedInput!]	Task that was read. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority.
`email`	[EmailOrderByNestedInput!]	Email that was read. Set when messageId resolves to an Email. Sorts by fields of the related record, listed in order of priority.
`memo`	[MemoOrderByNestedInput!]	Memo that was read. Set when messageId resolves to a Memo. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	User who read the activity or message. Sorts by fields of the related record, listed in order of priority.
`activityId`	OrderByEnum	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	OrderByEnum	Id of the read email or memo, or empty when this read points to an activity.
`noFollow`	OrderByEnum	When true, the user explicitly chose not to follow up on this item.
`ownerId`	OrderByEnum	Id of the reading user.
`readAt`	OrderByEnum	Timestamp the user marked the item as read.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateClientStoryReadInput input 9 fields: clientMutationId, modified, created, …

Field values of a new ClientStoryRead 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.
`activityId`	ID	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	ID	Id of the read email or memo, or empty when this read points to an activity.
`noFollow`	Boolean	When true, the user explicitly chose not to follow up on this item.
`ownerId`	ID!	Id of the reading user.
`readAt`	DateTime!	Timestamp the user marked the item as read.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateClientStoryReadInput input 10 fields: clientMutationId, id, modified, …

Field values of a ClientStoryRead 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.
`activityId`	ID	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	ID	Id of the read email or memo, or empty when this read points to an activity.
`noFollow`	Boolean	When true, the user explicitly chose not to follow up on this item.
`ownerId`	ID	Id of the reading user.
`readAt`	DateTime	Timestamp the user marked the item as read.
`revision`	Int	Revision when entity was lastly changed.

DeleteClientStoryReadInput input clientMutationId: String, id: ID!, activityId: ID, messageId: ID

Id of the ClientStoryRead 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.
`activityId`	ID	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	ID	Id of the read email or memo, or empty when this read points to an activity.

UpdateClientStoryReadInput input 10 fields: clientMutationId, id, modified, …

Id of a ClientStoryRead 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.
`activityId`	ID	Id of the read appointment or task, or empty when this read points to a message.
`messageId`	ID	Id of the read email or memo, or empty when this read points to an activity.
`noFollow`	Boolean	When true, the user explicitly chose not to follow up on this item.
`ownerId`	ID	Id of the reading user.
`readAt`	DateTime	Timestamp the user marked the item as read.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateClientStoryReadPayload object result: BulkUpdateResults!

Result of the bulkUpdateClientStoryRead mutation.

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

CreateClientStoryReadPayload object clientStoryRead: ClientStoryReadEntity, clientMutationId: String

Result of the createClientStoryRead mutation.

Field	Type	Description
`clientStoryRead`	ClientStoryReadEntity	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).

DeleteClientStoryReadPayload object clientStoryRead: ClientStoryReadEntity, clientMutationId: String

Result of the deleteClientStoryRead mutation.

Field	Type	Description
`clientStoryRead`	ClientStoryReadEntity	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).

UpdateClientStoryReadPayload object clientStoryRead: ClientStoryReadEntity, clientMutationId: String

Result of the updateClientStoryRead mutation.

Field	Type	Description
`clientStoryRead`	ClientStoryReadEntity	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).