Back to PipelinerAppointmentSchedules.create
Creates new appointmentschedule
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of appointmentschedule on create. Use them as
bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 -
allows to override readonly fields,
16 - allows to set entity on deleted relationship.
title: Parameters
data:
required:
- appointment_description
- appointment_location
- appointment_owner_id
- appointment_subject
- appointment_subject_uses_schedule_name
- appointment_type_id
- buffer_time_after
- buffer_time_before
- is_enabled
- minimum_notice_time
- name
- owner_id
- planning_day_offset
- reminder_email_enabled
- reminder_email_offset
- schedule_name
- time_increment
- url
- additional_fields_data
- availability_data
- appointment_invitees_data
properties:
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
appointment_description:
type: string
example: string
description: String value.
appointment_duration:
type: number
format: double
example: '4.32'
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
appointment_location:
type: string
example: string
description: String value.
appointment_location_type:
type: integer
description: 'Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom'
example: 0
enum:
- 0
- 1
- 2
appointment_owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
appointment_subject:
type: string
example: string
description: String value.
appointment_subject_uses_schedule_name:
type: boolean
example: false
description: Boolean value.
appointment_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
availability_tzid:
type: string
example: string
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
buffer_time_after:
type: integer
format: int32
example: 1
description: Whole natural number.
buffer_time_before:
type: integer
format: int32
example: 1
description: Whole natural number.
confirmation_page_type:
type: integer
description: 'Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl'
example: 0
enum:
- 0
- 1
confirmation_page_url:
type: string
example: string
description: URL - HTTP address.
is_enabled:
type: boolean
example: false
description: Boolean value.
minimum_notice_time:
type: integer
format: int32
example: 1
description: Whole natural number.
name:
type: string
example: string
description: Name of the entity and its default text representation.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
planning_day_offset:
type: integer
format: int32
example: 1
description: Whole natural number.
planning_period_from:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
planning_period_to:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
planning_type:
type: integer
description: 'Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period'
example: 0
enum:
- 0
- 1
- 2
reminder_email_enabled:
type: boolean
example: false
description: Boolean value.
reminder_email_offset:
type: integer
format: int32
example: 1
description: Whole natural number.
reminder_email_offset_type:
type: integer
description: 'Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week'
example: 0
enum:
- 0
- 1
- 2
- 3
schedule_name:
type: string
example: string
description: String value.
time_increment:
type: integer
format: int32
example: 1
description: Whole natural number.
type:
type: integer
description: 'Integer enum value: 0 - OneToOne, 1 - Group'
example: 0
enum:
- 0
- 1
url:
type: string
example: string
description: String value.
additional_fields_data:
type: array
description: ''
items:
type: object
required:
- field_id
- label
- is_required
properties:
field_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Field id
label:
type: string
example: string
description: Field label
is_required:
type: boolean
example: false
description: Whether value may be null/empty
availability_data:
type: object
description: ''
appointment_invitees_data:
type: array
description: ''
items:
type: object
required:
- email
- type
properties:
entity_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Entity id or null
email:
type: string
example: string
description: Email address
type:
type: integer
description: 'Integer enum value: 1 - Client, 2 - Contact, 3 - Email'
example: 1
enum:
- 1
- 2
- 3
type: object
title: Data
Output
type: object
properties:
success:
type: boolean
example: true
description: True when response succeeded, false on error.
data:
required:
- is_delete_protected
- id
- appointment_owner
- appointment_type
- owner
- appointment_description
- appointment_location
- appointment_owner_id
- appointment_subject
- appointment_subject_uses_schedule_name
- appointment_type_id
- buffer_time_after
- buffer_time_before
- is_enabled
- minimum_notice_time
- name
- owner_id
- planning_day_offset
- reminder_email_enabled
- reminder_email_offset
- schedule_name
- time_increment
- url
- additional_fields_data
- availability_data
- appointment_invitees_data
properties:
is_delete_protected:
type: boolean
example: false
description: >-
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.
readOnly: true
id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Unique identifier of entity.
readOnly: true
is_deleted:
type: boolean
example: false
description: Specifies if the entity is considered deleted.
readOnly: true
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
appointment_owner:
type: string
format: uri
description: >-
Relation to Client. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Client' object for properties.
appointment_type:
type: string
format: uri
description: >-
Relation to AppointmentType. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'AppointmentType' object for properties.
owner:
type: string
format: uri
description: >-
Relation to Client. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Client' object for properties.
appointment_description:
type: string
example: string
description: String value.
appointment_duration:
type: number
format: double
example: '4.32'
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
appointment_location:
type: string
example: string
description: String value.
appointment_location_type:
type: integer
description: 'Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom'
example: 0
enum:
- 0
- 1
- 2
appointment_owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
appointment_subject:
type: string
example: string
description: String value.
appointment_subject_uses_schedule_name:
type: boolean
example: false
description: Boolean value.
appointment_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
availability_tzid:
type: string
example: string
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
buffer_time_after:
type: integer
format: int32
example: 1
description: Whole natural number.
buffer_time_before:
type: integer
format: int32
example: 1
description: Whole natural number.
confirmation_page_type:
type: integer
description: 'Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl'
example: 0
enum:
- 0
- 1
confirmation_page_url:
type: string
example: string
description: URL - HTTP address.
is_enabled:
type: boolean
example: false
description: Boolean value.
minimum_notice_time:
type: integer
format: int32
example: 1
description: Whole natural number.
name:
type: string
example: string
description: Name of the entity and its default text representation.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
planning_day_offset:
type: integer
format: int32
example: 1
description: Whole natural number.
planning_period_from:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
planning_period_to:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
planning_type:
type: integer
description: 'Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period'
example: 0
enum:
- 0
- 1
- 2
reminder_email_enabled:
type: boolean
example: false
description: Boolean value.
reminder_email_offset:
type: integer
format: int32
example: 1
description: Whole natural number.
reminder_email_offset_type:
type: integer
description: 'Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week'
example: 0
enum:
- 0
- 1
- 2
- 3
schedule_name:
type: string
example: string
description: String value.
time_increment:
type: integer
format: int32
example: 1
description: Whole natural number.
type:
type: integer
description: 'Integer enum value: 0 - OneToOne, 1 - Group'
example: 0
enum:
- 0
- 1
url:
type: string
example: string
description: String value.
additional_fields_data:
type: array
description: ''
items:
type: object
required:
- field_id
- label
- is_required
properties:
field_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Field id
label:
type: string
example: string
description: Field label
is_required:
type: boolean
example: false
description: Whether value may be null/empty
availability_data:
type: object
description: ''
appointment_invitees_data:
type: array
description: ''
items:
type: object
required:
- email
- type
properties:
entity_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Entity id or null
email:
type: string
example: string
description: Email address
type:
type: integer
description: 'Integer enum value: 1 - Client, 2 - Contact, 3 - Email'
example: 1
enum:
- 1
- 2
- 3
type: object