OBJECT

AppointmentScheduleEntity

link GraphQL Schema definition

  • type AppointmentScheduleEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Relation to single entity instance. Target entity is re-used and not deleted
  • # on de-association.
  • #
  • # Examples:
  • #
  • # Opportunity.owner -> Client, the Client is reused for many opportunities.
  • #
  • # Account.picture -> CloudObject, the CloudObject can be reused on many accounts.
  • #
  • appointmentOwner: ClientEntity
  • appointmentType: AppointmentTypeEntity
  • owner: ClientEntity
  • replyCompanyEmail: CompanyEmailEntity
  • # String value.
  • appointmentDescription: String!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • appointmentDuration: Float
  • # String value.
  • appointmentLocation: String!
  • # Field whose values are strictly defined with an enumeration of values.
  • appointmentLocationType: AppointmentScheduleLocationTypeEnum
  • # Relation to single entity instance.
  • appointmentOwnerId: ID!
  • # String value.
  • appointmentSubject: String!
  • # Boolean value.
  • appointmentSubjectUsesScheduleName: Boolean!
  • # Relation to single entity instance.
  • appointmentTypeId: ID!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • availabilityTzid: String
  • # Whole natural number.
  • bufferTimeAfter: Int!
  • # Whole natural number.
  • bufferTimeBefore: Int!
  • # Field whose values are strictly defined with an enumeration of values.
  • confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum
  • # URL - HTTP address.
  • confirmationPageUrl: String
  • # Boolean value.
  • isEnabled: Boolean!
  • # Whole natural number.
  • minimumNoticeTime: Int!
  • # Name of the entity and its default text representation.
  • name: String!
  • # Relation to single entity instance.
  • ownerId: ID!
  • # Whole natural number.
  • planningDayOffset: Int!
  • # Date information.
  • planningPeriodFrom: Date
  • # Date information.
  • planningPeriodTo: Date
  • # Field whose values are strictly defined with an enumeration of values.
  • planningType: AppointmentSchedulePlanningTypeEnum
  • # Boolean value.
  • reminderEmailEnabled: Boolean!
  • # Whole natural number.
  • reminderEmailOffset: Int!
  • # Field whose values are strictly defined with an enumeration of values.
  • reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum
  • # Relation to single entity instance.
  • replyCompanyEmailId: ID
  • # String value.
  • scheduleName: String!
  • # Whole natural number.
  • timeIncrement: Int!
  • # Field whose values are strictly defined with an enumeration of values.
  • type: AppointmentScheduleTypeEnum
  • # String value.
  • url: String!
  • additionalFieldsData: [AppointmentScheduleAdditionalField!]!
  • availabilityData: AppointmentScheduleAvailability!
  • appointmentInviteesData: [AppointmentScheduleInvitee!]!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Arguments
  • # tzId: [Not documented]
  • # from: [Not documented]
  • # to: [Not documented]
  • availableSlots(tzId: String!, from: Date!, to: Date!): [DateTime!]!
  • createdAppointmentsCount: Int!
  • upcomingAppointmentsCount: Int!
  • completedAppointmentsCount: Int!
  • canceledAppointmentsCount: Int!
  • }

link Require by