GraphQLRepositoriesappointmentClientInviteesRelation
entities.appointmentClientInviteesRelation
Read appointment client invitees relation records with the appointmentClientInviteesRelation repository, and change them with the appointment client invitees relation mutations. Same records as the REST AppointmentClientInviteesRelations entity.
Queries
Fields of entities { appointmentClientInviteesRelation { … } }.
| 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. | AppointmentClientInviteesRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [AppointmentClientInviteesRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: AppointmentClientInviteesRelationFilterInput, orderBy: [AppointmentClientInviteesRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [AppointmentClientInviteesRelationEntity!]! |
| QUERY | getByCriteria(filter: AppointmentClientInviteesRelationFilterInput, orderBy: [AppointmentClientInviteesRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | AppointmentClientInviteesRelationEntityConnection |
| 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 | createAppointmentClientInviteesRelation(input: CreateAppointmentClientInviteesRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateAppointmentClientInviteesRelationPayload |
| MUTATION | updateAppointmentClientInviteesRelation(input: UpdateAppointmentClientInviteesRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateAppointmentClientInviteesRelationPayload |
| MUTATION | bulkUpdateAppointmentClientInviteesRelation(input: [CreateOrUpdateAppointmentClientInviteesRelationInput!]!, deleteInput: [DeleteAppointmentClientInviteesRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateAppointmentClientInviteesRelationPayload |
| MUTATION | deleteAppointmentClientInviteesRelation(input: DeleteAppointmentClientInviteesRelationInput!) | Soft-delete | DeleteAppointmentClientInviteesRelationPayload |
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.
AppointmentClientInviteesRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …
Invitation of a user of the space to an appointment, with their response.
| 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 the user has been invited to. |
client | ClientEntity | Internal user invited to the appointment. |
appointmentId | ID! | Id of the appointment the user has been invited to. |
clientId | ID! | Id of the user. |
response | InviteeResponseEnum | Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. |
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. |
AppointmentClientInviteesRelationEntityConnection object pageInfo: PageInfo!, edges: [AppointmentClientInviteesRelationEntityEdge]!, totalCount: Int
Paginated list of AppointmentClientInviteesRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [AppointmentClientInviteesRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
AppointmentClientInviteesRelationEntityEdge object node: AppointmentClientInviteesRelationEntity, cursor: String!
A Relay edge containing a AppointmentClientInviteesRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | AppointmentClientInviteesRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
AppointmentClientInviteesRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for AppointmentClientInviteesRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [AppointmentClientInviteesRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [AppointmentClientInviteesRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | AppointmentClientInviteesRelationFilterInput | 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. |
appointmentId | EntityFilterStringField | Id of the appointment the user has been invited to. |
clientId | EntityFilterStringField | Id of the user. |
response | InviteeResponseEnumFilterInput | Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
appointment | AppointmentFilterInput | Appointment the user has been invited to. Matches records where a related record meets these conditions. |
client | ClientFilterInput | Internal user invited to the appointment. Matches records where a related record meets these conditions. |
AppointmentClientInviteesRelationOrderByInput input Asc or Desc per field
Sorting of AppointmentClientInviteesRelation 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 the user has been invited to. Sorts by fields of the related record, listed in order of priority. |
client | [ClientOrderByNestedInput!] | Internal user invited to the appointment. Sorts by fields of the related record, listed in order of priority. |
appointmentId | OrderByEnum | Id of the appointment the user has been invited to. |
clientId | OrderByEnum | Id of the user. |
response | OrderByEnum | Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateAppointmentClientInviteesRelationInput input 7 fields: clientMutationId, modified, created, …
Field values of a new AppointmentClientInviteesRelation 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. |
appointmentId | ID! | Id of the appointment the user has been invited to. |
clientId | ID! | Id of the user. |
response | InviteeResponseEnum | Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateAppointmentClientInviteesRelationInput input 8 fields: clientMutationId, id, modified, …
Field values of an AppointmentClientInviteesRelation 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. |
appointmentId | ID | Id of the appointment the user has been invited to. |
clientId | ID | Id of the user. |
response | InviteeResponseEnum | Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. |
revision | Int | Revision when entity was lastly changed. |
DeleteAppointmentClientInviteesRelationInput input clientMutationId: String, id: ID!
Id of the AppointmentClientInviteesRelation 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. |
UpdateAppointmentClientInviteesRelationInput input 8 fields: clientMutationId, id, modified, …
Id of an AppointmentClientInviteesRelation 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. |
appointmentId | ID | Id of the appointment the user has been invited to. |
clientId | ID | Id of the user. |
response | InviteeResponseEnum | Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateAppointmentClientInviteesRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateAppointmentClientInviteesRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateAppointmentClientInviteesRelationPayload object appointmentClientInviteesRelation: AppointmentClientInviteesRelationEntity, clientMutationId: String
Result of the createAppointmentClientInviteesRelation mutation.
| Field | Type | Description |
|---|---|---|
appointmentClientInviteesRelation | AppointmentClientInviteesRelationEntity | 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). |
DeleteAppointmentClientInviteesRelationPayload object appointmentClientInviteesRelation: AppointmentClientInviteesRelationEntity, clientMutationId: String
Result of the deleteAppointmentClientInviteesRelation mutation.
| Field | Type | Description |
|---|---|---|
appointmentClientInviteesRelation | AppointmentClientInviteesRelationEntity | 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). |
UpdateAppointmentClientInviteesRelationPayload object appointmentClientInviteesRelation: AppointmentClientInviteesRelationEntity, clientMutationId: String
Result of the updateAppointmentClientInviteesRelation mutation.
| Field | Type | Description |
|---|---|---|
appointmentClientInviteesRelation | AppointmentClientInviteesRelationEntity | 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). |