GraphQL RepositoriesmessageRelation

`entities.messageRelation`

Read message relation records with the messageRelation repository, and change them with the message relation mutations. Same records as the REST MessageRelations entity.

Example: first three message relation recordsGraphQLcURL

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

Queries

Fields of entities { messageRelation { … } }.

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.	MessageRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[MessageRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: MessageRelationFilterInput, orderBy: [MessageRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[MessageRelationEntity!]!
QUERY	`getByCriteria`(filter: MessageRelationFilterInput, orderBy: [MessageRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	MessageRelationEntityConnection
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	`createMessageRelation`(input: CreateMessageRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateMessageRelationPayload
MUTATION	`updateMessageRelation`(input: UpdateMessageRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateMessageRelationPayload
MUTATION	`bulkUpdateMessageRelation`(input: [CreateOrUpdateMessageRelationInput!]!, deleteInput: [DeleteMessageRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateMessageRelationPayload
MUTATION	`deleteMessageRelation`(input: DeleteMessageRelationInput!)	Soft-delete	DeleteMessageRelationPayload

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.

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

Link between a message (email or memo) and a record such as an account, contact, lead or opportunity.

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 message is linked to, or empty when not linked to an account.
`contact`	ContactEntity	Contact the message is linked to, or empty when not linked to a contact.
`customEntity`	CustomEntityEntity	Custom entity record the message is linked to, or empty when not linked.
`lead`	LeadEntity	Lead the message is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty.
`oppty`	OpportunityEntity	Opportunity the message is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty.
`email`	EmailEntity	Email side of the link. Set when messageId resolves to an Email; otherwise empty.
`memo`	MemoEntity	Memo side of the link. Set when messageId resolves to a Memo; otherwise empty.
`project`	ProjectEntity	Project the message is linked to, or empty when not linked.
`quote`	QuoteEntity	Quote the message is linked to, or empty when not linked.
`accountId`	ID	Id of the linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the lead or opportunity the message is linked to, or empty when not linked.
`messageId`	ID!	Id of the email or memo on this link.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`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.

MessageRelationEntityConnection object pageInfo: PageInfo!, edges: [MessageRelationEntityEdge]!, totalCount: Int

Paginated list of MessageRelation records.

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

MessageRelationEntityEdge object node: MessageRelationEntity, cursor: String!

A Relay edge containing a MessageRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[MessageRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[MessageRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	MessageRelationFilterInput	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 linked account.
`contactId`	EntityFilterStringField	Id of the linked contact.
`customEntityId`	EntityFilterStringField	Id of the linked custom entity record.
`leadOpptyId`	EntityFilterStringField	Id of the lead or opportunity the message is linked to, or empty when not linked.
`messageId`	EntityFilterStringField	Id of the email or memo on this link.
`projectId`	EntityFilterStringField	Id of the linked project.
`quoteId`	EntityFilterStringField	Id of the linked quote.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`account`	AccountFilterInput	Account the message is linked to, or empty when not linked to an account. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact the message is linked to, or empty when not linked to a contact. Matches records where a related record meets these conditions.
`customEntity`	CustomEntityFilterInput	Custom entity record the message is linked to, or empty when not linked. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead the message is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity the message is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions.
`email`	EmailFilterInput	Email side of the link. Set when messageId resolves to an Email; otherwise empty. Matches records where a related record meets these conditions.
`memo`	MemoFilterInput	Memo side of the link. Set when messageId resolves to a Memo; otherwise empty. Matches records where a related record meets these conditions.
`project`	ProjectFilterInput	Project the message is linked to, or empty when not linked. Matches records where a related record meets these conditions.
`quote`	QuoteFilterInput	Quote the message is linked to, or empty when not linked. Matches records where a related record meets these conditions.

MessageRelationOrderByInput input Asc or Desc per field

Sorting of MessageRelation 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 message is linked to, or empty when not linked to an account. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact the message is linked to, or empty when not linked to a contact. Sorts by fields of the related record, listed in order of priority.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record the message is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead the message is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity the message is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`email`	[EmailOrderByNestedInput!]	Email side of the link. Set when messageId resolves to an Email; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`memo`	[MemoOrderByNestedInput!]	Memo side of the link. Set when messageId resolves to a Memo; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`project`	[ProjectOrderByNestedInput!]	Project the message is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority.
`quote`	[QuoteOrderByNestedInput!]	Quote the message is linked to, or empty when not linked. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the linked account.
`contactId`	OrderByEnum	Id of the linked contact.
`customEntityId`	OrderByEnum	Id of the linked custom entity record.
`leadOpptyId`	OrderByEnum	Id of the lead or opportunity the message is linked to, or empty when not linked.
`messageId`	OrderByEnum	Id of the email or memo on this link.
`projectId`	OrderByEnum	Id of the linked project.
`quoteId`	OrderByEnum	Id of the linked quote.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateMessageRelationInput input 11 fields: clientMutationId, modified, created, …

Field values of a new MessageRelation 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 linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the lead or opportunity the message is linked to, or empty when not linked.
`messageId`	ID!	Id of the email or memo on this link.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateMessageRelationInput input 12 fields: clientMutationId, id, modified, …

Field values of a MessageRelation 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 linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the lead or opportunity the message is linked to, or empty when not linked.
`messageId`	ID	Id of the email or memo on this link.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

DeleteMessageRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID, messageId: ID

Id of the MessageRelation 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 message is linked to, or empty when not linked.
`messageId`	ID	Id of the email or memo on this link.

UpdateMessageRelationInput input 12 fields: clientMutationId, id, modified, …

Id of a MessageRelation 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 linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the lead or opportunity the message is linked to, or empty when not linked.
`messageId`	ID	Id of the email or memo on this link.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateMessageRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateMessageRelation mutation.

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

CreateMessageRelationPayload object messageRelation: MessageRelationEntity, clientMutationId: String

Result of the createMessageRelation mutation.

Field	Type	Description
`messageRelation`	MessageRelationEntity	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).

DeleteMessageRelationPayload object messageRelation: MessageRelationEntity, clientMutationId: String

Result of the deleteMessageRelation mutation.

Field	Type	Description
`messageRelation`	MessageRelationEntity	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).

UpdateMessageRelationPayload object messageRelation: MessageRelationEntity, clientMutationId: String

Result of the updateMessageRelation mutation.

Field	Type	Description
`messageRelation`	MessageRelationEntity	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).