Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriesallowedAppointmentType

entities.allowedAppointmentType

Read allowed appointment type records with the allowedAppointmentType repository, and change them with the allowed appointment type mutations. Same records as the REST AllowedAppointmentTypes entity.

Queries

Fields of entities { allowedAppointmentType { … } }.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
AllowedAppointmentTypeEntity
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[AllowedAppointmentTypeEntity!]!
QUERYgetAll(limit: Int, offset: Int, filter: AllowedAppointmentTypeFilterInput, orderBy: [AllowedAppointmentTypeOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[AllowedAppointmentTypeEntity!]!
QUERYgetByCriteria(filter: AllowedAppointmentTypeFilterInput, orderBy: [AllowedAppointmentTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
AllowedAppointmentTypeEntityConnection
QUERYgetChangedFieldsSinceRevision(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

KindMutationDoesReturns
MUTATIONcreateAllowedAppointmentType(input: CreateAllowedAppointmentTypeInput!, validationLevel: [ValidationLevel!])Create one recordCreateAllowedAppointmentTypePayload
MUTATIONupdateAllowedAppointmentType(input: UpdateAllowedAppointmentTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateAllowedAppointmentTypePayload
MUTATIONbulkUpdateAllowedAppointmentType(input: [CreateOrUpdateAllowedAppointmentTypeInput!]!, deleteInput: [DeleteAllowedAppointmentTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateAllowedAppointmentTypePayload
MUTATIONdeleteAllowedAppointmentType(input: DeleteAllowedAppointmentTypeInput!)Soft-deleteDeleteAllowedAppointmentTypePayload

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.

AllowedAppointmentTypeEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Appointment type that a user role is allowed to use.

FieldTypeDescription
isDeleteProtectedBoolean!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.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentTypeAppointmentTypeEntityAppointment type the user role can use.
masterRightMasterRightEntityUser role granted access to the appointment type.
appointmentTypeIdID!Id of the appointment type the user role can use.
masterRightIdID!Id of the user role.
revisionIntRevision when entity was lastly changed.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
AllowedAppointmentTypeEntityConnection object pageInfo: PageInfo!, edges: [AllowedAppointmentTypeEntityEdge]!, totalCount: Int

Paginated list of AllowedAppointmentType records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[AllowedAppointmentTypeEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
AllowedAppointmentTypeEntityEdge object node: AllowedAppointmentTypeEntity, cursor: String!

A Relay edge containing a AllowedAppointmentTypeEntity and its cursor.

FieldTypeDescription
nodeAllowedAppointmentTypeEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
AllowedAppointmentTypeFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for AllowedAppointmentType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input fieldTypeDescription
OR[AllowedAppointmentTypeFilterInput!]Matches records that meet at least one of the listed filters.
AND[AllowedAppointmentTypeFilterInput!]Matches records that meet all of the listed filters.
NOTAllowedAppointmentTypeFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
appointmentTypeIdEntityFilterStringFieldId of the appointment type the user role can use.
masterRightIdEntityFilterStringFieldId of the user role.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
appointmentTypeAppointmentTypeFilterInputAppointment type the user role can use. Matches records where a related record meets these conditions.
masterRightMasterRightFilterInputUser role granted access to the appointment type. Matches records where a related record meets these conditions.
AllowedAppointmentTypeOrderByInput input Asc or Desc per field

Sorting of AllowedAppointmentType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
appointmentType[AppointmentTypeOrderByNestedInput!]Appointment type the user role can use. Sorts by fields of the related record, listed in order of priority.
masterRight[MasterRightOrderByNestedInput!]User role granted access to the appointment type. Sorts by fields of the related record, listed in order of priority.
appointmentTypeIdOrderByEnumId of the appointment type the user role can use.
masterRightIdOrderByEnumId of the user role.
revisionOrderByEnumRevision when entity was lastly changed.
CreateAllowedAppointmentTypeInput input 6 fields: clientMutationId, modified, created, …

Field values of a new AllowedAppointmentType record.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentTypeIdID!Id of the appointment type the user role can use.
masterRightIdID!Id of the user role.
revisionIntRevision when entity was lastly changed.
CreateOrUpdateAllowedAppointmentTypeInput input 7 fields: clientMutationId, id, modified, …

Field values of an AllowedAppointmentType record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentTypeIdIDId of the appointment type the user role can use.
masterRightIdIDId of the user role.
revisionIntRevision when entity was lastly changed.
DeleteAllowedAppointmentTypeInput input clientMutationId: String, id: ID!

Id of the AllowedAppointmentType record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
idID!Unique identifier of entity.
UpdateAllowedAppointmentTypeInput input 7 fields: clientMutationId, id, modified, …

Id of an AllowedAppointmentType record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentTypeIdIDId of the appointment type the user role can use.
masterRightIdIDId of the user role.
revisionIntRevision when entity was lastly changed.
BulkUpdateAllowedAppointmentTypePayload object result: BulkUpdateResults!

Result of the bulkUpdateAllowedAppointmentType mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
CreateAllowedAppointmentTypePayload object allowedAppointmentType: AllowedAppointmentTypeEntity, clientMutationId: String

Result of the createAllowedAppointmentType mutation.

FieldTypeDescription
allowedAppointmentTypeAllowedAppointmentTypeEntityThe created record.
clientMutationIdStringOptional 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).
DeleteAllowedAppointmentTypePayload object allowedAppointmentType: AllowedAppointmentTypeEntity, clientMutationId: String

Result of the deleteAllowedAppointmentType mutation.

FieldTypeDescription
allowedAppointmentTypeAllowedAppointmentTypeEntityThe deleted record.
clientMutationIdStringOptional 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).
UpdateAllowedAppointmentTypePayload object allowedAppointmentType: AllowedAppointmentTypeEntity, clientMutationId: String

Result of the updateAllowedAppointmentType mutation.

FieldTypeDescription
allowedAppointmentTypeAllowedAppointmentTypeEntityThe updated record.
clientMutationIdStringOptional 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).