GraphQLRepositoriesactivityComment
entities.activityComment
Read activity comment records with the activityComment repository, and change them with the activity comment mutations. Same records as the REST ActivityComments entity.
Queries
Fields of entities { activityComment { … } }.
| 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. | ActivityCommentEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [ActivityCommentEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: ActivityCommentFilterInput, orderBy: [ActivityCommentOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [ActivityCommentEntity!]! |
| QUERY | getByCriteria(filter: ActivityCommentFilterInput, orderBy: [ActivityCommentOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | ActivityCommentEntityConnection |
| 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 | createActivityComment(input: CreateActivityCommentInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateActivityCommentPayload |
| MUTATION | updateActivityComment(input: UpdateActivityCommentInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateActivityCommentPayload |
| MUTATION | bulkUpdateActivityComment(input: [CreateOrUpdateActivityCommentInput!]!, deleteInput: [DeleteActivityCommentInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateActivityCommentPayload |
| MUTATION | deleteActivityComment(input: DeleteActivityCommentInput!) | Soft-delete | DeleteActivityCommentPayload |
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.
ActivityCommentEntity object 13 fields: isDeleteProtected, id, isDeleted, …
Comment written by a user on a task or an appointment.
| 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. |
appointment | AppointmentEntity | Appointment this comment belongs to. Set when activityId resolves to an Appointment; otherwise empty. |
task | TaskEntity | Task this comment belongs to. Set when activityId resolves to a Task; otherwise empty. |
owner | ClientEntity | User who authored the comment. |
activityId | ID! | Id of the appointment or task the comment belongs to. |
comment | String! | Free-form text body of the comment. |
ownerId | ID! | Id of the comment author. |
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. |
ActivityCommentEntityConnection object pageInfo: PageInfo!, edges: [ActivityCommentEntityEdge]!, totalCount: Int
Paginated list of ActivityComment records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [ActivityCommentEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
ActivityCommentEntityEdge object node: ActivityCommentEntity, cursor: String!
A Relay edge containing a ActivityCommentEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | ActivityCommentEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
ActivityCommentFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for ActivityComment records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [ActivityCommentFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [ActivityCommentFilterInput!] | Matches records that meet all of the listed filters. |
NOT | ActivityCommentFilterInput | 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. |
activityId | EntityFilterStringField | Id of the appointment or task the comment belongs to. |
comment | EntityFilterStringField | Free-form text body of the comment. |
ownerId | EntityFilterStringField | Id of the comment author. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
appointment | AppointmentFilterInput | Appointment this comment belongs to. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions. |
task | TaskFilterInput | Task this comment belongs to. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions. |
owner | ClientFilterInput | User who authored the comment. Matches records where a related record meets these conditions. |
ActivityCommentOrderByInput input Asc or Desc per field
Sorting of ActivityComment 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. |
appointment | [AppointmentOrderByNestedInput!] | Appointment this comment belongs to. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority. |
task | [TaskOrderByNestedInput!] | Task this comment belongs to. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority. |
owner | [ClientOrderByNestedInput!] | User who authored the comment. Sorts by fields of the related record, listed in order of priority. |
activityId | OrderByEnum | Id of the appointment or task the comment belongs to. |
comment | OrderByEnum | Free-form text body of the comment. |
ownerId | OrderByEnum | Id of the comment author. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateActivityCommentInput input 7 fields: clientMutationId, modified, created, …
Field values of a new ActivityComment 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. |
activityId | ID! | Id of the appointment or task the comment belongs to. |
comment | String! | Free-form text body of the comment. |
ownerId | ID! | Id of the comment author. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateActivityCommentInput input 8 fields: clientMutationId, id, modified, …
Field values of an ActivityComment 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. |
activityId | ID | Id of the appointment or task the comment belongs to. |
comment | String | Free-form text body of the comment. |
ownerId | ID | Id of the comment author. |
revision | Int | Revision when entity was lastly changed. |
DeleteActivityCommentInput input clientMutationId: String, id: ID!, activityId: ID
Id of the ActivityComment 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. |
activityId | ID | Id of the appointment or task the comment belongs to. |
UpdateActivityCommentInput input 8 fields: clientMutationId, id, modified, …
Id of an ActivityComment 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. |
activityId | ID | Id of the appointment or task the comment belongs to. |
comment | String | Free-form text body of the comment. |
ownerId | ID | Id of the comment author. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateActivityCommentPayload object result: BulkUpdateResults!
Result of the bulkUpdateActivityComment mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateActivityCommentPayload object activityComment: ActivityCommentEntity, clientMutationId: String
Result of the createActivityComment mutation.
| Field | Type | Description |
|---|---|---|
activityComment | ActivityCommentEntity | 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). |
DeleteActivityCommentPayload object activityComment: ActivityCommentEntity, clientMutationId: String
Result of the deleteActivityComment mutation.
| Field | Type | Description |
|---|---|---|
activityComment | ActivityCommentEntity | 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). |
UpdateActivityCommentPayload object activityComment: ActivityCommentEntity, clientMutationId: String
Result of the updateActivityComment mutation.
| Field | Type | Description |
|---|---|---|
activityComment | ActivityCommentEntity | 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). |