GraphQL Repositoriesmemo

`entities.memo`

Read memo records with the memo repository, and change them with the memo mutations. Same records as the REST Memos entity.

5 queries
4 mutations
REST: Memos

Example: first three memo recordsGraphQLcURL

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

Queries

Fields of entities { memo { … } }.

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.	MemoEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[MemoEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: MemoFilterInput, orderBy: [MemoOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[MemoEntity!]!
QUERY	`getByCriteria`(filter: MemoFilterInput, orderBy: [MemoOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	MemoEntityConnection
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	`createMemo`(input: CreateMemoInput!, validationLevel: [ValidationLevel!])	Create one record	CreateMemoPayload
MUTATION	`updateMemo`(input: UpdateMemoInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateMemoPayload
MUTATION	`bulkUpdateMemo`(input: [CreateOrUpdateMemoInput!]!, deleteInput: [DeleteMemoInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateMemoPayload
MUTATION	`deleteMemo`(input: DeleteMemoInput!)	Soft-delete	DeleteMemoPayload

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.

MemoEntity object 22 fields: isDeleteProtected, id, isDeleted, …

Internal message written by a user and linked to records, which other users can comment on.

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 who authored the memo.
`ownerId`	ID!	Id of the memo author.
`subject`	String!	Short summary line of the memo.
`tableName`	String!	Discriminator identifying the concrete record type — always "memo" for Memo records. Read-only; useful when consuming polymorphic Message results.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	MessageSharingSalesUnitRelationEntityConnection (8 args)	Sales units that have been granted shared access to this memo.
`sharingClients`	MessageSharingClientRelationEntityConnection (8 args)	Users that have been granted shared access to this memo.
`accountRelations`	MessageRelationEntityConnection (8 args)	Accounts this memo is linked to.
`contactRelations`	MessageRelationEntityConnection (8 args)	Contacts this memo is linked to.
`projectRelations`	MessageRelationEntityConnection (8 args)	Projects this memo is linked to.
`leadRelations`	MessageRelationEntityConnection (8 args)	Leads this memo is linked to.
`quoteRelations`	MessageRelationEntityConnection (8 args)	Quotes this memo is linked to.
`opportunityRelations`	MessageRelationEntityConnection (8 args)	Opportunities this memo is linked to.
`customEntityRelations`	MessageRelationEntityConnection (8 args)	Custom entity records this memo is linked to.
`documents`	CloudObjectRelationEntityConnection (8 args)	Documents linked to this memo.
`comments`	MemoCommentEntityConnection (7 args)	Comments authored on this memo.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

MemoEntityConnection object pageInfo: PageInfo!, edges: [MemoEntityEdge]!, totalCount: Int

Paginated list of Memo records.

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

MemoEntityEdge object node: MemoEntity, cursor: String!

A Relay edge containing a MemoEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[MemoFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[MemoFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	MemoFilterInput	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.
`ownerId`	EntityFilterStringField	Id of the memo author.
`subject`	EntityFilterStringField	Short summary line of the memo.
`tableName`	EntityFilterStringField	Discriminator identifying the concrete record type — always "memo" for Memo records. Read-only; useful when consuming polymorphic Message results.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`owner`	ClientFilterInput	User who authored the memo. Matches records where a related record meets these conditions.
`sharingUnits`	MessageSharingSalesUnitRelationFilterInput	Sales units that have been granted shared access to this memo. Matches records where a related record meets these conditions.
`sharingClients`	MessageSharingClientRelationFilterInput	Users that have been granted shared access to this memo. Matches records where a related record meets these conditions.
`accountRelations`	MessageRelationFilterInput	Accounts this memo is linked to. Matches records where a related record meets these conditions.
`contactRelations`	MessageRelationFilterInput	Contacts this memo is linked to. Matches records where a related record meets these conditions.
`projectRelations`	MessageRelationFilterInput	Projects this memo is linked to. Matches records where a related record meets these conditions.
`leadRelations`	MessageRelationFilterInput	Leads this memo is linked to. Matches records where a related record meets these conditions.
`quoteRelations`	MessageRelationFilterInput	Quotes this memo is linked to. Matches records where a related record meets these conditions.
`opportunityRelations`	MessageRelationFilterInput	Opportunities this memo is linked to. Matches records where a related record meets these conditions.
`customEntityRelations`	MessageRelationFilterInput	Custom entity records this memo is linked to. Matches records where a related record meets these conditions.
`documents`	CloudObjectRelationFilterInput	Documents linked to this memo. Matches records where a related record meets these conditions.
`comments`	MemoCommentFilterInput	Comments authored on this memo. Matches records where a related record meets these conditions.

MemoOrderByInput input Asc or Desc per field

Sorting of Memo 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 who authored the memo. Sorts by fields of the related record, listed in order of priority.
`ownerId`	OrderByEnum	Id of the memo author.
`subject`	OrderByEnum	Short summary line of the memo.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateMemoCommentNoMemoBackrefInput input 5 fields: modified, created, comment, …

Field values of a new MemoComment record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`comment`	String!	Free-form text body of the comment.
`ownerId`	ID!	Id of the comment author.
`revision`	Int	Revision when entity was lastly changed.

CreateMemoInput input 17 fields: clientMutationId, modified, created, …

Field values of a new Memo 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.
`ownerId`	ID!	Id of the memo author.
`subject`	String!	Short summary line of the memo.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	[CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!]	Sales units that have been granted shared access to this memo.
`sharingClients`	[CreateMessageSharingClientRelationNoMessageBackrefInput!]	Users that have been granted shared access to this memo.
`accountRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Accounts this memo is linked to.
`contactRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Contacts this memo is linked to.
`projectRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Projects this memo is linked to.
`leadRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Leads this memo is linked to.
`quoteRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Quotes this memo is linked to.
`opportunityRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Opportunities this memo is linked to.
`customEntityRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Custom entity records this memo is linked to.
`documents`	[CreateCloudObjectRelationNoBackrefInput!]	Documents linked to this memo.
`comments`	[CreateMemoCommentNoMemoBackrefInput!]	Comments authored on this memo.

CreateOrUpdateMemoInput input 18 fields: clientMutationId, id, modified, …

Field values of a Memo 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.
`ownerId`	ID	Id of the memo author.
`subject`	String	Short summary line of the memo.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	[CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!]	Sales units that have been granted shared access to this memo.
`sharingClients`	[CreateMessageSharingClientRelationNoMessageBackrefInput!]	Users that have been granted shared access to this memo.
`accountRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Accounts this memo is linked to.
`contactRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Contacts this memo is linked to.
`projectRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Projects this memo is linked to.
`leadRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Leads this memo is linked to.
`quoteRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Quotes this memo is linked to.
`opportunityRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Opportunities this memo is linked to.
`customEntityRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Custom entity records this memo is linked to.
`documents`	[CreateCloudObjectRelationNoBackrefInput!]	Documents linked to this memo.
`comments`	[CreateMemoCommentNoMemoBackrefInput!]	Comments authored on this memo.

DeleteMemoInput input clientMutationId: String, id: ID!

Id of the Memo 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.

UpdateMemoInput input 18 fields: clientMutationId, id, modified, …

Id of a Memo 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.
`ownerId`	ID	Id of the memo author.
`subject`	String	Short summary line of the memo.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	[CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!]	Sales units that have been granted shared access to this memo.
`sharingClients`	[CreateMessageSharingClientRelationNoMessageBackrefInput!]	Users that have been granted shared access to this memo.
`accountRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Accounts this memo is linked to.
`contactRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Contacts this memo is linked to.
`projectRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Projects this memo is linked to.
`leadRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Leads this memo is linked to.
`quoteRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Quotes this memo is linked to.
`opportunityRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Opportunities this memo is linked to.
`customEntityRelations`	[CreateMessageRelationNoMessageBackrefInput!]	Custom entity records this memo is linked to.
`documents`	[CreateCloudObjectRelationNoBackrefInput!]	Documents linked to this memo.
`comments`	[CreateMemoCommentNoMemoBackrefInput!]	Comments authored on this memo.

BulkUpdateMemoPayload object result: BulkUpdateResults!

Result of the bulkUpdateMemo mutation.

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

CreateMemoPayload object memo: MemoEntity, clientMutationId: String

Result of the createMemo mutation.

Field	Type	Description
`memo`	MemoEntity	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).

DeleteMemoPayload object memo: MemoEntity, clientMutationId: String

Result of the deleteMemo mutation.

Field	Type	Description
`memo`	MemoEntity	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).

UpdateMemoPayload object memo: MemoEntity, clientMutationId: String

Result of the updateMemo mutation.

Field	Type	Description
`memo`	MemoEntity	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).