GraphQLRepositoriesactivity
entities.activity
Read activity records with the activity repository, and change them with the activity mutations. Same records as the REST Activities entity.
- 5 queries
- 0 mutations
- REST: Activities
Queries
Fields of entities { activity { … } }.
| 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. | ActivityEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [ActivityEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: ActivityFilterInput, orderBy: [ActivityOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [ActivityEntity!]! |
| QUERY | getByCriteria(filter: ActivityFilterInput, orderBy: [ActivityOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | ActivityEntityConnection |
| 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!]! |
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.
ActivityEntity object 8 fields: customFields, pendingScheduledActions, isDeleteProtected, …
Task or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern.
| Field | Type | Description |
|---|---|---|
customFields | JSONString! (1 args) | Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). |
pendingScheduledActions | Int | Filled only when a single record is read by its id; otherwise null or an empty list. |
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. |
activeReminder | String | Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending. |
mediaTranscriptionId | UUID | Id of the linked Media record holding the activity's call recording / transcription, when available. |
instancePermissions | [EntityPermsEnum!]! (1 args) | Permissions the current user has on this record, out of the requested ones. |
fields | [InterfaceFieldData]! (2 args) | Values of the fields shown in the record's preview pane, as configured for the record's type. |
ActivityEntityConnection object pageInfo: PageInfo!, edges: [ActivityEntityEdge]!, totalCount: Int
Paginated list of Activity records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [ActivityEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
ActivityEntityEdge object node: ActivityEntity, cursor: String!
A Relay edge containing a ActivityEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | ActivityEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
ActivityFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for Activity records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [ActivityFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [ActivityFilterInput!] | Matches records that meet all of the listed filters. |
NOT | ActivityFilterInput | 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. |
ActivityOrderByInput input Asc or Desc per field
Sorting of Activity 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. |