GraphQL Repositoriesnote

`entities.note`

Read note records with the note repository, and change them with the note mutations. Same records as the REST Notes entity.

5 queries
5 mutations
REST: Notes

Example: first three note recordsGraphQLcURL

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

Queries

Fields of entities { note { … } }.

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.	NoteEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[NoteEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: NoteFilterInput, orderBy: [NoteOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[NoteEntity!]!
QUERY	`getByCriteria`(filter: NoteFilterInput, orderBy: [NoteOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	NoteEntityConnection
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	`copyNote`(input: CopyNoteInput!)	Copy a record GraphQL only	CopyNotePayload
MUTATION	`createNote`(input: CreateNoteInput!, validationLevel: [ValidationLevel!])	Create one record	CreateNotePayload
MUTATION	`updateNote`(input: UpdateNoteInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateNotePayload
MUTATION	`bulkUpdateNote`(input: [CreateOrUpdateNoteInput!]!, deleteInput: [DeleteNoteInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateNotePayload
MUTATION	`deleteNote`(input: DeleteNoteInput!)	Soft-delete	DeleteNotePayload

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.

NoteEntity object 23 fields: isDeleteProtected, id, isDeleted, …

Note a user wrote on a record such as an account, contact, lead, opportunity, project or quote.

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.
`account`	AccountEntity	Account the note is attached to. Exactly one of account / contact / leadOppty / project / quote / customEntity must be set.
`contact`	ContactEntity	Contact the note is attached to.
`customEntity`	CustomEntityEntity	Custom entity record the note is attached to.
`lead`	LeadEntity	Lead the note is attached to. Set when leadOpptyId resolves to a Lead.
`oppty`	OpportunityEntity	Opportunity the note is attached to. Set when leadOpptyId resolves to an Opportunity.
`owner`	ClientEntity	User who authored the note.
`project`	ProjectEntity	Project the note is attached to.
`quote`	QuoteEntity	Quote the note is attached to.
`accountId`	ID	Id of the account the note is attached to.
`contactId`	ID	Id of the contact the note is attached to.
`customEntityId`	ID	Id of the custom entity record the note is attached to.
`leadOpptyId`	ID	Id of the lead or opportunity the note is attached to.
`note`	String!	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	ID!	Id of the note author.
`projectId`	ID	Id of the project the note is attached to.
`quoteId`	ID	Id of the quote the note is attached 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.

NoteEntityConnection object pageInfo: PageInfo!, edges: [NoteEntityEdge]!, totalCount: Int

Paginated list of Note records.

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

NoteEntityEdge object node: NoteEntity, cursor: String!

A Relay edge containing a NoteEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[NoteFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[NoteFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	NoteFilterInput	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.
`accountId`	EntityFilterStringField	Id of the account the note is attached to.
`contactId`	EntityFilterStringField	Id of the contact the note is attached to.
`customEntityId`	EntityFilterStringField	Id of the custom entity record the note is attached to.
`leadOpptyId`	EntityFilterStringField	Id of the lead or opportunity the note is attached to.
`note`	EntityFilterStringField	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	EntityFilterStringField	Id of the note author.
`projectId`	EntityFilterStringField	Id of the project the note is attached to.
`quoteId`	EntityFilterStringField	Id of the quote the note is attached to.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`account`	AccountFilterInput	Account the note is attached to. Exactly one of account / contact / leadOppty / project / quote / customEntity must be set. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact the note is attached to. Matches records where a related record meets these conditions.
`customEntity`	CustomEntityFilterInput	Custom entity record the note is attached to. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead the note is attached to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity the note is attached to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	User who authored the note. Matches records where a related record meets these conditions.
`project`	ProjectFilterInput	Project the note is attached to. Matches records where a related record meets these conditions.
`quote`	QuoteFilterInput	Quote the note is attached to. Matches records where a related record meets these conditions.

NoteOrderByInput input Asc or Desc per field

Sorting of Note 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.
`account`	[AccountOrderByNestedInput!]	Account the note is attached to. Exactly one of account / contact / leadOppty / project / quote / customEntity must be set. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact the note is attached to. Sorts by fields of the related record, listed in order of priority.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record the note is attached to. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead the note is attached to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity the note is attached to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	User who authored the note. Sorts by fields of the related record, listed in order of priority.
`project`	[ProjectOrderByNestedInput!]	Project the note is attached to. Sorts by fields of the related record, listed in order of priority.
`quote`	[QuoteOrderByNestedInput!]	Quote the note is attached to. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the account the note is attached to.
`contactId`	OrderByEnum	Id of the contact the note is attached to.
`customEntityId`	OrderByEnum	Id of the custom entity record the note is attached to.
`leadOpptyId`	OrderByEnum	Id of the lead or opportunity the note is attached to.
`note`	OrderByEnum	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	OrderByEnum	Id of the note author.
`projectId`	OrderByEnum	Id of the project the note is attached to.
`quoteId`	OrderByEnum	Id of the quote the note is attached to.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CopyNoteInput input id: ID!, clientMutationId: String

Parameters of the copyNote mutation.

Input field	Type	Description
`id`	ID!	Identifier of the NoteEntity to perform the action on.
`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).

CreateNoteInput input 12 fields: clientMutationId, modified, created, …

Field values of a new Note 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.
`accountId`	ID	Id of the account the note is attached to.
`contactId`	ID	Id of the contact the note is attached to.
`customEntityId`	ID	Id of the custom entity record the note is attached to.
`leadOpptyId`	ID	Id of the lead or opportunity the note is attached to.
`note`	String!	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	ID!	Id of the note author.
`projectId`	ID	Id of the project the note is attached to.
`quoteId`	ID	Id of the quote the note is attached to.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateNoteInput input 13 fields: clientMutationId, id, modified, …

Field values of a Note 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.
`accountId`	ID	Id of the account the note is attached to.
`contactId`	ID	Id of the contact the note is attached to.
`customEntityId`	ID	Id of the custom entity record the note is attached to.
`leadOpptyId`	ID	Id of the lead or opportunity the note is attached to.
`note`	String	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	ID	Id of the note author.
`projectId`	ID	Id of the project the note is attached to.
`quoteId`	ID	Id of the quote the note is attached to.
`revision`	Int	Revision when entity was lastly changed.

DeleteNoteInput input clientMutationId: String, id: ID!, leadOpptyId: ID

Id of the Note 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.
`leadOpptyId`	ID	Id of the lead or opportunity the note is attached to.

UpdateNoteInput input 13 fields: clientMutationId, id, modified, …

Id of a Note 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.
`accountId`	ID	Id of the account the note is attached to.
`contactId`	ID	Id of the contact the note is attached to.
`customEntityId`	ID	Id of the custom entity record the note is attached to.
`leadOpptyId`	ID	Id of the lead or opportunity the note is attached to.
`note`	String	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	ID	Id of the note author.
`projectId`	ID	Id of the project the note is attached to.
`quoteId`	ID	Id of the quote the note is attached to.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateNotePayload object result: BulkUpdateResults!

Result of the bulkUpdateNote mutation.

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

CopyNotePayload object result: NoteEntity, clientMutationId: String

Result of the copyNote mutation.

Field	Type	Description
`result`	NoteEntity	Created copy of entity.
`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).

CreateNotePayload object note: NoteEntity, clientMutationId: String

Result of the createNote mutation.

Field	Type	Description
`note`	NoteEntity	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).

DeleteNotePayload object note: NoteEntity, clientMutationId: String

Result of the deleteNote mutation.

Field	Type	Description
`note`	NoteEntity	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).

UpdateNotePayload object note: NoteEntity, clientMutationId: String

Result of the updateNote mutation.

Field	Type	Description
`note`	NoteEntity	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).