Types several repositories use, or none does, with their fields and their descriptions.
AccountDashboardProfile object filter: AccountFilterTab!, role: AccountRoleTab!, view: AccountDashboardProfileView!
Saved account dashboard: the filter and ownership scope of the accounts it covers and the graphs it shows.
| Field | Type | Description |
|---|
filter | AccountFilterTab! | Filter conditions that determine which records the dashboard includes. |
role | AccountRoleTab! | Ownership scope of the records shown, such as own, shared or managing-unit items. |
view | AccountDashboardProfileView! | View settings of the dashboard, including which graphs are shown. |
AccountDashboardProfileView object drilldownFields: [ID!]!, graphs: [DashboardGraphAccountNameType]!
View settings of the account dashboard: the graphs it shows and the fields listed when a graph value is drilled into.
| Field | Type | Description |
|---|
drilldownFields | [ID!]! | Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. |
graphs | [DashboardGraphAccountNameType]! | Graphs shown on the account dashboard, each identified by its graph type. |
AccountDataExRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountDataExRelation records.
| Field | Type | Description |
|---|
getById | AccountDataExRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountDataExRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountDataExRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountDataExRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountKPIRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountKPI records.
| Field | Type | Description |
|---|
getById | AccountKPIEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountKPIEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountKPIEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountKPIEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountOrderByNestedInput input 40 fields: id, isDeleted, modified, …
Sorting by a field of the related Account record. Set exactly one field in each item.
| 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. |
accountClass | OrderByEnum | Manual classification grade assigned to the account. Used in segmentation and reporting. |
accountTypeId | OrderByEnum | Id of the account type assigned to this account. |
address | OrderByEnum | Street address of the account. |
city | OrderByEnum | City of the account address. |
comments | OrderByEnum | Free-form notes describing the account. |
country | OrderByEnum | Country of the account address. |
currencyExchangeRatesListId | OrderByEnum | Id of the currency exchange rate list applied to this account. |
customerTypeId | OrderByEnum | Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. |
email1 | OrderByEnum | Primary email address of the account. Used as default recipient for emails sent from Coevera. |
email2 | OrderByEnum | Additional email address. |
email3 | OrderByEnum | Additional email address. |
email4 | OrderByEnum | Additional email address. |
email5 | OrderByEnum | Additional email address. |
healthCategory | OrderByEnum | Coarser bucket of healthStatus used for grouping and reporting. Read-only. |
healthStatus | OrderByEnum | Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. |
homePage | OrderByEnum | Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. |
industryId | OrderByEnum | Id of the industry classification. |
isArchived | OrderByEnum | True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. |
name | OrderByEnum | Name of the entity and its default text representation. |
ownerId | OrderByEnum | Id of the account owner. |
parentAccountId | OrderByEnum | Id of the parent account in the corporate hierarchy. Empty for top-level accounts. |
parentAccountRelationTypeId | OrderByEnum | Id of the parent-account relationship type. |
phone1 | OrderByEnum | Primary phone number of the account. Used as default target for click-to-call. |
phone2 | OrderByEnum | Additional phone number. |
phone3 | OrderByEnum | Additional phone number. |
phone4 | OrderByEnum | Additional phone number. |
phone5 | OrderByEnum | Additional phone number. |
quickParentAccountName | OrderByEnum | Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. |
shareMode | OrderByEnum | Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access. |
stateProvince | OrderByEnum | State or province of the account address. |
unitId | OrderByEnum | Id of the sales unit. |
zipCode | OrderByEnum | ZIP or postal code of the account address. |
revision | OrderByEnum | Revision when entity was lastly changed. |
enrolledEmailSequences | OrderByEnum | Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). |
relatedEntities | CommonEntityRepositoryOrderByEntityRelationField | Sorts records by whether they are related to the listed records. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
AccountProductPricingRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountProductPricing records.
| Field | Type | Description |
|---|
getById | AccountProductPricingEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountProductPricingEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountProductPricingEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountProductPricingEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountRelationLabelRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountRelationLabel records.
| Field | Type | Description |
|---|
getById | AccountRelationLabelEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountRelationLabelEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountRelationLabelEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [AccountRelationLabelEntity!]! (3 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountRelation records.
| Field | Type | Description |
|---|
getById | AccountRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [AccountRelationEntity!]! (3 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountRelationTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountRelationType records.
| Field | Type | Description |
|---|
getById | AccountRelationTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountRelationTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountRelationTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | [AccountRelationTypeEntity!]! (3 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountRepository object 11 fields: getById, getByIds, getAll, …
Read operations for Account records.
| Field | Type | Description |
|---|
getById | AccountEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getBySession | AccountEntityConnection (7 args) | Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. |
getByIdFormatted | JSONString (2 args) | Returns the values of a record's fields formatted for display, keyed by field id. |
getEligibleParents | [AccountEntity!]! (6 args) | Returns the accounts that can be set as the parent of the given account, which excludes the account itself and all its child accounts at any level. |
getRelatedToContact | [AccountEntity!]! (5 args) | Returns the accounts linked to the given contact. |
autoPrefill | AccountEntity! (3 args) | Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. |
aiAutoPrefill | AccountAutoPrefill! (1 args) | Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. |
AccountRoleOrderByNestedInput input 7 fields: id, isDeleted, modified, …
Sorting by a field of the related AccountRole record. Set exactly one field in each item.
| 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. |
color | OrderByEnum | Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. |
label | OrderByEnum | Name of the entity and its default text representation. |
revision | OrderByEnum | Revision when entity was lastly changed. |
AccountRoleRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountRole records.
| Field | Type | Description |
|---|
getById | AccountRoleEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountRoleEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountRoleEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountRoleEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountSharingClientRelation records.
| Field | Type | Description |
|---|
getById | AccountSharingClientRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountSharingClientRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountSharingClientRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountSharingClientRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountSharingSalesUnitRelation records.
AccountSocialRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AccountSocialRelation records.
| Field | Type | Description |
|---|
getById | AccountSocialRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountSocialRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountSocialRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountSocialRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AccountTypeOrderByNestedInput input 8 fields: id, isDeleted, modified, …
Sorting by a field of the related AccountType record. Set exactly one field in each item.
| 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. |
isReadonly | OrderByEnum | True when the account type is system-managed and cannot be edited or deleted by users. |
name | OrderByEnum | Name of the entity and its default text representation. |
isPublished | OrderByEnum | True when the entity configuration is published; false while it exists only as an unpublished draft. |
revision | OrderByEnum | Revision when entity was lastly changed. |
AccountTypeRepository object 7 fields: getById, getByIds, getAll, …
Read operations for AccountType records.
| Field | Type | Description |
|---|
getById | AccountTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AccountTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AccountTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AccountTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [AccountTypeEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [AccountTypeEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | AccountTypeEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
ActivityDashboardProfile object filter: ActivityFilterTab!, role: ActivityRoleTab!, view: ActivityDashboardProfileView!
Saved activity dashboard: the filter and ownership scope of the activities it covers and the graphs it shows.
| Field | Type | Description |
|---|
filter | ActivityFilterTab! | Filter conditions that determine which records the dashboard includes. |
role | ActivityRoleTab! | Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. |
view | ActivityDashboardProfileView! | View settings of the dashboard, including which graphs are shown. |
ActivityDashboardProfileView object drilldownFields: [ID!]!, graphs: [DashboardGraphActivityNameType]!
View settings of the activity dashboard: the graphs it shows and the fields listed when a graph value is drilled into.
| Field | Type | Description |
|---|
drilldownFields | [ID!]! | Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. |
graphs | [DashboardGraphActivityNameType]! | Graphs shown on the activity dashboard, each identified by its graph type. |
ActivityDataExRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for ActivityDataExRelation records.
| Field | Type | Description |
|---|
getById | ActivityDataExRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ActivityDataExRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ActivityDataExRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ActivityDataExRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
ActivityKPIRepository object 5 fields: getById, getByIds, getAll, …
Read operations for ActivityKPI records.
| Field | Type | Description |
|---|
getById | ActivityKPIEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ActivityKPIEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ActivityKPIEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ActivityKPIEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
ActivityRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for ActivityRelation records.
| Field | Type | Description |
|---|
getById | ActivityRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ActivityRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ActivityRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ActivityRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
ActivityRepository object 5 fields: getById, getByIds, getAll, …
Read operations for Activity records.
| Field | Type | Description |
|---|
getById | ActivityEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ActivityEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ActivityEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ActivityEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
ActivityTypeIconEnum enum GeneralIcon, Task, Appointment, Call, Mail, Message, … (24 values)
Icon used to display tasks or appointments of an activity type.
| Value | Description |
|---|
GeneralIcon | Generic activity icon not tied to a specific kind of activity. |
Task | Icon depicting a task; the default for task types. |
Appointment | Icon depicting an appointment; the default for appointment types. |
Call | Icon depicting a phone call. |
Mail | Icon depicting an email. |
Message | Icon depicting a message. |
TicketingIntegration | Icon depicting a ticketing system integration. |
DocumentManagement | Icon depicting document management. |
EventManagement | Icon depicting event management. |
AccountingSystem | Icon depicting an accounting system. |
MarketingCommunicationSystems | Icon depicting a marketing communication system. |
OrderProcessing | Icon depicting order processing. |
WebServices | Icon depicting web services. |
ReturnMerchandiseAuthorizationSystems | Icon depicting a return merchandise authorization (RMA) system. |
SalesAutomatization | Icon depicting sales automation. |
SmsMessaging | Icon depicting SMS messaging. |
ErpSystems | Icon depicting an ERP system. |
DataAnalytics | Icon depicting data analytics. |
Warehouses | Icon depicting a warehouse. |
ContactManagement | Icon depicting contact management. |
ContentManagementSystems | Icon depicting a content management system. |
InventorySystems | Icon depicting an inventory system. |
Workflow | Icon depicting a workflow. |
AssetManagementSystem | Icon depicting an asset management system. |
ActivityTypeIconEnumFilterInput input eq: [ActivityTypeIconEnum!], NOT: ActivityTypeIconEnumFilterInput
Conditions on an enumeration field. Several conditions given together must all match.
AiAssistantCreateEmailAction object subject: String!, body: String!
Suggested action to send an email whose subject and body the AI assistant has drafted.
| Field | Type | Description |
|---|
subject | String! | Subject of the email the AI proposes. |
body | String! | Body of the email the AI proposes. |
AiAssistantCreateNoteAction object note: String!
Suggested action that adds a note with text proposed by AI.
| Field | Type | Description |
|---|
note | String! | Text of the note the AI proposes. |
AiAssistantCreateRecordAction object entityName: EntityNameEnum!, entityApiName: String, id: ID!
Suggested action that creates a record, such as a task or appointment, pre-filled with values proposed by AI.
| Field | Type | Description |
|---|
entityName | EntityNameEnum! | Entity of the record the action creates, such as Task or Appointment. |
entityApiName | String | API name of the custom entity when entityName is CustomEntity; null otherwise. |
id | ID! | Id of the action; pass it as actionId to aiAutoPrefill to get the record pre-filled with the values the AI proposes. |
AiAssistantTaskAction union AiAssistantCreateRecordAction | AiAssistantUpdateFormAction | AiAssistantCreateEmailAction | AiAssistantCreateNoteAction
Action the user can take on an AI suggestion: create a record, update the record, send an email or add a note.
AiAssistantUpdateFormAction object id: ID!
Suggested action that updates the record with values proposed by AI.
| Field | Type | Description |
|---|
id | ID! | Id of the action; pass it as actionId to aiAutoPrefill to get the record pre-filled with the values the AI proposes. |
AiConversationItem object text: String!, actor: AiConversationItemActor!
One message of a conversation with the AI assistant, written by the user or by the assistant.
| Field | Type | Description |
|---|
text | String! | Text of the message. |
actor | AiConversationItemActor! | Author of the message: the user or the AI assistant. |
AiCreditInfo object status: AiCreditInfoStatus!, value: Int
AI credits consumed to generate an AI assistant message, and whether the count is final.
| Field | Type | Description |
|---|
status | AiCreditInfoStatus! | Whether the AI work is finished and the credit count is final. |
value | Int | Number of AI credits consumed so far. |
AiCreditInfoStatus enum InProgress, Finished
Whether the AI credit usage reported for a request is final.
| Value | Description |
|---|
InProgress | The AI work is still running; the credit count can still grow. |
Finished | The AI work is done; the credit count is final. |
AiExample object title: String!, prompt: String!
Example prompt proposed by the AI assistant.
| Field | Type | Description |
|---|
title | String! | Short title of the example. |
prompt | String! | Prompt the example sends to the AI assistant. |
AiExampleData object examples: [AiExample]!
Content of an AI assistant message that proposes example prompts.
| Field | Type | Description |
|---|
examples | [AiExample]! | Example prompts proposed by the AI assistant. |
AiMessageData union AiExampleData | AiSuggestionData
Structured content of an AI assistant message: example prompts or suggestions for a record.
AiRecordSuggestion object 5 fields: id, text, title, …
Suggestion the AI assistant makes for a record, such as an alert, news or data enrichment, with the actions the user can take on it.
| Field | Type | Description |
|---|
id | ID! | Unique identifier of the suggestion. |
text | String! | Text of the suggestion. |
title | String! | Short title of the suggestion. |
actions | [AiAssistantTaskAction]! | Actions the user can take on the suggestion, such as creating a task or sending an email; empty when none are proposed. |
type | AiRecordSuggestionType! | Kind of suggestion. |
AiRecordSuggestionType enum Alert, News, DataEnrichment, UpdateAccountHierarchy, UpdateOrgChart, UpdateBuyingCenter
Kind of AI suggestion shown for a record.
| Value | Description |
|---|
Alert | Recommended next action for the record. |
News | News relevant to the record. |
DataEnrichment | Proposed updates to the record's field values. |
UpdateAccountHierarchy | Proposed changes to the account hierarchy. |
UpdateOrgChart | Proposed changes to the organization chart of contacts. |
UpdateBuyingCenter | Proposed changes to the buying center. |
AiSuggestionData object suggestions: [AiRecordSuggestion]!
Content of an AI assistant message that lists suggestions for a record.
AllowedAccountTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedAccountType records.
| Field | Type | Description |
|---|
getById | AllowedAccountTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedAccountTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedAccountTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedAccountTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedAppointmentTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedAppointmentType records.
| Field | Type | Description |
|---|
getById | AllowedAppointmentTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedAppointmentTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedAppointmentTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedAppointmentTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedCompanyEmailRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedCompanyEmail records.
| Field | Type | Description |
|---|
getById | AllowedCompanyEmailEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedCompanyEmailEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedCompanyEmailEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedCompanyEmailEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedCompanyPhoneRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedCompanyPhone records.
| Field | Type | Description |
|---|
getById | AllowedCompanyPhoneEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedCompanyPhoneEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedCompanyPhoneEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedCompanyPhoneEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedContactTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedContactType records.
| Field | Type | Description |
|---|
getById | AllowedContactTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedContactTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedContactTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedContactTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedEntityType object entity: EntityNameEnum!, entityApiName: String, entityTypeIds: [ID!]
Entities where field is allowed to be used, for relation fields both left relation entity and right relation entity record is returned. Abstract Entity (e.g.
| Field | Type | Description |
|---|
entity | EntityNameEnum! | Name of entity where field is allowed to be used, for relation fields both left relation entity and right relation entity is returned.Abstract Entity (e.g. LeadOppty, Activity) are not returned they have to be evaluated by receiver. |
entityApiName | String | API name of the custom entity when entity is CustomEntity; null for other entities. |
entityTypeIds | [ID!] | Ids of entity types where field is declared on its type form, if entity doesn't have types a NULL is returned. |
AllowedLeadTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedLeadType records.
| Field | Type | Description |
|---|
getById | AllowedLeadTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedLeadTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedLeadTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedLeadTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedPipelineRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedPipeline records.
| Field | Type | Description |
|---|
getById | AllowedPipelineEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedPipelineEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedPipelineEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedPipelineEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedQuoteTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedQuoteType records.
| Field | Type | Description |
|---|
getById | AllowedQuoteTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedQuoteTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedQuoteTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedQuoteTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AllowedTaskTypeRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AllowedTaskType records.
| Field | Type | Description |
|---|
getById | AllowedTaskTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AllowedTaskTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AllowedTaskTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AllowedTaskTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
ApiAccessRepository object 6 fields: getById, getByIds, getAll, …
Read operations for ApiAccess records.
| Field | Type | Description |
|---|
getById | ApiAccessEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ApiAccessEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ApiAccessEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ApiAccessEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getAllForAdmin | [ApiAccessEntity!]! (5 args) | Returns API accesses of the space for administration, leaving out accesses of hidden applications. |
ApplicationOrderByNestedInput input 10 fields: id, isDeleted, modified, …
Sorting by a field of the related Application record. Set exactly one field in each item.
| 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. |
automationHubId | OrderByEnum | Identifier of the matching Automation Hub item, or empty for user-defined applications. Set automatically by Coevera when the application is registered through the Automation Hub. |
isTrigger | OrderByEnum | True when this application can register webhooks. Set when the application is created and cannot be changed afterwards. |
isVisible | OrderByEnum | True when this application is shown in the Automation Hub UI. Hidden applications are still functional but excluded from end-user discovery. |
name | OrderByEnum | Name of the entity and its default text representation. |
usesImpersonation | OrderByEnum | True when this application can act on behalf of individual users (personal triggers). Set when the application is created and cannot be changed afterwards. |
revision | OrderByEnum | Revision when entity was lastly changed. |
ApplicationRepository object getById: ApplicationEntity, getByIds: [ApplicationEntity!]!, getAll: [ApplicationEntity!]!, getByCriteria: ApplicationEntityConnection
Read operations for Application records.
| Field | Type | Description |
|---|
getById | ApplicationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ApplicationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ApplicationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ApplicationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
AppointmentClientInviteesRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AppointmentClientInviteesRelation records.
AppointmentContactInviteesRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AppointmentContactInviteesRelation records.
AppointmentOrderByNestedInput input 23 fields: id, isDeleted, modified, …
Sorting by a field of the related Appointment record. Set exactly one field in each item.
| 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. |
activityTypeId | OrderByEnum | Id of the appointment type. |
currencyExchangeRatesListId | OrderByEnum | Id of the currency exchange rate list applied to this appointment. |
description | OrderByEnum | Free-form description of the appointment. |
duration | OrderByEnum | Duration of the appointment, derived from start/end dates. |
endDate | OrderByEnum | End timestamp of the appointment. |
inviteesCanEdit | OrderByEnum | True when invitees are allowed to edit the appointment. Defaults to false. |
location | OrderByEnum | Free-text physical location of the appointment. |
ownerId | OrderByEnum | Id of the appointment owner. |
recurrenceMasterId | OrderByEnum | Id of the master appointment. |
scheduleId | OrderByEnum | Id of the appointment schedule. |
startDate | OrderByEnum | Start timestamp of the appointment. |
subject | OrderByEnum | Short summary line shown in calendars and lists. |
unitId | OrderByEnum | Id of the sales unit. |
revision | OrderByEnum | Revision when entity was lastly changed. |
status | OrderByEnum | Current status of the appointment (NotStarted, InProgress, Completed, Canceled). Read-only; derived from the start/end times and the deleted flag. |
exchangeEntityId | OrderByEnum | External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. |
gapiEntityId | OrderByEnum | External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. |
o365EntityId | OrderByEnum | External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
AppointmentReminderRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AppointmentReminder records.
| Field | Type | Description |
|---|
getById | AppointmentReminderEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AppointmentReminderEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AppointmentReminderEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AppointmentReminderEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AppointmentRepository object 10 fields: getById, getByIds, getAll, …
Read operations for Appointment records.
| Field | Type | Description |
|---|
getById | AppointmentEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AppointmentEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AppointmentEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AppointmentEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getBySession | AppointmentEntityConnection (7 args) | Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. |
getByIdFormatted | JSONString (2 args) | Returns the values of a record's fields formatted for display, keyed by field id. |
autoPrefill | AppointmentEntity! (3 args) | Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. |
aiAutoPrefill | AppointmentAutoPrefill! (1 args) | Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. |
autoPrefillFromEmail | AppointmentAutoPrefill! (2 args) | Returns a new, unsaved appointment pre-filled from an email conversation: subject and description from the last sent email of the conversation that the user can read, the records linked to the conversation (including ones the user cannot open), its attachments as documents, and every From, To and … |
AppointmentScheduleRepository object 5 fields: getById, getByIds, getAll, …
Read operations for AppointmentSchedule records.
| Field | Type | Description |
|---|
getById | AppointmentScheduleEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AppointmentScheduleEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AppointmentScheduleEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AppointmentScheduleEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
AppointmentTypeOrderByNestedInput input 9 fields: id, isDeleted, modified, …
Sorting by a field of the related AppointmentType record. Set exactly one field in each item.
| 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. |
icon | OrderByEnum | Icon used to display appointments of this type in the UI. |
isReadonly | OrderByEnum | True when the appointment type is system-managed and cannot be edited or deleted by users. |
name | OrderByEnum | Name of the entity and its default text representation. |
isPublished | OrderByEnum | True when the entity configuration is published; false while it exists only as an unpublished draft. |
revision | OrderByEnum | Revision when entity was lastly changed. |
AppointmentTypeRepository object 7 fields: getById, getByIds, getAll, …
Read operations for AppointmentType records.
| Field | Type | Description |
|---|
getById | AppointmentTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [AppointmentTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [AppointmentTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | AppointmentTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [AppointmentTypeEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [AppointmentTypeEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | AppointmentTypeEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
ApprovalApproverRepository object 5 fields: getById, getByIds, getAll, …
Read operations for ApprovalApprover records.
| Field | Type | Description |
|---|
getById | ApprovalApproverEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ApprovalApproverEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ApprovalApproverEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ApprovalApproverEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
ApprovalOrderByNestedInput input 19 fields: id, isDeleted, modified, …
Sorting by a field of the related Approval record. Set exactly one field in each item.
| 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. |
accountId | OrderByEnum | Id of the linked account. |
actorId | OrderByEnum | Id of the triggering user. |
applicationId | OrderByEnum | Id of the application (e.g. browser, automation, third-party integration) the approval was triggered in. |
approvalProcessId | OrderByEnum | Id of the approval process this approval was raised from. |
approvalStatus | OrderByEnum | Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. endTime is set once the decision is made. |
comment | OrderByEnum | Comment the requester attached when raising the approval. |
contactId | OrderByEnum | Id of the linked contact. |
endTime | OrderByEnum | Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending. |
leadOpptyId | OrderByEnum | Id of the linked lead or opportunity, or empty when not linked. |
quoteId | OrderByEnum | Id of the linked quote. |
status | OrderByEnum | Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approvalStatus. |
revision | OrderByEnum | Revision when entity was lastly changed. |
name | OrderByEnum | Display name of the approval, derived from the underlying record being approved (e.g. the quote name). Empty when the underlying record has been deleted. |
ownerId | OrderByEnum | Id of the user who owns the record being approved (the record's owner, not the approver). Empty when the underlying record has been deleted. |
startTime | OrderByEnum | Timestamp the approval was raised (alias of created). |
ApprovalProcessActivityLogLineRepository object 5 fields: getById, getByIds, getAll, …
Read operations for ApprovalProcessActivityLogLine records.
ApprovalProcessOrderByNestedInput input 14 fields: id, isDeleted, modified, …
Sorting by a field of the related ApprovalProcess record. Set exactly one field in each item.
| 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. |
description | OrderByEnum | Free-text description shown alongside the approval process. |
isEnabled | OrderByEnum | When true, the approval process actively raises approvals on matching record events; when false, the process is paused. |
lastSchemaChange | OrderByEnum | Timestamp of the most recent change to settings. |
lastStatusChange | OrderByEnum | Timestamp of the most recent change to isEnabled. |
name | OrderByEnum | Name of the entity and its default text representation. |
ownerId | OrderByEnum | Id of the owning user. |
priority | OrderByEnum | Position of this process among approval processes for the same record-trigger entity type; lower values are evaluated first. Read-only; managed via update_priority. Null for manual-trigger approval processes. |
triggerEntityName | OrderByEnum | For record-change triggers, the entity whose records can raise an approval (e.g. "Quote"). Empty for manual triggers. |
status | OrderByEnum | Overall status of the approval process, derived from the approvals it raised since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are none. |
triggerType | OrderByEnum | How approvals are raised: Manual (a user must initiate) or RecordChange (automatically when a record matching the trigger condition is created or updated). |
ApprovalProcessRepository object 7 fields: getById, getByIds, getAll, …
Read operations for ApprovalProcess records.
| Field | Type | Description |
|---|
getById | ApprovalProcessEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ApprovalProcessEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ApprovalProcessEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ApprovalProcessEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getByApprovalProcessCriteria | ApprovalProcessEntityConnection (7 args) | Returns a page of approval processes filtered by owner, enabled state and status, in addition to the regular filter. |
getApprovalProcessesWithManualTrigger | [ApprovalProcessEntity!]! (4 args) | Returns approval processes with a manual trigger that the current user is allowed to start, according to each trigger's allowed users and units. |
ApprovalRepository object 7 fields: getById, getByIds, getAll, …
Read operations for Approval records.
| Field | Type | Description |
|---|
getById | ApprovalEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [ApprovalEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [ApprovalEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | ApprovalEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getDownloadUrl | String! (4 args) | Exports the approval log of an approval process to a zipped text file and returns a URL to download it. |
getRecentApprovals | [RecentApprovalItem!]! (3 args) | Returns the completed approvals (approved or rejected) of a record, most recently decided first. |
ApprovalStatusEnum enum Pending, Approved, Rejected
Decision state of an approval request for a record.
| Value | Description |
|---|
Pending | Waiting for the approvers' decision. |
Approved | The record was approved. |
Rejected | The record was rejected. |
ApprovalStatusEnumFilterInput input eq: [ApprovalStatusEnum!], NOT: ApprovalStatusEnumFilterInput
Conditions on an enumeration field. Several conditions given together must all match.
