GraphQLRepositoriesmemoComment
entities.memoComment
Read memo comment records with the memoComment repository, and change them with the memo comment mutations. Same records as the REST MemoComments entity.
Queries
Fields of entities { memoComment { … } }.
| 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. | MemoCommentEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [MemoCommentEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: MemoCommentFilterInput, orderBy: [MemoCommentOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [MemoCommentEntity!]! |
| QUERY | getByCriteria(filter: MemoCommentFilterInput, orderBy: [MemoCommentOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | MemoCommentEntityConnection |
| 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 | createMemoComment(input: CreateMemoCommentInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateMemoCommentPayload |
| MUTATION | updateMemoComment(input: UpdateMemoCommentInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateMemoCommentPayload |
| MUTATION | bulkUpdateMemoComment(input: [CreateOrUpdateMemoCommentInput!]!, deleteInput: [DeleteMemoCommentInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateMemoCommentPayload |
| MUTATION | deleteMemoComment(input: DeleteMemoCommentInput!) | Soft-delete | DeleteMemoCommentPayload |
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.
MemoCommentEntity object 12 fields: isDeleteProtected, id, isDeleted, …
Comment a user wrote on a memo.
| 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. |
memo | MemoEntity | Memo this comment belongs to. |
owner | ClientEntity | User who authored the comment. |
comment | String! | Free-form text body of the comment. |
memoId | ID! | Id of the memo this comment belongs to. |
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. |
MemoCommentEntityConnection object pageInfo: PageInfo!, edges: [MemoCommentEntityEdge]!, totalCount: Int
Paginated list of MemoComment records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [MemoCommentEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
MemoCommentEntityEdge object node: MemoCommentEntity, cursor: String!
A Relay edge containing a MemoCommentEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | MemoCommentEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
MemoCommentFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for MemoComment records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [MemoCommentFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [MemoCommentFilterInput!] | Matches records that meet all of the listed filters. |
NOT | MemoCommentFilterInput | 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. |
comment | EntityFilterStringField | Free-form text body of the comment. |
memoId | EntityFilterStringField | Id of the memo this comment belongs to. |
ownerId | EntityFilterStringField | Id of the comment author. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
memo | MemoFilterInput | Memo this comment belongs to. 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. |
MemoCommentOrderByInput input Asc or Desc per field
Sorting of MemoComment 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. |
memo | [MemoOrderByNestedInput!] | Memo this comment belongs to. 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. |
comment | OrderByEnum | Free-form text body of the comment. |
memoId | OrderByEnum | Id of the memo this comment belongs to. |
ownerId | OrderByEnum | Id of the comment author. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateMemoCommentInput input 7 fields: clientMutationId, modified, created, …
Field values of a new MemoComment 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. |
comment | String! | Free-form text body of the comment. |
memoId | ID! | Id of the memo this comment belongs to. |
ownerId | ID! | Id of the comment author. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateMemoCommentInput input 8 fields: clientMutationId, id, modified, …
Field values of a MemoComment 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. |
comment | String | Free-form text body of the comment. |
memoId | ID | Id of the memo this comment belongs to. |
ownerId | ID | Id of the comment author. |
revision | Int | Revision when entity was lastly changed. |
DeleteMemoCommentInput input clientMutationId: String, id: ID!
Id of the MemoComment 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. |
UpdateMemoCommentInput input 8 fields: clientMutationId, id, modified, …
Id of a MemoComment 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. |
comment | String | Free-form text body of the comment. |
memoId | ID | Id of the memo this comment belongs to. |
ownerId | ID | Id of the comment author. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateMemoCommentPayload object result: BulkUpdateResults!
Result of the bulkUpdateMemoComment mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateMemoCommentPayload object memoComment: MemoCommentEntity, clientMutationId: String
Result of the createMemoComment mutation.
| Field | Type | Description |
|---|---|---|
memoComment | MemoCommentEntity | 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). |
DeleteMemoCommentPayload object memoComment: MemoCommentEntity, clientMutationId: String
Result of the deleteMemoComment mutation.
| Field | Type | Description |
|---|---|---|
memoComment | MemoCommentEntity | 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). |
UpdateMemoCommentPayload object memoComment: MemoCommentEntity, clientMutationId: String
Result of the updateMemoComment mutation.
| Field | Type | Description |
|---|---|---|
memoComment | MemoCommentEntity | 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). |