components:
  requestBodies:
    BatchOperationRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BatchOperationRequest'
      description: The batch request
      required: true
    PatchDirectiveArray:
      content:
        application/json:
          schema:
            items:
              $ref: '#/components/schemas/PatchDirective'
            type: array
      description: The patch directives conforming to RFC 6902.
      required: true
  schemas:
    BatchOperationRequest:
      additionalProperties: false
      properties:
        operations:
          items:
            additionalProperties: false
            properties:
              id:
                description: The ID of the record
                oneOf:
                  - x-required: true
                title: ID
                type: string
              object:
                title: Object
                type: object
              operation:
                enum:
                  - create
                  - delete
                  - patch
                  - read
                  - update
                title: Operation
                type: string
              patch_directives:
                items:
                  additionalProperties: false
                  properties:
                    op:
                      description: The operation
                      enum:
                        - add
                        - copy
                        - move
                        - remove
                        - replace
                        - test
                      title: Op
                      type: string
                    path:
                      description: The JSON path
                      title: Path
                      type: string
                    value:
                      title: Value
                      type: string
                  required:
                    - op
                    - path
                  type: object
                maxItems: 100
                minItems: 1
                oneOf:
                  - x-required: true
                type: array
            required:
              - operation
            type: object
          type: array
      type: object
    BatchOperationResponse:
      additionalProperties: false
      properties:
        error_count:
          description: Number of error results
          format: float
          title: Error Count
          type: number
        results:
          items:
            additionalProperties: false
            properties:
              error_message:
                title: Error Message
                type: string
              id:
                description: The ID of the record
                title: ID
                type: string
              object:
                title: Object
                type: object
              operation:
                enum:
                  - create
                  - delete
                  - patch
                  - read
                  - update
                title: Operation
                type: string
              outcome:
                enum:
                  - error
                  - no change
                  - success
                title: Outcome
                type: string
            required:
              - id
              - operation
            type: object
          type: array
        success_count:
          description: Number of successful results
          format: float
          title: Success Count
          type: number
      type: object
    Committee:
      additionalProperties: false
      properties:
        chapter_id:
          description: The chapter to which this committee is tied
          title: Chapter
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        enable_nominations:
          description: Allow people to submit nominations through the portal
          title: Enable Nominations
          type: boolean
        enable_terms:
          description: >-
            If set, then committee members must be assigned along with a term,
            instead of setting start/end dates
          title: Enable Terms
          type: boolean
        enable_volunteers:
          description: Allow people to volunteer for this committee through the portal
          title: Enable Volunteers
          type: boolean
        event_id:
          description: The event to which this committee is tied
          title: Event
          type: string
        id:
          description: The unique, string identifier of this committee
          pattern: ^[\w|-]+$
          title: ID
          type: string
        is_active:
          description: Whether this an active committee
          title: Is Active
          type: boolean
        name:
          description: The name of the committee
          title: Name
          type: string
        parent_committee_id:
          description: The parent committee (for subcommittees
          title: Parent Committee
          type: string
        portal_description:
          description: Description of this committee in the portal
          title: Portal Description
          type: string
        portal_visibility:
          description: >-
            Describes who - in the portal - should be able to view the members
            of this committee
          enum:
            - members only
            - none
            - public
          title: Portal Visibility
          type: string
        section_id:
          description: The section to which this committee is tied
          title: Section
          type: string
        sys_bulk_load_at:
          description: >-
            If this record was loaded via bulk, the timestamp when the record
            was processed
          title: Sys Bulk Load At
          type: string
        sys_bulk_load_id:
          description: If this record was loaded via bulk, the ID of the bulk load process
          title: Sys Bulk Load
          type: string
        sys_bulk_load_pk:
          description: >-
            If this record was loaded via bulk, the tenant and key of the bulk
            load process used as a partition key
          title: Sys Bulk Load Pk
          type: string
        sys_bulk_load_record_no:
          description: >-
            If this record was loaded via bulk, the record number in the source
            file
          format: float
          title: Sys Bulk Load Record No
          type: number
        sys_bulk_load_source_file:
          description: If this record was loaded via bulk, the source file
          title: Sys Bulk Load Source File
          type: string
        sys_calculated_field_error:
          description: The error associated with the calculated field
          title: Sys Calculated Field Error
          type: string
        sys_calculated_field_errors:
          items:
            additionalProperties: false
            properties:
              error:
                title: Error
                type: string
              field:
                title: Field
                type: string
            type: object
          type: array
        sys_configuration_snapshot_id:
          description: >-
            If a snapshot was restored/applies to this record, the ID of the
            snapshot
          title: Sys Configuration Snapshot
          type: string
        sys_created_at:
          description: >-
            The date/time that this record was created, expressed in ISO-8601
            date format
          format: date-time
          title: Sys Created At
          type: string
        sys_created_by_id:
          description: The ID of the user that created this record
          title: Sys Created By
          type: string
        sys_deleted_by_id:
          description: >-
            The ID of the user that deleted (or last tried to delete) this
            object
          title: Sys Deleted By
          type: string
        sys_directive:
          description: >-
            Means for passing directive information into an object processing
            logic
          title: Sys Directive
          type: string
        sys_external_id:
          description: The ID that a record has from an external system or data import
          title: Sys External
          type: string
        sys_has_files_in_s3:
          description: >-
            If true, this record has files in S3. If false, it doesnt, so no
            need to hit S3 upon deletion
          title: Sys Has Files In S3
          type: boolean
        sys_last_bulk_data_operation_id:
          description: >-
            If this record was last touched by a bulk data operation, the ID of
            that operation
          title: Sys Last Bulk Data Operation
          type: string
        sys_last_bulk_data_operation_sys_version:
          description: >-
            If this record was last touched by a bulk data operation, the
            sys_version at the time of that operation
          title: Sys Last Bulk Data Operation Sys Version
          type: string
        sys_last_modified_at:
          description: >-
            The date/time that this record record was last modified, expressed
            in ISO-8601 date format
          format: date-time
          title: Sys Last Modified At
          type: string
        sys_last_modified_by_id:
          description: The ID of the user that last modified this record
          title: Sys Last Modified By
          type: string
        sys_last_security_context:
          description: >-
            The security context of the last insert, modify, or delete performed
            on this item
          properties: {}
          title: Sys Last Security Context
          type: object
        sys_locked:
          description: If set, this record is locked and cannot be changed via the API
          title: Sys Locked
          type: boolean
        sys_snapshot_base_version:
          description: >-
            The version to use as a base when creating a configuration snapshot;
            if not set, 1 is used. Helpful when creating a sandbox
          format: float
          title: Sys Snapshot Base Version
          type: number
        sys_version:
          description: A number representing the version of this record in the database
          format: float
          title: Sys Version
          type: number
        terms:
          description: Committee terms
          items:
            additionalProperties: false
            properties:
              end_date:
                description: The end date of the committee term
                format: date
                title: End Date
                type: string
              id:
                description: The unique id of the term
                title: ID
                type: string
              name:
                description: The name of the term
                title: Name
                type: string
              start_date:
                description: The start date of the committee term
                format: date
                title: Start Date
                type: string
            required:
              - end_date
              - id
              - name
              - start_date
            type: object
          type: array
        type_id:
          description: The committee type
          title: Type
          type: string
      required:
        - id
        - name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
        - type_id
      type: object
    CommitteeSearchParameters:
      additionalProperties: false
      properties:
        chapter_id:
          description: The chapter
          title: Chapter
          type: string
        id:
          description: IDs to search
          items:
            type: string
          title: ID
          type: array
        is_active:
          items:
            type: boolean
          title: Is Active
          type: array
        name:
          title: Name
          type: string
        section_id:
          description: The section
          title: Section
          type: string
        type_id:
          description: Types to search
          items:
            type: string
          title: Type
          type: array
      type: object
    CommitteeSearchResults:
      additionalProperties: false
      properties:
        chapter_id:
          description: The chapter
          title: Chapter
          type: string
        id:
          title: ID
          type: string
        is_active:
          title: Is Active
          type: boolean
        name:
          title: Name
          type: string
        section_id:
          description: The section
          title: Section
          type: string
        type_id:
          title: Type
          type: string
      type: object
    CustomFieldValue:
      additionalProperties: false
      properties:
        boolean_value:
          description: The boolean value
          title: Boolean Value
          type: boolean
        custom_field_id:
          description: The unique identifier of the custom field
          title: Custom Field
          type: string
        file_url_value:
          description: The pointer to a file value
          title: File Url Value
          type: string
        list_value:
          description: The list value
          items:
            type: string
          title: List Value
          type: array
        numeric_value:
          description: The numeric value
          format: float
          title: Numeric Value
          type: number
        string_value:
          description: The string value of the custom field
          title: String Value
          type: string
        table_value:
          description: A list of objects (a table)
          items:
            additionalProperties: false
            properties: {}
            type: object
          type: array
      type: object
    ListCommitteesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Committee'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListMembershipsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Membership'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    Membership:
      additionalProperties: false
      properties:
        committee_id:
          description: The committee member
          title: Committee
          type: string
        contact_id:
          description: The member contact
          title: Contact
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        end_date:
          description: The start date of the membership
          title: End Date
          type: string
        id:
          description: The unique, string identifier of this committee membership
          pattern: ^[\w-:]+$
          title: ID
          type: string
        notes:
          description: Any notes
          title: Notes
          type: string
        position_id:
          description: The committee position
          title: Position
          type: string
        position_name:
          description: The name of the committee position
          title: Position Name
          type: string
        position_sort:
          description: The committee position name for sorting
          title: Position Sort
          type: string
        start_date:
          description: The start date of the membership
          title: Start Date
          type: string
        sys_bulk_load_at:
          description: >-
            If this record was loaded via bulk, the timestamp when the record
            was processed
          title: Sys Bulk Load At
          type: string
        sys_bulk_load_id:
          description: If this record was loaded via bulk, the ID of the bulk load process
          title: Sys Bulk Load
          type: string
        sys_bulk_load_pk:
          description: >-
            If this record was loaded via bulk, the tenant and key of the bulk
            load process used as a partition key
          title: Sys Bulk Load Pk
          type: string
        sys_bulk_load_record_no:
          description: >-
            If this record was loaded via bulk, the record number in the source
            file
          format: float
          title: Sys Bulk Load Record No
          type: number
        sys_bulk_load_source_file:
          description: If this record was loaded via bulk, the source file
          title: Sys Bulk Load Source File
          type: string
        sys_calculated_field_error:
          description: The error associated with the calculated field
          title: Sys Calculated Field Error
          type: string
        sys_calculated_field_errors:
          items:
            additionalProperties: false
            properties:
              error:
                title: Error
                type: string
              field:
                title: Field
                type: string
            type: object
          type: array
        sys_configuration_snapshot_id:
          description: >-
            If a snapshot was restored/applies to this record, the ID of the
            snapshot
          title: Sys Configuration Snapshot
          type: string
        sys_created_at:
          description: >-
            The date/time that this record was created, expressed in ISO-8601
            date format
          format: date-time
          title: Sys Created At
          type: string
        sys_created_by_id:
          description: The ID of the user that created this record
          title: Sys Created By
          type: string
        sys_deleted_by_id:
          description: >-
            The ID of the user that deleted (or last tried to delete) this
            object
          title: Sys Deleted By
          type: string
        sys_directive:
          description: >-
            Means for passing directive information into an object processing
            logic
          title: Sys Directive
          type: string
        sys_external_id:
          description: The ID that a record has from an external system or data import
          title: Sys External
          type: string
        sys_has_files_in_s3:
          description: >-
            If true, this record has files in S3. If false, it doesnt, so no
            need to hit S3 upon deletion
          title: Sys Has Files In S3
          type: boolean
        sys_last_bulk_data_operation_id:
          description: >-
            If this record was last touched by a bulk data operation, the ID of
            that operation
          title: Sys Last Bulk Data Operation
          type: string
        sys_last_bulk_data_operation_sys_version:
          description: >-
            If this record was last touched by a bulk data operation, the
            sys_version at the time of that operation
          title: Sys Last Bulk Data Operation Sys Version
          type: string
        sys_last_modified_at:
          description: >-
            The date/time that this record record was last modified, expressed
            in ISO-8601 date format
          format: date-time
          title: Sys Last Modified At
          type: string
        sys_last_modified_by_id:
          description: The ID of the user that last modified this record
          title: Sys Last Modified By
          type: string
        sys_last_security_context:
          description: >-
            The security context of the last insert, modify, or delete performed
            on this item
          properties: {}
          title: Sys Last Security Context
          type: object
        sys_locked:
          description: If set, this record is locked and cannot be changed via the API
          title: Sys Locked
          type: boolean
        sys_snapshot_base_version:
          description: >-
            The version to use as a base when creating a configuration snapshot;
            if not set, 1 is used. Helpful when creating a sandbox
          format: float
          title: Sys Snapshot Base Version
          type: number
        sys_version:
          description: A number representing the version of this record in the database
          format: float
          title: Sys Version
          type: number
        term_id:
          description: The optional committee term
          title: Term
          type: string
      required:
        - committee_id
        - contact_id
        - id
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    Nomination:
      additionalProperties: false
      properties:
        committee_id:
          description: The committee the person is being nominated to
          title: Committee
          type: string
        committee_position_id:
          description: The position o the committee the person is being nominated
          title: Committee Position
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        id:
          description: The unique, string identifier of this committee nomination
          pattern: ^[\w|-]+$
          title: ID
          type: string
        nominee_email_address:
          description: The email of the nominee
          title: Nominee Email Address
          type: string
        nominee_first_name:
          description: The first name of the nominee
          title: Nominee First Name
          type: string
        nominee_id:
          description: 'The ID of the nominee '
          title: Nominee
          type: string
        nominee_last_name:
          description: The last  name of the nominee
          title: Nominee Last Name
          type: string
        nominee_phone_number:
          description: The phone number of the nominee
          title: Nominee Phone Number
          type: string
        notes:
          description: Notes
          title: Notes
          type: string
        status:
          enum:
            - accepted
            - declined
            - draft
            - under review
          title: Status
          type: string
        sys_bulk_load_at:
          description: >-
            If this record was loaded via bulk, the timestamp when the record
            was processed
          title: Sys Bulk Load At
          type: string
        sys_bulk_load_id:
          description: If this record was loaded via bulk, the ID of the bulk load process
          title: Sys Bulk Load
          type: string
        sys_bulk_load_pk:
          description: >-
            If this record was loaded via bulk, the tenant and key of the bulk
            load process used as a partition key
          title: Sys Bulk Load Pk
          type: string
        sys_bulk_load_record_no:
          description: >-
            If this record was loaded via bulk, the record number in the source
            file
          format: float
          title: Sys Bulk Load Record No
          type: number
        sys_bulk_load_source_file:
          description: If this record was loaded via bulk, the source file
          title: Sys Bulk Load Source File
          type: string
        sys_calculated_field_error:
          description: The error associated with the calculated field
          title: Sys Calculated Field Error
          type: string
        sys_calculated_field_errors:
          items:
            additionalProperties: false
            properties:
              error:
                title: Error
                type: string
              field:
                title: Field
                type: string
            type: object
          type: array
        sys_configuration_snapshot_id:
          description: >-
            If a snapshot was restored/applies to this record, the ID of the
            snapshot
          title: Sys Configuration Snapshot
          type: string
        sys_created_at:
          description: >-
            The date/time that this record was created, expressed in ISO-8601
            date format
          format: date-time
          title: Sys Created At
          type: string
        sys_created_by_id:
          description: The ID of the user that created this record
          title: Sys Created By
          type: string
        sys_deleted_by_id:
          description: >-
            The ID of the user that deleted (or last tried to delete) this
            object
          title: Sys Deleted By
          type: string
        sys_directive:
          description: >-
            Means for passing directive information into an object processing
            logic
          title: Sys Directive
          type: string
        sys_external_id:
          description: The ID that a record has from an external system or data import
          title: Sys External
          type: string
        sys_has_files_in_s3:
          description: >-
            If true, this record has files in S3. If false, it doesnt, so no
            need to hit S3 upon deletion
          title: Sys Has Files In S3
          type: boolean
        sys_last_bulk_data_operation_id:
          description: >-
            If this record was last touched by a bulk data operation, the ID of
            that operation
          title: Sys Last Bulk Data Operation
          type: string
        sys_last_bulk_data_operation_sys_version:
          description: >-
            If this record was last touched by a bulk data operation, the
            sys_version at the time of that operation
          title: Sys Last Bulk Data Operation Sys Version
          type: string
        sys_last_modified_at:
          description: >-
            The date/time that this record record was last modified, expressed
            in ISO-8601 date format
          format: date-time
          title: Sys Last Modified At
          type: string
        sys_last_modified_by_id:
          description: The ID of the user that last modified this record
          title: Sys Last Modified By
          type: string
        sys_last_security_context:
          description: >-
            The security context of the last insert, modify, or delete performed
            on this item
          properties: {}
          title: Sys Last Security Context
          type: object
        sys_locked:
          description: If set, this record is locked and cannot be changed via the API
          title: Sys Locked
          type: boolean
        sys_snapshot_base_version:
          description: >-
            The version to use as a base when creating a configuration snapshot;
            if not set, 1 is used. Helpful when creating a sandbox
          format: float
          title: Sys Snapshot Base Version
          type: number
        sys_version:
          description: A number representing the version of this record in the database
          format: float
          title: Sys Version
          type: number
      required:
        - committee_id
        - id
        - nominee_first_name
        - nominee_last_name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    PagedCommitteeSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/CommitteeSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PatchDirective:
      additionalProperties: false
      properties:
        op:
          description: The operation
          enum:
            - add
            - copy
            - move
            - remove
            - replace
            - test
          title: Op
          type: string
        path:
          description: The JSON path
          title: Path
          type: string
        value:
          title: Value
          type: string
      required:
        - op
        - path
      type: object
    Position:
      additionalProperties: false
      properties:
        applies_only_to_certain_committee_types:
          description: >-
            If set to true, this position is only applicable to certain
            committee types
          title: Applies Only To Certain Committee Types
          type: boolean
        committee_type_ids:
          description: >-
            The committee types that this position applies to; if not set, it
            will apply to all
          items:
            type: string
          title: Committee Types
          type: array
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        display_order:
          description: The default display order of the position in the committee
          format: float
          title: Display Order
          type: number
        id:
          description: The unique, string identifier of this committee position
          pattern: ^[\w|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this committee position is active
          title: Is Active
          type: boolean
        name:
          description: The name of the committee position
          title: Name
          type: string
        sys_bulk_load_at:
          description: >-
            If this record was loaded via bulk, the timestamp when the record
            was processed
          title: Sys Bulk Load At
          type: string
        sys_bulk_load_id:
          description: If this record was loaded via bulk, the ID of the bulk load process
          title: Sys Bulk Load
          type: string
        sys_bulk_load_pk:
          description: >-
            If this record was loaded via bulk, the tenant and key of the bulk
            load process used as a partition key
          title: Sys Bulk Load Pk
          type: string
        sys_bulk_load_record_no:
          description: >-
            If this record was loaded via bulk, the record number in the source
            file
          format: float
          title: Sys Bulk Load Record No
          type: number
        sys_bulk_load_source_file:
          description: If this record was loaded via bulk, the source file
          title: Sys Bulk Load Source File
          type: string
        sys_calculated_field_error:
          description: The error associated with the calculated field
          title: Sys Calculated Field Error
          type: string
        sys_calculated_field_errors:
          items:
            additionalProperties: false
            properties:
              error:
                title: Error
                type: string
              field:
                title: Field
                type: string
            type: object
          type: array
        sys_configuration_snapshot_id:
          description: >-
            If a snapshot was restored/applies to this record, the ID of the
            snapshot
          title: Sys Configuration Snapshot
          type: string
        sys_created_at:
          description: >-
            The date/time that this record was created, expressed in ISO-8601
            date format
          format: date-time
          title: Sys Created At
          type: string
        sys_created_by_id:
          description: The ID of the user that created this record
          title: Sys Created By
          type: string
        sys_deleted_by_id:
          description: >-
            The ID of the user that deleted (or last tried to delete) this
            object
          title: Sys Deleted By
          type: string
        sys_directive:
          description: >-
            Means for passing directive information into an object processing
            logic
          title: Sys Directive
          type: string
        sys_external_id:
          description: The ID that a record has from an external system or data import
          title: Sys External
          type: string
        sys_has_files_in_s3:
          description: >-
            If true, this record has files in S3. If false, it doesnt, so no
            need to hit S3 upon deletion
          title: Sys Has Files In S3
          type: boolean
        sys_last_bulk_data_operation_id:
          description: >-
            If this record was last touched by a bulk data operation, the ID of
            that operation
          title: Sys Last Bulk Data Operation
          type: string
        sys_last_bulk_data_operation_sys_version:
          description: >-
            If this record was last touched by a bulk data operation, the
            sys_version at the time of that operation
          title: Sys Last Bulk Data Operation Sys Version
          type: string
        sys_last_modified_at:
          description: >-
            The date/time that this record record was last modified, expressed
            in ISO-8601 date format
          format: date-time
          title: Sys Last Modified At
          type: string
        sys_last_modified_by_id:
          description: The ID of the user that last modified this record
          title: Sys Last Modified By
          type: string
        sys_last_security_context:
          description: >-
            The security context of the last insert, modify, or delete performed
            on this item
          properties: {}
          title: Sys Last Security Context
          type: object
        sys_locked:
          description: If set, this record is locked and cannot be changed via the API
          title: Sys Locked
          type: boolean
        sys_snapshot_base_version:
          description: >-
            The version to use as a base when creating a configuration snapshot;
            if not set, 1 is used. Helpful when creating a sandbox
          format: float
          title: Sys Snapshot Base Version
          type: number
        sys_version:
          description: A number representing the version of this record in the database
          format: float
          title: Sys Version
          type: number
      required:
        - id
        - name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    Type:
      additionalProperties: false
      properties:
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        id:
          description: The unique, string identifier of this committee type
          pattern: ^[\w|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this committee type is active
          title: Is Active
          type: boolean
        name:
          description: The name of the committee type
          title: Name
          type: string
        sys_bulk_load_at:
          description: >-
            If this record was loaded via bulk, the timestamp when the record
            was processed
          title: Sys Bulk Load At
          type: string
        sys_bulk_load_id:
          description: If this record was loaded via bulk, the ID of the bulk load process
          title: Sys Bulk Load
          type: string
        sys_bulk_load_pk:
          description: >-
            If this record was loaded via bulk, the tenant and key of the bulk
            load process used as a partition key
          title: Sys Bulk Load Pk
          type: string
        sys_bulk_load_record_no:
          description: >-
            If this record was loaded via bulk, the record number in the source
            file
          format: float
          title: Sys Bulk Load Record No
          type: number
        sys_bulk_load_source_file:
          description: If this record was loaded via bulk, the source file
          title: Sys Bulk Load Source File
          type: string
        sys_calculated_field_error:
          description: The error associated with the calculated field
          title: Sys Calculated Field Error
          type: string
        sys_calculated_field_errors:
          items:
            additionalProperties: false
            properties:
              error:
                title: Error
                type: string
              field:
                title: Field
                type: string
            type: object
          type: array
        sys_configuration_snapshot_id:
          description: >-
            If a snapshot was restored/applies to this record, the ID of the
            snapshot
          title: Sys Configuration Snapshot
          type: string
        sys_created_at:
          description: >-
            The date/time that this record was created, expressed in ISO-8601
            date format
          format: date-time
          title: Sys Created At
          type: string
        sys_created_by_id:
          description: The ID of the user that created this record
          title: Sys Created By
          type: string
        sys_deleted_by_id:
          description: >-
            The ID of the user that deleted (or last tried to delete) this
            object
          title: Sys Deleted By
          type: string
        sys_directive:
          description: >-
            Means for passing directive information into an object processing
            logic
          title: Sys Directive
          type: string
        sys_external_id:
          description: The ID that a record has from an external system or data import
          title: Sys External
          type: string
        sys_has_files_in_s3:
          description: >-
            If true, this record has files in S3. If false, it doesnt, so no
            need to hit S3 upon deletion
          title: Sys Has Files In S3
          type: boolean
        sys_last_bulk_data_operation_id:
          description: >-
            If this record was last touched by a bulk data operation, the ID of
            that operation
          title: Sys Last Bulk Data Operation
          type: string
        sys_last_bulk_data_operation_sys_version:
          description: >-
            If this record was last touched by a bulk data operation, the
            sys_version at the time of that operation
          title: Sys Last Bulk Data Operation Sys Version
          type: string
        sys_last_modified_at:
          description: >-
            The date/time that this record record was last modified, expressed
            in ISO-8601 date format
          format: date-time
          title: Sys Last Modified At
          type: string
        sys_last_modified_by_id:
          description: The ID of the user that last modified this record
          title: Sys Last Modified By
          type: string
        sys_last_security_context:
          description: >-
            The security context of the last insert, modify, or delete performed
            on this item
          properties: {}
          title: Sys Last Security Context
          type: object
        sys_locked:
          description: If set, this record is locked and cannot be changed via the API
          title: Sys Locked
          type: boolean
        sys_snapshot_base_version:
          description: >-
            The version to use as a base when creating a configuration snapshot;
            if not set, 1 is used. Helpful when creating a sandbox
          format: float
          title: Sys Snapshot Base Version
          type: number
        sys_version:
          description: A number representing the version of this record in the database
          format: float
          title: Sys Version
          type: number
      required:
        - id
        - name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
  securitySchemes:
    knox-authorizer:
      bearerFormat: JWT
      scheme: bearer
      type: http
info:
  description: >
    The Committees API provides all the capabilities for managing your
    committees. From here you can look up the current

    members of a committee, create new committee terms, or modify existing
    committee memberships.


    Query Definitions for Committees are housed under the Membership API. 
  title: Committees
  version: v1-2025-04-18
openapi: 3.0.0
paths:
  /committees/{tenantId}:
    get:
      description: Returns a list of records with the specified tenant_id
      operationId: listCommitteesByTenantId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: If paging, this allows you to return the next set of results
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCommitteesResponse'
          description: The records were retrieved successfully
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: Unable to locate records
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve records based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a list of records with the specified tenant_id
      tags:
        - Committees
    post:
      description: >-
        This method will auto-generate an ID and create a new committee. If an
        ID is specified for the committee, an error will be thrown.
      operationId: createCommittee
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Committee'
        description: The committee that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Committee'
          description: The committee was saved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The committee you supplied was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The committee could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add committee based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Creates a new committee record that does not already exist.
      tags:
        - Committees
  /committees/{tenantId}/batch:
    post:
      description: TAllows you to perform up to 100 parallel patch/delete operations
      operationId: executeBatchOperations
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/BatchOperationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchOperationResponse'
          description: Request completed successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The committee could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve committee based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Execute Batch Operations
      tags:
        - Committees
  /committees/{tenantId}/chapter/{chapter_id}:
    get:
      description: Returns a list of records with the specified chapter_id
      operationId: listCommitteesByChapterId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: chapter_id
          required: true
          description: The chapter_id to use to for record lookup
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: If paging, this allows you to return the next set of results
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCommitteesResponse'
          description: The records were retrieved successfully
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: Unable to locate records
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve records based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a list of records with the specified chapter_id
      tags:
        - Committees
  /committees/{tenantId}/parentCommittee/{parent_committee_id}:
    get:
      description: Returns a list of records with the specified parent_committee_id
      operationId: listCommitteesByParentCommitteeId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: parent_committee_id
          required: true
          description: The parent_committee_id to use to for record lookup
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: If paging, this allows you to return the next set of results
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCommitteesResponse'
          description: The records were retrieved successfully
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: Unable to locate records
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve records based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a list of records with the specified parent_committee_id
      tags:
        - Committees
  /committees/{tenantId}/search:
    post:
      description: Searches for committees using predefined parameters
      operationId: searchForCommittees
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: The start key for the search, for paging support
          schema:
            type: string
        - in: query
          name: fieldsToReturn
          required: false
          description: '  The fields that you want to retrieve; if omitted, the entire object is returned'
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommitteeSearchParameters'
        description: The committee that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedCommitteeSearchResults'
          description: The committee search was saved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The committee you supplied was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The committee could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add committee based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Searches for committees using predefined parameters
      tags:
        - Committees
  /committees/{tenantId}/section/{section_id}:
    get:
      description: Returns a list of records with the specified section_id
      operationId: listCommitteesBySectionId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: section_id
          required: true
          description: The section_id to use to for record lookup
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: If paging, this allows you to return the next set of results
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCommitteesResponse'
          description: The records were retrieved successfully
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: Unable to locate records
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve records based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a list of records with the specified section_id
      tags:
        - Committees
  /committees/{tenantId}/{id}:
    delete:
      description: This method will delete a committee with the specified ID.
      operationId: deleteCommittee
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the committee to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The committee was deleted successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The committee could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The committee could not be deleted because other objects refers
            to/depends on this one.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to delete committee based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a committee from the system by its ID.
      tags:
        - Committees
    get:
      description: >-
        This method will look up a committee by the specified ID and return it
        back.
      operationId: getCommittee
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the committee to return.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: consistentRead
          required: false
          description: Indicates the API should force a consistent read on the data source.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Committee'
          description: The committee was retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The committee could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve committee based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a committee from the system by its ID.
      tags:
        - Committees
    patch:
      description: >-
        This method will patch an existing committee with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchCommittee
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the committee to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Committee'
          description: The committee was patched successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The JSON patch directive you supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The committee could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The committee could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve committee based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Partially updates a committee with the specified ID.
      tags:
        - Committees
    put:
      description: This method will update an existing committee with the specified ID.
      operationId: updateCommittee
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the committee to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Committee'
        description: The updated committee that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Committee'
          description: The committee was updated successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The committee supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The committee could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The committee could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve committee based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Updates a committee with the specified ID.
      tags:
        - Committees
  /memberships/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new membership. If an
        ID is specified for the membership, an error will be thrown.
      operationId: createMembership
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Membership'
        description: The membership that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Membership'
          description: The membership was saved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The membership you supplied was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The membership could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add membership based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Creates a new membership record that does not already exist.
      tags:
        - Memberships
  /memberships/{tenantId}/batch:
    post:
      description: TAllows you to perform up to 100 parallel patch/delete operations
      operationId: executeBatchOperations
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/BatchOperationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchOperationResponse'
          description: Request completed successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The membership could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve membership based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Execute Batch Operations
      tags:
        - Memberships
  /memberships/{tenantId}/committee/{committee_id}:
    get:
      description: Returns a list of records with the specified committee_id
      operationId: listMembershipsByCommitteeId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: committee_id
          required: true
          description: The committee_id to use to for record lookup
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: If paging, this allows you to return the next set of results
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMembershipsResponse'
          description: The records were retrieved successfully
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: Unable to locate records
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve records based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a list of records with the specified committee_id
      tags:
        - Memberships
  /memberships/{tenantId}/contact/{contact_id}:
    get:
      description: Returns a list of records with the specified contact_id
      operationId: listMembershipsByContactId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: contact_id
          required: true
          description: The contact_id to use to for record lookup
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: If paging, this allows you to return the next set of results
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMembershipsResponse'
          description: The records were retrieved successfully
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: Unable to locate records
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve records based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a list of records with the specified contact_id
      tags:
        - Memberships
  /memberships/{tenantId}/{id}:
    delete:
      description: This method will delete a membership with the specified ID.
      operationId: deleteMembership
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the membership to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The membership was deleted successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The membership could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The membership could not be deleted because other objects refers
            to/depends on this one.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to delete membership based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a membership from the system by its ID.
      tags:
        - Memberships
    get:
      description: >-
        This method will look up a membership by the specified ID and return it
        back.
      operationId: getMembership
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the membership to return.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: consistentRead
          required: false
          description: Indicates the API should force a consistent read on the data source.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Membership'
          description: The membership was retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The membership could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve membership based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a membership from the system by its ID.
      tags:
        - Memberships
    patch:
      description: >-
        This method will patch an existing membership with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchMembership
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the membership to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Membership'
          description: The membership was patched successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The JSON patch directive you supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The membership could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The membership could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve membership based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Partially updates a membership with the specified ID.
      tags:
        - Memberships
    put:
      description: This method will update an existing membership with the specified ID.
      operationId: updateMembership
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the membership to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Membership'
        description: The updated membership that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Membership'
          description: The membership was updated successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The membership supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The membership could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The membership could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve membership based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Updates a membership with the specified ID.
      tags:
        - Memberships
  /nominations/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new nomination. If an
        ID is specified for the nomination, an error will be thrown.
      operationId: createNomination
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Nomination'
        description: The nomination that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nomination'
          description: The nomination was saved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The nomination you supplied was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The nomination could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add nomination based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Creates a new nomination record that does not already exist.
      tags:
        - Nominations
  /nominations/{tenantId}/batch:
    post:
      description: TAllows you to perform up to 100 parallel patch/delete operations
      operationId: executeBatchOperations
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/BatchOperationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchOperationResponse'
          description: Request completed successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The nomination could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve nomination based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Execute Batch Operations
      tags:
        - Nominations
  /nominations/{tenantId}/{id}:
    delete:
      description: This method will delete a nomination with the specified ID.
      operationId: deleteNomination
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the nomination to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The nomination was deleted successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The nomination could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The nomination could not be deleted because other objects refers
            to/depends on this one.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to delete nomination based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a nomination from the system by its ID.
      tags:
        - Nominations
    get:
      description: >-
        This method will look up a nomination by the specified ID and return it
        back.
      operationId: getNomination
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the nomination to return.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: consistentRead
          required: false
          description: Indicates the API should force a consistent read on the data source.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nomination'
          description: The nomination was retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The nomination could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve nomination based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a nomination from the system by its ID.
      tags:
        - Nominations
    patch:
      description: >-
        This method will patch an existing nomination with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchNomination
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the nomination to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nomination'
          description: The nomination was patched successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The JSON patch directive you supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The nomination could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The nomination could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve nomination based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Partially updates a nomination with the specified ID.
      tags:
        - Nominations
    put:
      description: This method will update an existing nomination with the specified ID.
      operationId: updateNomination
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the nomination to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Nomination'
        description: The updated nomination that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nomination'
          description: The nomination was updated successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The nomination supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The nomination could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The nomination could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve nomination based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Updates a nomination with the specified ID.
      tags:
        - Nominations
  /positions/{tenantId}:
    get:
      description: This method will scan all positions and and return them to the caller.
      operationId: listPositions
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: The start key, if you're making a subsequent request
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Position'
                type: array
          description: The positionswere retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add contact role based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Gets all of the positions in the system.
      tags:
        - Positions
    post:
      description: >-
        This method will auto-generate an ID and create a new position. If an ID
        is specified for the position, an error will be thrown.
      operationId: createPosition
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Position'
        description: The position that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Position'
          description: The position was saved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The position you supplied was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The position could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add position based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Creates a new position record that does not already exist.
      tags:
        - Positions
  /positions/{tenantId}/batch:
    post:
      description: TAllows you to perform up to 100 parallel patch/delete operations
      operationId: executeBatchOperations
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/BatchOperationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchOperationResponse'
          description: Request completed successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The position could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve position based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Execute Batch Operations
      tags:
        - Positions
  /positions/{tenantId}/{id}:
    delete:
      description: This method will delete a position with the specified ID.
      operationId: deletePosition
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the position to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The position was deleted successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The position could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The position could not be deleted because other objects refers
            to/depends on this one.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to delete position based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a position from the system by its ID.
      tags:
        - Positions
    get:
      description: >-
        This method will look up a position by the specified ID and return it
        back.
      operationId: getPosition
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the position to return.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: consistentRead
          required: false
          description: Indicates the API should force a consistent read on the data source.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Position'
          description: The position was retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The position could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve position based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a position from the system by its ID.
      tags:
        - Positions
    patch:
      description: >-
        This method will patch an existing position with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchPosition
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the position to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Position'
          description: The position was patched successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The JSON patch directive you supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The position could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The position could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve position based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Partially updates a position with the specified ID.
      tags:
        - Positions
    put:
      description: This method will update an existing position with the specified ID.
      operationId: updatePosition
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the position to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Position'
        description: The updated position that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Position'
          description: The position was updated successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The position supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The position could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The position could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: >-
            Limit exceeded... unable to retrieve position based on tenant
            limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Updates a position with the specified ID.
      tags:
        - Positions
  /types/{tenantId}:
    get:
      description: This method will scan all types and and return them to the caller.
      operationId: listTypes
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: exclusiveStartKey
          required: false
          description: The start key, if you're making a subsequent request
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Type'
                type: array
          description: The typeswere retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add contact role based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Gets all of the types in the system.
      tags:
        - Types
    post:
      description: >-
        This method will auto-generate an ID and create a new type. If an ID is
        specified for the type, an error will be thrown.
      operationId: createType
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Type'
        description: The type that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Type'
          description: The type was saved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The type you supplied was invalid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The resource could not be found
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The type could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to add type based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Creates a new type record that does not already exist.
      tags:
        - Types
  /types/{tenantId}/batch:
    post:
      description: TAllows you to perform up to 100 parallel patch/delete operations
      operationId: executeBatchOperations
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/BatchOperationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchOperationResponse'
          description: Request completed successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The type could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve type based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Execute Batch Operations
      tags:
        - Types
  /types/{tenantId}/{id}:
    delete:
      description: This method will delete a type with the specified ID.
      operationId: deleteType
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the type to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The type was deleted successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The type could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The type could not be deleted because other objects refers
            to/depends on this one.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to delete type based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a type from the system by its ID.
      tags:
        - Types
    get:
      description: This method will look up a type by the specified ID and return it back.
      operationId: getType
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the type to return.
          schema:
            type: string
        - in: query
          name: fields
          required: false
          description: >-
            The fields that you want to retrieve; if omitted, the entire object
            is returned.
          schema:
            type: string
        - in: query
          name: consistentRead
          required: false
          description: Indicates the API should force a consistent read on the data source.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Type'
          description: The type was retrieved successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The request was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The type could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve type based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Returns a type from the system by its ID.
      tags:
        - Types
    patch:
      description: >-
        This method will patch an existing type with the specified ID, using the
        HTTP PATCH specification.
      operationId: patchType
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the type to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Type'
          description: The type was patched successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The JSON patch directive you supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The type could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The type could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve type based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Partially updates a type with the specified ID.
      tags:
        - Types
    put:
      description: This method will update an existing type with the specified ID.
      operationId: updateType
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
        - in: path
          name: id
          required: true
          description: The ID of the type to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Type'
        description: The updated type that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Type'
          description: The type was updated successfully.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          description: The type supplied was not valid.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '401':
          description: Unauthorized.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          description: Forbidden.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          description: The type could not be found.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '405':
          description: The request method is not allowed.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '409':
          description: >-
            The type could not be saved because it refers to/depends on a
            non-existent object.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '429':
          description: Limit exceeded... unable to retrieve type based on tenant limits.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: General server error.
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - knox-authorizer: []
      summary: Updates a type with the specified ID.
      tags:
        - Types
servers:
  - url: https://committees.api.rhythmsoftware.com
tags:
  - name: Committees
    description: Committees
  - name: Memberships
    description: Memberships
  - name: Nominations
    description: Nominations
  - name: Positions
    description: Positions
  - name: Types
    description: Types
