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
    PreviewEmailRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PreviewEmailRequest'
      description: The domain_name to use to for record lookup
      required: true
  schemas:
    Application:
      additionalProperties: false
      properties:
        average_score:
          description: The average score for this submission in the most recent round
          format: float
          title: Average Score
          type: number
        award_id:
          description: The id of the award
          title: Award
          type: string
        award_type_id:
          description: The type of the award
          title: Award Type
          type: string
        bucket_id:
          description: The review bucket
          title: Bucket
          type: string
        city:
          description: The member city
          title: City
          type: string
        contact_id:
          description: The contact for this application
          title: Contact
          type: string
        country:
          description: The member country
          title: Country
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        date:
          description: The date of application
          title: Date
          type: string
        email_address:
          description: The member's email address
          title: Email Address
          type: string
        fee_id:
          description: Id of the application fee
          title: Fee
          type: string
        first_name:
          description: The member's first name
          title: First Name
          type: string
        id:
          description: The unique, string identifier of this application
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        job_title:
          description: The member job title
          title: Job Title
          type: string
        last_name:
          description: The member's last name
          title: Last Name
          type: string
        last_review_status_change:
          description: The date that the review status was last changed
          format: date-time
          title: Last Review Status Change
          type: string
        name:
          description: The member's name
          title: Name
          type: string
        nominee_id:
          description: The nominee to which this application is linked
          title: Nominee
          type: string
        notes:
          description: Notes on the application
          title: Notes
          type: string
        number_of_missing_references:
          description: The number of references missing on the application
          format: float
          title: Number Of Missing References
          type: number
        order_id:
          description: The order that last touched this application
          title: Order
          type: string
        order_line_item_id:
          description: The order line item touched this application
          title: Order Line Item
          type: string
        organization_id:
          description: The organization for this application
          title: Organization
          type: string
        override_bucket_assignment:
          description: >-
            If set, the bucket is not calculated automatically, and instead
            manually assigned
          title: Override Bucket Assignment
          type: boolean
        owner_type:
          description: Contact or an organization
          enum:
            - contact
            - organization
          title: Owner Type
          type: string
        pending_console_review:
          description: >-
            If true, then this record has been reviewed and now needs action by
            the staff
          title: Pending Console Review
          type: boolean
        process_id:
          description: The id of the application process
          title: Process
          type: string
        recipient_categories:
          items:
            additionalProperties: false
            properties:
              category_id:
                description: The award category
                title: Category
                type: string
            type: object
          type: array
        references:
          items:
            additionalProperties: false
            properties:
              id:
                description: A unique identifier for the reference
                title: ID
                type: string
              reference_contact_info:
                additionalProperties: false
                description: Contact info for the reference
                properties: {}
                title: Reference Contact Info
                type: object
              reference_type_id:
                description: Type of reference
                title: Reference Type
                type: string
            type: object
          minItems: 1
          type: array
        review_status:
          description: The review status of this application
          enum:
            - accepted
            - alternate
            - declined
            - pending review
          title: Review Status
          type: string
        reviewer_recommendation:
          description: Aggregate recommendation across all reviewers
          title: Reviewer Recommendation
          type: string
        round_id:
          description: The review round
          title: Round
          type: string
        state:
          description: The state
          title: State
          type: string
        status:
          description: The status of the application
          enum:
            - approved
            - complete
            - declined
            - missing references
            - withdrawn
          title: Status
          type: string
        status_reason_id:
          description: The reason for the status
          title: Status Reason
          type: string
        submission_space_id:
          description: The submission space to which this object belongs
          title: Submission Space
          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
        total_score:
          description: The total score for this submission in the most recent round
          format: float
          title: Total Score
          type: number
      required:
        - award_id
        - award_type_id
        - bucket_id
        - contact_id
        - date
        - id
        - name
        - organization_id
        - owner_type
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ApplicationFee:
      additionalProperties: false
      properties:
        allow_customer_to_choose_installment_plan:
          description: If true, the customer can choose their installment plan
          title: Allow Customer To Choose Installment Plan
          type: boolean
        award_id:
          title: Award
          type: string
        bulk_pricing_rules:
          items:
            additionalProperties: false
            properties:
              discount_amount:
                description: The percentage/flat rate
                format: float
                minimum: 0
                title: Discount Amount
                type: number
              discount_type:
                description: The type of discount rule
                enum:
                  - flat rate
                  - percentage
                title: Discount Type
                type: string
              ending_range:
                description: The ending range of the rule
                minimum: 0
                title: Ending Range
                type: integer
              starting_range:
                description: The starting range of the rule
                minimum: 0
                title: Starting Range
                type: integer
            required:
              - discount_amount
              - discount_type
            type: object
          minItems: 1
          type: array
        bundled_products:
          items:
            additionalProperties: false
            properties:
              member_price:
                description: The member price
                format: double
                title: Member Price
                type: number
              price:
                description: The price to bundle
                format: double
                title: Price
                type: number
              product_id:
                description: The product ID
                title: Product
                type: string
              product_type:
                description: The product type
                title: Product Type
                type: string
              quantity:
                description: The quantity to bundle
                title: Quantity
                type: integer
              type:
                enum:
                  - bundled product
                  - inline bundled product
                title: Type
                type: string
            required:
              - product_id
              - product_type
              - quantity
              - type
            type: object
          minItems: 1
          type: array
        bundled_products_inventory_handling:
          description: >-
            Whether to track inventory for the entire bundle, or for each
            product separately
          enum:
            - bundle
            - each product
          title: Bundled Products Inventory Handling
          type: string
        business_unit_id:
          description: The business unit of the product
          title: Business Unit
          type: string
        cancellation_fee:
          description: Cancellation fees associated with this product
          format: double
          title: Cancellation Fee
          type: number
        commerce_entitlements_to_create:
          items:
            additionalProperties: false
            properties:
              expiration_date:
                format: date-time
                oneOf:
                  - x-required: true
                title: Expiration Date
                type: string
              expiration_type:
                enum:
                  - none
                  - relative date
                  - specific date
                title: Expiration Type
                type: string
              quantity:
                description: The quantity
                format: float
                title: Quantity
                type: number
              relative_expiration_date:
                additionalProperties: false
                description: The date the task is due
                oneOf:
                  - x-required: true
                properties:
                  number:
                    description: The unit of time
                    format: float
                    minimum: 0
                    oneOf:
                      - {}
                    title: Number
                    type: number
                  position:
                    description: How the unit relates to the reference date
                    enum:
                      - after
                      - before
                      - 'on'
                    title: Position
                    type: string
                  relative_to:
                    enum:
                      - the beginning of the month
                      - the beginning of the quarter
                      - the beginning of the week
                      - the beginning of the year
                      - the end of the month
                      - the end of the quarter
                      - the end of the week
                      - the end of the year
                      - the reference date
                    title: Relative To
                    type: string
                  unit_of_time:
                    enum:
                      - days
                      - months
                      - weeks
                      - years
                    oneOf:
                      - {}
                    title: Unit Of Time
                    type: string
                required:
                  - number
                  - position
                  - relative_to
                  - unit_of_time
                title: Relative Expiration Date
                type: object
              type_id:
                description: The type of entitlement
                title: Type
                type: string
            required:
              - expiration_type
              - type_id
            type: object
          type: array
        coupon_codes:
          items:
            additionalProperties: false
            properties:
              coupon_code_generation_process_id:
                description: The process by which the coupons are generated
                title: Coupon Code Generation Process
                type: string
              coupon_code_type:
                enum:
                  - multi use
                  - single use
                title: Coupon Code Type
                type: string
              coupon_id:
                title: Coupon
                type: string
              coupon_type:
                title: Coupon Type
                type: string
              expiration_date:
                format: date-time
                oneOf:
                  - x-required: true
                title: Expiration Date
                type: string
              expiration_type:
                enum:
                  - none
                  - relative date
                  - specific date
                title: Expiration Type
                type: string
              maximum_number_of_total_uses:
                description: The maximum number of total uses
                minimum: 1
                oneOf:
                  - enum:
                      - 1
                    x-required: true
                title: Maximum Number Of Total Uses
                type: integer
              maximum_number_of_uses_per_customer:
                description: The maximum number of total uses for a given customer
                minimum: 1
                oneOf:
                  - enum:
                      - 1
                    x-required: true
                title: Maximum Number Of Uses Per Customer
                type: integer
              quantity:
                description: The number of coupons to generate
                maximum: 250
                title: Quantity
                type: integer
              relative_expiration_date:
                additionalProperties: false
                description: Expiration date relative to purchase
                oneOf:
                  - x-required: true
                properties:
                  number:
                    description: The unit of time
                    format: float
                    minimum: 0
                    oneOf:
                      - {}
                    title: Number
                    type: number
                  position:
                    description: How the unit relates to the reference date
                    enum:
                      - after
                      - before
                      - 'on'
                    title: Position
                    type: string
                  relative_to:
                    enum:
                      - the beginning of the month
                      - the beginning of the quarter
                      - the beginning of the week
                      - the beginning of the year
                      - the end of the month
                      - the end of the quarter
                      - the end of the week
                      - the end of the year
                      - the reference date
                    title: Relative To
                    type: string
                  unit_of_time:
                    enum:
                      - days
                      - months
                      - weeks
                      - years
                    oneOf:
                      - {}
                    title: Unit Of Time
                    type: string
                required:
                  - number
                  - position
                  - relative_to
                  - unit_of_time
                title: Relative Expiration Date
                type: object
              restrict_to_contact:
                description: >-
                  If true, the code generated is restricted to the contact who
                  made the purchase
                title: Restrict To Contact
                type: boolean
              restrict_to_organization:
                description: >-
                  If true, the code generated is restricted to the organization
                  made the purchase
                title: Restrict To Organization
                type: boolean
            required:
              - coupon_code_generation_process_id
              - coupon_code_type
              - coupon_id
              - coupon_type
              - quantity
            type: object
          minItems: 1
          type: array
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        custom_pricing_options:
          additionalProperties: false
          properties:
            lambda_function_id:
              description: The custom lambda function to use
              title: Lambda Function
              type: string
          required:
            - lambda_function_id
          title: Custom Pricing Options
          type: object
        document_entitlements_to_create:
          items:
            additionalProperties: false
            properties:
              expiration_date:
                format: date-time
                oneOf:
                  - x-required: true
                title: Expiration Date
                type: string
              expiration_type:
                enum:
                  - none
                  - relative date
                  - specific date
                title: Expiration Type
                type: string
              file_cabinet_id:
                description: The file cabinet
                title: File Cabinet
                type: string
              item_id:
                description: The item
                title: Item
                type: string
              library_path:
                description: >-
                  The optional path that items will be mounted onto the digital
                  library
                title: Library Path
                type: string
              relative_expiration_date:
                additionalProperties: false
                description: The date the task is due
                oneOf:
                  - x-required: true
                properties:
                  number:
                    description: The unit of time
                    format: float
                    minimum: 0
                    oneOf:
                      - {}
                    title: Number
                    type: number
                  position:
                    description: How the unit relates to the reference date
                    enum:
                      - after
                      - before
                      - 'on'
                    title: Position
                    type: string
                  relative_to:
                    enum:
                      - the beginning of the month
                      - the beginning of the quarter
                      - the beginning of the week
                      - the beginning of the year
                      - the end of the month
                      - the end of the quarter
                      - the end of the week
                      - the end of the year
                      - the reference date
                    title: Relative To
                    type: string
                  unit_of_time:
                    enum:
                      - days
                      - months
                      - weeks
                      - years
                    oneOf:
                      - {}
                    title: Unit Of Time
                    type: string
                required:
                  - number
                  - position
                  - relative_to
                  - unit_of_time
                title: Relative Expiration Date
                type: object
            required:
              - expiration_type
              - file_cabinet_id
            type: object
          type: array
        enable_bulk_pricing:
          description: Whether or not bulk pricing is enabled
          title: Enable Bulk Pricing
          type: boolean
        enable_bundled_products:
          description: Whether to enable bundled products
          title: Enable Bundled Products
          type: boolean
        enable_cancellation_fees:
          description: Whether or not cancellation fees are applicable
          title: Enable Cancellation Fees
          type: boolean
        enable_commerce_entitlement_creation:
          description: >-
            If set, document entitlements will be created to access folders or
            documents
          title: Enable Commerce Entitlement Creation
          type: boolean
        enable_coupon_code_generation:
          description: If true, purchasing this product will generate coupons
          title: Enable Coupon Code Generation
          type: boolean
        enable_custom_pricing:
          description: >-
            If set, the order engine will call out to a custom lambda function
            for custom/complex pricing
          title: Enable Custom Pricing
          type: boolean
        enable_document_entitlement_creation:
          description: >-
            If set, document entitlements will be created to access folders or
            documents
          title: Enable Document Entitlement Creation
          type: boolean
        enable_product_confirmation_email:
          description: If enabled, a custom email goes out whenever this product is ordered
          title: Enable Product Confirmation Email
          type: boolean
        enable_purchase_limits:
          description: If true, purchase limits are in place for this product
          title: Enable Purchase Limits
          type: boolean
        enable_purchasing_eligibility:
          description: If set, purchases of this merchandise are restricted
          title: Enable Purchasing Eligibility
          type: boolean
        enable_special_prices:
          description: Whether to enable special pricing logic
          title: Enable Special Prices
          type: boolean
        enable_task_generation:
          description: If set, tasks will be generated
          title: Enable Task Generation
          type: boolean
        foreign_currency_prices:
          items:
            additionalProperties: false
            properties:
              cancellation_fee:
                description: The cancellation fee of the product for this currency
                format: double
                title: Cancellation Fee
                type: number
              currency_code:
                enum:
                  - AED
                  - AFN
                  - ALL
                  - AMD
                  - ANG
                  - AOA
                  - ARS
                  - AUD
                  - AWG
                  - AZN
                  - BAM
                  - BBD
                  - BDT
                  - BGN
                  - BHD
                  - BIF
                  - BMD
                  - BND
                  - BOB
                  - BRL
                  - BSD
                  - BTN
                  - BWP
                  - BYR
                  - BZD
                  - CAD
                  - CDF
                  - CHF
                  - CLP
                  - CNY
                  - COP
                  - CRC
                  - CUC
                  - CVE
                  - CZK
                  - DJF
                  - DKK
                  - DOP
                  - DZD
                  - EEK
                  - EGP
                  - ERN
                  - ETB
                  - EUR
                  - FJD
                  - FKP
                  - GBP
                  - GEL
                  - GHS
                  - GIP
                  - GMD
                  - GNF
                  - GQE
                  - GTQ
                  - GYD
                  - HKD
                  - HNL
                  - HRK
                  - HTG
                  - HUF
                  - IDR
                  - ILS
                  - INR
                  - IQD
                  - IRR
                  - ISK
                  - JMD
                  - JOD
                  - JPY
                  - KES
                  - KGS
                  - KHR
                  - KMF
                  - KPW
                  - KRW
                  - KWD
                  - KYD
                  - KZT
                  - LAK
                  - LBP
                  - LKR
                  - LRD
                  - LSL
                  - LTL
                  - LVL
                  - LYD
                  - MAD
                  - MDL
                  - MGA
                  - MKD
                  - MMK
                  - MNT
                  - MOP
                  - MRO
                  - MUR
                  - MVR
                  - MWK
                  - MXN
                  - MYR
                  - MZM
                  - NAD
                  - NGN
                  - NIO
                  - NOK
                  - NPR
                  - NZD
                  - OMR
                  - PAB
                  - PEN
                  - PGK
                  - PHP
                  - PKR
                  - PLN
                  - PYG
                  - QAR
                  - RON
                  - RSD
                  - RUB
                  - SAR
                  - SBD
                  - SCR
                  - SDG
                  - SEK
                  - SGD
                  - SHP
                  - SLL
                  - SOS
                  - SRD
                  - SYP
                  - SZL
                  - THB
                  - TJS
                  - TMT
                  - TND
                  - TRY
                  - TTD
                  - TWD
                  - TZS
                  - UAH
                  - UGX
                  - USD
                  - UYU
                  - UZS
                  - VEB
                  - VND
                  - VUV
                  - WST
                  - XAF
                  - XCD
                  - XDR
                  - XOF
                  - XPF
                  - YER
                  - ZAR
                  - ZMK
                  - ZWR
                title: Currency Code
                type: string
              member_price:
                description: The price of the product for a member
                format: double
                title: Member Price
                type: number
              mode:
                description: How this foreign currency should be treated
                enum:
                  - calculate price
                  - prohibit purchase
                  - set price
                title: Mode
                type: string
              price:
                description: The price of the product
                format: double
                oneOf:
                  - x-required: true
                title: Price
                type: number
              restocking_fee:
                description: The restocking fee of the product for this currency
                format: double
                title: Restocking Fee
                type: number
            required:
              - currency_code
            type: object
          type: array
        hide_from_portal:
          description: If set, this product should not be shown in the portal
          title: Hide From Portal
          type: boolean
        id:
          description: The unique, string identifier of this miscellaneous product
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        installment_plan_options:
          items:
            additionalProperties: false
            properties:
              additional_cost:
                description: The additional cost of the installment plan
                format: double
                title: Additional Cost
                type: number
              installment_plan_id:
                description: The installment plan that this product supports
                title: Installment Plan
                type: string
              is_default:
                description: Whether this is the default installment plan option
                title: Is Default
                type: boolean
            required:
              - installment_plan_id
            type: object
          minItems: 1
          type: array
        is_active:
          description: Whether this product is active/used
          title: Is Active
          type: boolean
        member_price:
          description: The price of the product for an active member
          format: double
          title: Member Price
          type: number
        name:
          description: The name of the miscellaneous product
          title: Name
          type: string
        notes:
          description: Notes
          title: Notes
          type: string
        portal_options:
          additionalProperties: false
          properties:
            available_from:
              description: The date from which this product should be available
              format: date-time
              title: Available From
              type: string
            available_until:
              description: The date until which this product should be available
              format: date-time
              title: Available Until
              type: string
          title: Portal Options
          type: object
        price:
          description: The price of the product
          format: double
          title: Price
          type: number
        product_confirmation_email_options:
          additionalProperties: false
          properties:
            product_confirmation_email_id:
              oneOf:
                - x-required: true
              title: Product Confirmation Email
              type: string
            product_specific_email:
              additionalProperties: false
              oneOf:
                - x-required: true
              properties:
                bcc:
                  description: Anyone that should be bcc'ed on the email
                  title: Bcc
                  type: string
                body:
                  description: The email body
                  title: Body
                  type: string
                cc:
                  description: Anyone that should be cc'ed on the email
                  title: Cc
                  type: string
                from:
                  description: From email address
                  title: From
                  type: string
                from_name:
                  description: From name
                  title: From Name
                  type: string
                reply_to:
                  description: The reply to
                  title: Reply To
                  type: string
                subject:
                  description: The email subject
                  title: Subject
                  type: string
              required:
                - body
                - subject
              title: Product Specific Email
              type: object
            type:
              enum:
                - product specific
                - shared
              title: Type
              type: string
          title: Product Confirmation Email Options
          type: object
        publish_to_portal:
          description: Whether or not this product should be available in the portal
          title: Publish To Portal
          type: boolean
        purchase_limits:
          additionalProperties: false
          properties:
            error_message:
              description: The error message to show
              title: Error Message
              type: string
            maximum:
              description: The maximum
              format: float
              title: Maximum
              type: number
            relative_time_window:
              additionalProperties: false
              description: the time window
              oneOf:
                - x-required: true
              properties:
                number:
                  description: The unit of time
                  format: float
                  minimum: 0
                  oneOf:
                    - {}
                  title: Number
                  type: number
                position:
                  description: How the unit relates to the reference date
                  enum:
                    - after
                    - before
                    - 'on'
                  title: Position
                  type: string
                relative_to:
                  enum:
                    - the beginning of the month
                    - the beginning of the quarter
                    - the beginning of the week
                    - the beginning of the year
                    - the end of the month
                    - the end of the quarter
                    - the end of the week
                    - the end of the year
                    - the reference date
                  title: Relative To
                  type: string
                unit_of_time:
                  enum:
                    - days
                    - months
                    - weeks
                    - years
                  oneOf:
                    - {}
                  title: Unit Of Time
                  type: string
              required:
                - number
                - position
                - relative_to
                - unit_of_time
              title: Relative Time Window
              type: object
            time_period:
              enum:
                - all time
                - sliding time window
              title: Time Period
              type: string
            type:
              enum:
                - per customer
              title: Type
              type: string
          required:
            - maximum
            - time_period
            - type
          title: Purchase Limits
          type: object
        purchasing_eligibility_criteria:
          title: Purchasing Eligibility Criteria
          type: object
        special_prices:
          items:
            additionalProperties: false
            properties:
              criteria:
                title: Criteria
                type: object
              enable_formula:
                description: >-
                  if set, a formula is used to calculate the price. If the
                  formula fails, the price is used
                title: Enable Formula
                type: boolean
              formula:
                description: The formula evaluated using the expr-eval npm package
                oneOf:
                  - x-required: true
                title: Formula
                type: string
              name:
                title: Name
                type: string
              price:
                format: float
                title: Price
                type: number
            required:
              - criteria
              - price
            type: object
          minItems: 1
          type: array
        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
        tasks_to_generate:
          items:
            additionalProperties: false
            properties:
              assignee_type:
                enum:
                  - assignment role
                  - queue
                  - user
                title: Assignee Type
                type: string
              assignment_role_id:
                description: The assignment role that should receive the ask
                oneOf:
                  - x-required: true
                title: Assignment Role
                type: string
              description:
                description: A description
                title: Description
                type: string
              due_date_type:
                description: Whether there is a due date
                enum:
                  - none
                  - relative date
                  - specific date
                title: Due Date Type
                type: string
              name:
                description: The name of the task
                title: Name
                type: string
              notify_assignees:
                description: Notify assignee when the task is created
                title: Notify Assignees
                type: boolean
              priority:
                enum:
                  - high
                  - low
                  - normal
                  - urgent
                title: Priority
                type: string
              queue_id:
                description: The queue that should be assigned the ask
                oneOf:
                  - x-required: true
                title: Queue
                type: string
              relative_due_date:
                additionalProperties: false
                description: The date the task is due
                oneOf:
                  - x-required: true
                properties:
                  number:
                    description: The unit of time
                    format: float
                    minimum: 0
                    oneOf:
                      - {}
                    title: Number
                    type: number
                  position:
                    description: How the unit relates to the reference date
                    enum:
                      - after
                      - before
                      - 'on'
                    title: Position
                    type: string
                  relative_to:
                    enum:
                      - the beginning of the month
                      - the beginning of the quarter
                      - the beginning of the week
                      - the beginning of the year
                      - the end of the month
                      - the end of the quarter
                      - the end of the week
                      - the end of the year
                      - the reference date
                    title: Relative To
                    type: string
                  unit_of_time:
                    enum:
                      - days
                      - months
                      - weeks
                      - years
                    oneOf:
                      - {}
                    title: Unit Of Time
                    type: string
                required:
                  - number
                  - position
                  - relative_to
                  - unit_of_time
                title: Relative Due Date
                type: object
              specific_due_date:
                format: date-time
                oneOf:
                  - x-required: true
                title: Specific Due Date
                type: string
              type_id:
                description: The type of task
                title: Type
                type: string
              user_id:
                description: The user that should be assigned the ask
                oneOf:
                  - x-required: true
                title: User
                type: string
            required:
              - assignee_type
              - due_date_type
              - name
              - type_id
            type: object
          type: array
        type:
          description: The product type
          enum:
            - awards-application-fees
          title: Type
          type: string
      required:
        - bulk_pricing_rules
        - bundled_products
        - business_unit_id
        - coupon_codes
        - custom_pricing_options
        - id
        - installment_plan_options
        - name
        - price
        - product_confirmation_email_options
        - purchase_limits
        - special_prices
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ApplicationProcess:
      additionalProperties: false
      properties:
        allow_applicants_to_update_information:
          description: If true, applicants can modify their applications in the portal
          title: Allow Applicants To Update Information
          type: boolean
        application_form_id:
          description: The application form
          pattern: awards-applications__.*
          title: Application Form
          type: string
        application_update_options:
          additionalProperties: false
          properties:
            edit_application_form_id:
              description: Id of the modification webform
              pattern: ^awards-applications__.*
              title: Edit Application Form
              type: string
            modification_deadline_date:
              description: The date of the deadline for modifying the application
              title: Modification Deadline Date
              type: string
          required:
            - edit_application_form_id
            - modification_deadline_date
          title: Application Update Options
          type: object
        available_from:
          description: The date to start showing the process in the portal
          format: date-time
          title: Available From
          type: string
        available_until:
          description: The date to stop showing the process in the portal
          format: date-time
          title: Available Until
          type: string
        award_id:
          description: The id of the award
          title: Award
          type: string
        category_ids:
          description: The categories to which the process is restricted
          items:
            type: string
          minItems: 1
          title: Categories
          type: array
        checkout_settings:
          additionalProperties: false
          properties:
            allow_customer_to_choose_installment_plan:
              description: If true, the customer can choose their installment plan
              title: Allow Customer To Choose Installment Plan
              type: boolean
            bank_account_id:
              description: >-
                The default bank account that the store should use to receive
                payments
              title: Bank Account
              type: string
            bill_my_organization_options:
              additionalProperties: false
              properties:
                billing_address:
                  enum:
                    - do not show
                    - optional
                    - required
                  title: Billing Address
                  type: string
                purchase_order_number:
                  enum:
                    - do not show
                    - optional
                    - required
                  title: Purchase Order Number
                  type: string
                reference_number:
                  description: 'The reference #'
                  title: Reference Number
                  type: string
              title: Bill My Organization Options
              type: object
            bill_my_parent_organization_options:
              additionalProperties: false
              properties:
                billing_address:
                  enum:
                    - do not show
                    - optional
                    - required
                  title: Billing Address
                  type: string
                purchase_order_number:
                  enum:
                    - do not show
                    - optional
                    - required
                  title: Purchase Order Number
                  type: string
                reference_number:
                  description: 'The reference #'
                  title: Reference Number
                  type: string
              title: Bill My Parent Organization Options
              type: object
            business_unit_id:
              description: The business unit of the store
              title: Business Unit
              type: string
            cancellation_fee_product_id:
              description: The ID of the product used for cancellation fees
              title: Cancellation Fee Product
              type: string
            checkout_donation_options:
              additionalProperties: false
              oneOf:
                - x-required: true
              properties:
                simple_checkout_donation_options:
                  additionalProperties: false
                  oneOf:
                    - x-required: true
                  properties:
                    allow_user_to_specify_custom_amount:
                      description: If set, the user can specify their own custom donation
                      title: Allow User To Specify Custom Amount
                      type: boolean
                    donation_ask_text:
                      description: The text shown to the user when making the donation
                      title: Donation Ask Text
                      type: string
                    donation_denominations:
                      items:
                        format: double
                        type: number
                      title: Donation Denominations
                      type: array
                    donation_information:
                      description: Additional information about the donation
                      title: Donation Information
                      type: string
                    donation_product_id:
                      description: The misc product that should be used
                      title: Donation Product
                      type: string
                    override_donation_denominations:
                      description: >-
                        If set, donation denominations are specified here and
                        the defaults are not used
                      title: Override Donation Denominations
                      type: boolean
                    suggested_donation:
                      description: A suggested donation
                      format: double
                      title: Suggested Donation
                      type: number
                  required:
                    - donation_product_id
                  title: Simple Checkout Donation Options
                  type: object
                type:
                  enum:
                    - simple
                  title: Type
                  type: string
              title: Checkout Donation Options
              type: object
            credit_card_minimum_range_end:
              description: If set, the maximum amount for which credit cards can be taken
              format: float
              title: Credit Card Minimum Range End
              type: number
            credit_card_minimum_range_start:
              description: If set, the minimum amount for which credit cards can be taken
              format: float
              title: Credit Card Minimum Range Start
              type: number
            credit_card_mode:
              description: Determines whether or not credit cards are accepted
              enum:
                - disabled
                - enabled
                - range
              title: Credit Card Mode
              type: string
            credit_card_processing_fee_mode:
              description: Determines how credit card processing fees should be handled
              enum:
                - charge
                - do not charge
                - prompt user
              title: Credit Card Processing Fee Mode
              type: string
            credit_card_processing_fee_options:
              additionalProperties: false
              oneOf:
                - x-required: true
              properties:
                fee_percentage:
                  description: 'The fee percentage to charge for credit card processing '
                  format: float
                  title: Fee Percentage
                  type: number
                maximum_fee:
                  description: >-
                    The maximum amount to charge. If the fee comes out to be
                    MORE than this, than this amount will be charged
                  format: float
                  title: Maximum Fee
                  type: number
                minimum_fee:
                  description: >-
                    The minimum amount to charge. If the fee comes out to be
                    less than this, than this amount will be charged
                  format: float
                  title: Minimum Fee
                  type: number
                product_id:
                  description: The misc product to use for the credit card processing
                  title: Product
                  type: string
                prompt_sub_text:
                  description: >-
                    Additional text that is shown to the user when asking if
                    they want to pay for credit card processing fees. If not set
                    a default will be used
                  title: Prompt Sub Text
                  type: string
                prompt_text:
                  description: >-
                    The checkbox text to show the user when asking if they want
                    to pay for credit card processing fees. If not set a default
                    will be used
                  title: Prompt Text
                  type: string
              required:
                - fee_percentage
                - product_id
              title: Credit Card Processing Fee Options
              type: object
            disable_electronic_payment_vaulting:
              description: >-
                If set, in the portal people are not allowed to save credit
                cards
              title: Disable Electronic Payment Vaulting
              type: boolean
            enable_bill_my_organization:
              description: If set, the user has the option to bill their organization
              title: Enable Bill My Organization
              type: boolean
            enable_bill_my_parent_organization:
              description: >-
                If set, the user has the option to bill their organization's
                parent organization
              title: Enable Bill My Parent Organization
              type: boolean
            enable_donations_at_checkout:
              description: >-
                If selected, users will be prompted to make a donation upon
                checking out
              title: Enable Donations At Checkout
              type: boolean
            enable_electronic_checks:
              description: If set, electronic checks are allowed
              title: Enable Electronic Checks
              type: boolean
            enable_pay_later:
              description: >-
                If set, pay later is enabled on this checkout regardless of
                product settings... if not, the product settings are observed
              title: Enable Pay Later
              type: boolean
            enable_payroll_deduction:
              description: If set, payroll deduction is allowed
              title: Enable Payroll Deduction
              type: boolean
            enable_split_payments:
              description: If set, users are allowed to split payments
              title: Enable Split Payments
              type: boolean
            installment_plan_options:
              items:
                additionalProperties: false
                properties:
                  additional_cost:
                    description: The additional cost of the installment plan
                    format: double
                    title: Additional Cost
                    type: number
                  installment_plan_id:
                    description: The installment plan that this product supports
                    title: Installment Plan
                    type: string
                  is_default:
                    description: Whether this is the default installment plan option
                    title: Is Default
                    type: boolean
                required:
                  - installment_plan_id
                type: object
              minItems: 1
              oneOf:
                - x-required: true
              type: array
            invoice_payment_terms_id:
              description: The payment terms for invoices; if left blank, default is used
              title: Invoice Payment Terms
              type: string
            invoice_template_id:
              description: The template to use for invoices created during this process
              title: Invoice Template
              type: string
            merchant_account_id:
              description: >-
                The merchant account that the store should use to receive
                payments
              title: Merchant Account
              type: string
            pay_later_options:
              additionalProperties: false
              properties:
                billing_address:
                  enum:
                    - do not show
                    - optional
                    - required
                  title: Billing Address
                  type: string
                purchase_order_number:
                  enum:
                    - do not show
                    - optional
                    - required
                  title: Purchase Order Number
                  type: string
                reference_number:
                  description: 'The reference #'
                  title: Reference Number
                  type: string
              title: Pay Later Options
              type: object
            restocking_fee_product_id:
              description: The ID of the product used for restocking fees
              title: Restocking Fee Product
              type: string
            special_instructions:
              description: Instructions shown to the user
              title: Special Instructions
              type: string
            use_pro_forma_invoices:
              description: Whether to use pro forma invoices when user elects to pay later
              title: Use Pro Forma Invoices
              type: boolean
          required:
            - bank_account_id
            - business_unit_id
            - merchant_account_id
          title: Checkout Settings
          type: object
        confirmation_email:
          additionalProperties: false
          description: The email to send
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Confirmation Email
          type: object
        contact_form_options:
          additionalProperties: false
          properties:
            contact_form_id:
              description: >-
                The default contact form to present to the user to verify the
                contact info before proceeding
              pattern: ^rolodex-contacts__.*
              title: Contact Form
              type: string
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
          required:
            - contact_form_id
          title: Contact Form Options
          type: object
        customer_type:
          description: The type of customer that can complete this process
          enum:
            - contact
            - organization
          title: Customer Type
          type: string
        display_in_portal:
          description: Whether or not to hide in the portal
          title: Display In Portal
          type: boolean
        display_in_portal_as:
          description: How to display this process in the portal
          title: Display In Portal As
          type: string
        display_order:
          description: The order to display
          format: float
          title: Display Order
          type: number
        eligibility_criteria:
          additionalProperties: false
          description: The criteria for eligibility
          properties: {}
          title: Eligibility Criteria
          type: object
        enable_confirmation_email:
          description: Should the process send out confirmation emails
          title: Enable Confirmation Email
          type: boolean
        enable_eligibility_criteria:
          description: Should allow eligibility criteria
          title: Enable Eligibility Criteria
          type: boolean
        enable_references:
          description: If true, the references are enabled on this process
          title: Enable References
          type: boolean
        fee_id:
          description: The id of the associated fee
          title: Fee
          type: string
        id:
          description: The unique, string identifier of this application process
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this process is active
          title: Is Active
          type: boolean
        name:
          description: The name of the application process
          title: Name
          type: string
        organization_form_options:
          additionalProperties: false
          properties:
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
            organization_form_id:
              description: >-
                The default organization form to present to the user to verify
                the organization info before proceeding
              pattern: ^rolodex-organizations__.*
              title: Organization Form
              type: string
          required:
            - organization_form_id
          title: Organization Form Options
          type: object
        override_checkout_settings:
          description: Whether or not to override POC settings
          title: Override Checkout Settings
          type: boolean
        reference_requirements:
          description: The reference requirements for this process
          items:
            additionalProperties: false
            properties:
              maximum:
                description: Maximum value
                format: float
                maximum: 10
                title: Maximum
                type: number
              minimum:
                description: Minimum value
                format: float
                minimum: 0
                title: Minimum
                type: number
              process_id:
                description: The reference process
                title: Process
                type: string
              type_id:
                description: The type of reference
                title: Type
                type: string
            required:
              - maximum
              - minimum
              - process_id
              - type_id
            type: object
          minItems: 1
          type: array
        requires_fee:
          description: >-
            If true, then this process requires a fee and is associated with an
            order
          title: Requires Fee
          type: boolean
        requires_nomination:
          description: >-
            If set, a contact/organization must be nominated before submitting
            an application for this process
          title: Requires Nomination
          type: boolean
        restrict_categories:
          description: Should processes be restricted to specific categories
          title: Restrict Categories
          type: boolean
        show_contact_form:
          description: Whether or not to show a contact form
          title: Show Contact Form
          type: boolean
        show_organization_form:
          description: Whether or not to show an organization form
          title: Show Organization Form
          type: boolean
        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:
        - application_form_id
        - application_update_options
        - award_id
        - category_ids
        - checkout_settings
        - confirmation_email
        - contact_form_options
        - customer_type
        - eligibility_criteria
        - fee_id
        - id
        - name
        - organization_form_options
        - reference_requirements
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ApplicationSearchParameters:
      additionalProperties: false
      properties:
        award_ids:
          description: IDs of the awards to search
          items:
            type: string
          title: Awards
          type: array
        category_ids:
          description: IDs of the award categories
          items:
            type: string
          title: Categories
          type: array
        city:
          description: City to search
          title: City
          type: string
        contact_ids:
          description: The contact ids of the applications
          items:
            type: string
          title: Contacts
          type: array
        date:
          description: Date
          title: Date
          type: string
        email_address:
          title: Email Address
          type: string
        first_name:
          title: First Name
          type: string
        ids:
          description: IDs to search
          items:
            type: string
          title: Ids
          type: array
        job_title:
          title: Job Title
          type: string
        last_name:
          title: Last Name
          type: string
        name:
          title: Name
          type: string
        nickname:
          title: Nickname
          type: string
        organization_id:
          items:
            type: string
          title: Organization
          type: array
        owner_type:
          title: Owner Type
          type: string
        state:
          description: The state
          title: State
          type: string
      type: object
    ApplicationSearchResults:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        category_id:
          description: The award category
          title: Category
          type: string
        city:
          description: City to search
          title: City
          type: string
        contact_id:
          description: The contact_id of the application
          title: Contact
          type: string
        country:
          description: The country
          title: Country
          type: string
        date:
          description: The date of award
          format: date-time
          title: Date
          type: string
        email_address:
          description: The email address
          title: Email Address
          type: string
        id:
          title: ID
          type: string
        name:
          description: The name
          title: Name
          type: string
        organization_id:
          description: The organization_id of the application
          title: Organization
          type: string
        state:
          description: The state
          title: State
          type: string
      type: object
    ApplicationStatusReason:
      additionalProperties: false
      properties:
        id:
          description: The unique, string identifier of this application status reason
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this application status reason is active
          title: Is Active
          type: boolean
        name:
          description: The name of the application status reason
          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
    Award:
      additionalProperties: false
      properties:
        allow_recipients_to_update_information:
          description: >-
            Should recipient be allowed to update the information on the
            application
          title: Allow Recipients To Update Information
          type: boolean
        application_options:
          additionalProperties: false
          properties:
            maximum_applications_per_applicant:
              description: Maximum number of applications a contact/organization can submit
              format: float
              minimum: 1
              title: Maximum Applications Per Applicant
              type: number
          title: Application Options
          type: object
        application_page_layout_id:
          description: The default page layout when showing an application
          pattern: awards-applications__.*
          title: Application Page Layout
          type: string
        certificate_mode:
          enum:
            - automatically generate
            - create manually
            - disabled
          title: Certificate Mode
          type: string
        certificate_template:
          title: Certificate Template
          type: string
        cloned_from_id:
          description: The event linked that occurred before this one, used for comparison
          title: Cloned From
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        date:
          description: The date that the award will be issued
          format: date-time
          title: Date
          type: string
        description:
          description: The description to be shown in the portal
          title: Description
          type: string
        enable_applications:
          description: Enable the applications for the awards
          title: Enable Applications
          type: boolean
        enable_nominations:
          description: Whether or not nominations are allowed
          title: Enable Nominations
          type: boolean
        enable_recipient_categories:
          description: >-
            If set, this award is given to recipients with different categories
            (i.e., Best Actress, Best Supporting Actor, etc)
          title: Enable Recipient Categories
          type: boolean
        enable_reviews:
          description: Enable reviews for the awards
          title: Enable Reviews
          type: boolean
        id:
          description: The unique, string identifier of this award
          pattern: ^[\w-|:]+$
          title: ID
          type: string
        name:
          description: The name of the award
          title: Name
          type: string
        nomination_page_layout_id:
          description: The default page layout when showing a nomination
          pattern: awards-nominations__.*
          title: Nomination Page Layout
          type: string
        nominee_page_layout_id:
          description: The default page layout when showing a nomination
          pattern: awards-nominees__.*
          title: Nominee Page Layout
          type: string
        previous_award_id:
          description: The event linked that occurred before this one, used for comparison
          title: Previous Award
          type: string
        recipient_page_layout_id:
          description: The default page layout when showing a recipient
          pattern: awards-recipients__.*
          title: Recipient Page Layout
          type: string
        recipient_update_options:
          additionalProperties: false
          properties:
            modification_deadline_date:
              description: The date of the deadline for modifying the application
              title: Modification Deadline Date
              type: string
            recipient_update_options_form_id:
              description: Id of the modification webform
              pattern: ^awards-applications__.*
              title: Recipient Update Options Form
              type: string
          title: Recipient Update Options
          type: object
        show_in_portal:
          description: Should show in the portal
          title: Show In Portal
          type: boolean
        show_in_portal_from:
          description: The date to start showing the process in the portal
          format: date-time
          title: Show In Portal From
          type: string
        show_in_portal_until:
          description: The date to stop showing the process in the portal
          format: date-time
          title: Show In Portal Until
          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
        type_id:
          description: The type of award
          title: Type
          type: string
      required:
        - certificate_template
        - id
        - name
        - recipient_update_options
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
        - type_id
      type: object
    AwardSearchParameters:
      additionalProperties: false
      properties:
        date:
          title: Date
          type: string
        ids:
          description: IDs to search
          items:
            type: string
          title: Ids
          type: array
        name:
          title: Name
          type: string
        type_id:
          items:
            type: string
          title: Type
          type: array
      type: object
    AwardSearchResults:
      additionalProperties: false
      properties:
        date:
          title: Date
          type: string
        id:
          title: ID
          type: string
        name:
          title: Name
          type: string
        type_id:
          title: Type
          type: string
      type: object
    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
    Category:
      properties:
        award_id:
          description: The id of the associated award
          title: Award
          type: string
        display_order:
          description: The order in which to display the categories
          format: float
          title: Display Order
          type: number
        id:
          description: The unique, string identifier of this category
          pattern: /^[\w-_:]+$/
          title: ID
          type: string
        name:
          description: The name of the category
          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_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_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:
        - award_id
        - id
        - name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    CloneAwardRequest:
      additionalProperties: false
      properties:
        date:
          title: Date
          type: string
        id:
          description: The ID of the new award
          pattern: ^[\w|-]+$
          title: ID
          type: string
        name:
          title: Name
          type: string
        source_award_id:
          description: The source award
          title: Source Award
          type: string
      required:
        - date
        - id
        - name
        - source_award_id
      type: object
    Coupon:
      additionalProperties: false
      properties:
        application_fee_discount_info:
          additionalProperties: false
          properties:
            amount:
              format: float
              title: Amount
              type: number
            method:
              enum:
                - amount
                - percentage
              title: Method
              type: string
          required:
            - amount
          title: Application Fee Discount Info
          type: object
        apply_to_application_fees:
          description: If checked, this coupon applies to award applications
          title: Apply To Application Fees
          type: boolean
        award_id:
          description: The award with which this coupon wis associated
          title: Award
          type: string
        award_ids:
          description: For global coupons, the awards this applies to
          items:
            type: string
          title: Awards
          type: array
        award_type_ids:
          description: For global coupons, the type of awards this applies to
          items:
            type: string
          title: Award Types
          type: array
        code_generation_html:
          description: Code generation HTML
          title: Code Generation Html
          type: string
        discount_method:
          enum:
            - discount line item
            - inline discount
          title: Discount Method
          type: string
        discount_product_id:
          title: Discount Product
          type: string
        id:
          description: The unique, string identifier of this coupon
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this coupon is active
          title: Is Active
          type: boolean
        maximum_discount:
          description: >-
            The optimal maximum discount that this coupon can yield,
            irrespective its configuration
          format: float
          title: Maximum Discount
          type: number
        name:
          description: The name of the coupon
          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:
        - application_fee_discount_info
        - discount_method
        - discount_product_id
        - id
        - name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      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
    ListApplicationFeesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/ApplicationFee'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListApplicationProcessesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/ApplicationProcess'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListApplicationsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Application'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListAwardsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Award'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListCategoriesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Category'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListCouponsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Coupon'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListNominationProcessesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/NominationProcess'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListNominationsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Nomination'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListNomineesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Nominee'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListRecipientCategoriesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/RecipientCategory'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListRecipientsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Recipient'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListReferenceProcessesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/ReferenceProcess'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListReferencesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Reference'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListReviewProcessesResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/ReviewProcess'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListReviewRoundsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/ReviewRound'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListReviewsResponse:
      properties:
        Count:
          type: integer
        Items:
          items:
            $ref: '#/components/schemas/Review'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    ListStandardQueryDefinitionsResponse:
      items:
        $ref: '#/components/schemas/StandardQueryDefinition'
      type: array
    Nomination:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        award_type_id:
          description: The type of the award
          title: Award Type
          type: string
        city:
          description: The member city
          title: City
          type: string
        contact_id:
          description: The contact that submitted the nomination
          title: Contact
          type: string
        country:
          description: The member country
          title: Country
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        date:
          description: The date of award
          title: Date
          type: string
        email_address:
          description: The member's email address
          title: Email Address
          type: string
        first_name:
          description: The member's first name
          title: First Name
          type: string
        id:
          description: The unique, string identifier of this nomination
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        job_title:
          description: The member job title
          title: Job Title
          type: string
        last_name:
          description: The member's last name
          title: Last Name
          type: string
        name:
          description: The member's name
          title: Name
          type: string
        nominee_id:
          description: The nominee record associated with this nomination
          title: Nominee
          type: string
        nominee_info:
          additionalProperties: false
          description: The contact info for the nominee
          properties: {}
          title: Nominee Info
          type: object
        nominee_type:
          description: The type of entity that is being nominated
          enum:
            - contact
            - organization
          title: Nominee Type
          type: string
        notes:
          description: Notes on the nomination
          title: Notes
          type: string
        organization_id:
          description: The id of the organization
          title: Organization
          type: string
        process_id:
          description: The id of the nomination process
          title: Process
          type: string
        recipient_categories:
          items:
            additionalProperties: false
            properties:
              category_id:
                description: The award category
                title: Category
                type: string
            type: object
          type: array
        state:
          description: The state
          title: State
          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:
        - award_id
        - award_type_id
        - contact_id
        - date
        - id
        - name
        - nominee_id
        - nominee_type
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    NominationProcess:
      additionalProperties: false
      properties:
        allow_self_nominations:
          description: Should be able to self nominate
          title: Allow Self Nominations
          type: boolean
        automatically_create_application_for_nominee:
          description: Automatically create an application for a nominee
          title: Automatically Create Application For Nominee
          type: boolean
        available_from:
          description: The date to start showing the process in the portal
          format: date-time
          title: Available From
          type: string
        available_until:
          description: The date to stop showing the process in the portal
          format: date-time
          title: Available Until
          type: string
        award_id:
          description: The id of the award
          title: Award
          type: string
        confirmation_email:
          additionalProperties: false
          description: The email to send
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Confirmation Email
          type: object
        contact_form_options:
          additionalProperties: false
          properties:
            contact_form_id:
              description: >-
                The default contact form to present to the user to verify the
                contact info before proceeding
              pattern: ^rolodex-contacts__.*
              title: Contact Form
              type: string
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
          required:
            - contact_form_id
          title: Contact Form Options
          type: object
        display_in_portal:
          description: Whether or not to hide in the portal
          title: Display In Portal
          type: boolean
        display_in_portal_as:
          description: How to display this process in the portal
          title: Display In Portal As
          type: string
        display_order:
          description: The order to display
          format: float
          title: Display Order
          type: number
        eligibility_criteria:
          additionalProperties: false
          description: The criteria for eligibility
          properties: {}
          title: Eligibility Criteria
          type: object
        enable_confirmation_email:
          description: Should the process send out confirmation emails
          title: Enable Confirmation Email
          type: boolean
        enable_eligibility_criteria:
          description: Should allow eligibility criteria
          title: Enable Eligibility Criteria
          type: boolean
        enable_nominee_notification_email:
          description: Should the process send out nominee notification emails
          title: Enable Nominee Notification Email
          type: boolean
        id:
          description: The unique, string identifier of this nomination process
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this process is active
          title: Is Active
          type: boolean
        name:
          description: The name of the nomination process
          title: Name
          type: string
        nomination_form_id:
          description: The registration form
          pattern: awards-nominations__.*
          title: Nomination Form
          type: string
        nominee_mode:
          description: Which mode the nomination process will allow
          enum:
            - both
            - manually enter nominee information
            - select existing nominee
          title: Nominee Mode
          type: string
        nominee_notification_email:
          additionalProperties: false
          description: The email notification to send to the nominee
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Nominee Notification Email
          type: object
        nominee_type:
          description: 'The type of nominee: contact, organization'
          enum:
            - contact
            - organization
          title: Nominee Type
          type: string
        organization_form_options:
          additionalProperties: false
          properties:
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
            organization_form_id:
              description: >-
                The default organization form to present to the user to verify
                the organization info before proceeding
              pattern: ^rolodex-organizations__.*
              title: Organization Form
              type: string
          required:
            - organization_form_id
          title: Organization Form Options
          type: object
        quick_add_contact_settings:
          additionalProperties: false
          description: >-
            Settings that define what fields to show when adding a contact-based
            nominee
          properties: {}
          title: Quick Add Contact Settings
          type: object
        send_notification_email_for_first_nomination_only:
          description: Should send email only for first nomination
          title: Send Notification Email For First Nomination Only
          type: boolean
        show_contact_form:
          description: Whether or not to show a contact form
          title: Show Contact Form
          type: boolean
        show_organization_form:
          description: Whether or not to show an organization form
          title: Show Organization Form
          type: boolean
        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:
        - award_id
        - confirmation_email
        - contact_form_options
        - eligibility_criteria
        - id
        - name
        - nomination_form_id
        - nominee_mode
        - nominee_notification_email
        - nominee_type
        - organization_form_options
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    NominationSearchParameters:
      additionalProperties: false
      properties:
        award_ids:
          description: IDs of the awards to search
          items:
            type: string
          title: Awards
          type: array
        category_ids:
          description: IDs of the award categories
          items:
            type: string
          title: Categories
          type: array
        city:
          description: City to search
          title: City
          type: string
        contact_ids:
          description: IDs of the contacts
          items:
            type: string
          title: Contacts
          type: array
        date:
          description: Date
          title: Date
          type: string
        email_address:
          title: Email Address
          type: string
        first_name:
          title: First Name
          type: string
        ids:
          description: IDs to search
          items:
            type: string
          title: Ids
          type: array
        job_title:
          title: Job Title
          type: string
        last_name:
          title: Last Name
          type: string
        name:
          title: Name
          type: string
        nickname:
          title: Nickname
          type: string
        organization_id:
          items:
            type: string
          title: Organization
          type: array
        state:
          description: The state
          title: State
          type: string
      type: object
    NominationSearchResults:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        category_id:
          description: The award category
          title: Category
          type: string
        city:
          description: City to search
          title: City
          type: string
        contact_id:
          description: The contact that nominated the nominee
          title: Contact
          type: string
        date:
          description: The date of award
          format: date-time
          title: Date
          type: string
        id:
          title: ID
          type: string
        name:
          description: The name
          title: Name
          type: string
        process_id:
          description: The id of the nomination process
          title: Process
          type: string
        state:
          description: The state
          title: State
          type: string
      type: object
    Nominee:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        award_type_id:
          description: The type of the award
          title: Award Type
          type: string
        city:
          description: The member city
          title: City
          type: string
        contact_id:
          description: The contact_id of the nominee
          title: Contact
          type: string
        country:
          description: The member country
          title: Country
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        email_address:
          description: The member's email address
          title: Email Address
          type: string
        first_name:
          description: The member's first name
          title: First Name
          type: string
        id:
          description: The unique, string identifier of this nominee
          pattern: ^[\w-|:]+$
          title: ID
          type: string
        job_title:
          description: The member job title
          title: Job Title
          type: string
        last_name:
          description: The member's last name
          title: Last Name
          type: string
        name:
          description: The member's name
          title: Name
          type: string
        nomination_date:
          description: The date of award
          format: date-time
          title: Nomination Date
          type: string
        notes:
          description: Notes on the nominee
          title: Notes
          type: string
        organization_id:
          description: The organization
          title: Organization
          type: string
        owner_type:
          description: 'The type of nominee: contact, organization'
          enum:
            - contact
            - organization
          title: Owner Type
          type: string
        recipient_categories:
          items:
            additionalProperties: false
            properties:
              category_id:
                description: The award category
                title: Category
                type: string
            type: object
          type: array
        state:
          description: The state
          title: State
          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:
        - award_id
        - award_type_id
        - contact_id
        - id
        - name
        - nomination_date
        - organization_id
        - owner_type
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    NomineeSearchParameters:
      additionalProperties: false
      properties:
        award_ids:
          description: IDs of the awards to search
          items:
            type: string
          title: Awards
          type: array
        category_ids:
          description: IDs of the award categories
          items:
            type: string
          title: Categories
          type: array
        city:
          description: City to search
          title: City
          type: string
        contact_ids:
          description: The contact ids of the nominees
          items:
            type: string
          title: Contacts
          type: array
        date:
          description: Date
          title: Date
          type: string
        email_address:
          title: Email Address
          type: string
        first_name:
          title: First Name
          type: string
        ids:
          description: IDs to search
          items:
            type: string
          title: Ids
          type: array
        job_title:
          title: Job Title
          type: string
        last_name:
          title: Last Name
          type: string
        name:
          title: Name
          type: string
        nickname:
          title: Nickname
          type: string
        organization_id:
          items:
            type: string
          title: Organization
          type: array
        state:
          description: The state
          title: State
          type: string
      type: object
    NomineeSearchResults:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        category_ids:
          description: The award category
          items:
            type: string
          title: Categories
          type: array
        city:
          description: City to search
          title: City
          type: string
        contact_id:
          description: The contact_id of the nominee
          title: Contact
          type: string
        country:
          description: The country
          title: Country
          type: string
        email_address:
          description: The email address
          title: Email Address
          type: string
        id:
          title: ID
          type: string
        name:
          description: The name
          title: Name
          type: string
        nomination_date:
          description: The date of award
          format: date-time
          title: Nomination Date
          type: string
        organization_id:
          description: The organization_id of the nominee
          title: Organization
          type: string
        state:
          description: The state
          title: State
          type: string
      type: object
    PagedApplicationSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/ApplicationSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PagedAwardSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/AwardSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PagedNominationSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/NominationSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PagedNomineeSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/NomineeSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PagedRecipientSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/RecipientSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PagedReferenceSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/ReferenceSearchResults'
          type: array
        LastEvaluatedKey:
          type: string
      type: object
    PagedReviewSearchResults:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/ReviewSearchResults'
          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:
          description: The updated value
          title: Value
          type: string
      required:
        - op
        - path
      type: object
    PreviewEmailRequest:
      additionalProperties: false
      properties:
        application_id:
          title: Application
          type: string
        destination_email_address:
          title: Destination Email Address
          type: string
        email_template:
          additionalProperties: false
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Email Template
          type: object
        nomination_id:
          title: Nomination
          type: string
        reference_id:
          title: Reference
          type: string
      required:
        - destination_email_address
        - reference_id
      type: object
    Recipient:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        award_type_id:
          description: The type of the award
          title: Award Type
          type: string
        category_id:
          description: The award category
          title: Category
          type: string
        city:
          description: The member city
          title: City
          type: string
        contact_id:
          description: The contact id of the award recipient
          title: Contact
          type: string
        country:
          description: The member country
          title: Country
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        date:
          description: The date of the recipient
          title: Date
          type: string
        email_address:
          description: The member's email address
          title: Email Address
          type: string
        first_name:
          description: The member's first name
          title: First Name
          type: string
        id:
          description: The unique, string identifier of this recipient
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        job_title:
          description: The member job title
          title: Job Title
          type: string
        last_name:
          description: The member's last name
          title: Last Name
          type: string
        name:
          description: The member's name
          title: Name
          type: string
        notes:
          description: Notes about the recipient
          title: Notes
          type: string
        organization_id:
          description: The organization id of the award recipient
          title: Organization
          type: string
        owner_type:
          description: The type of recipient
          enum:
            - contact
            - organization
          title: Owner Type
          type: string
        state:
          description: The state
          title: State
          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:
        - award_id
        - award_type_id
        - contact_id
        - date
        - id
        - name
        - organization_id
        - owner_type
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    RecipientCategory:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        display_order:
          description: The order in which to display the categories
          format: float
          title: Display Order
          type: number
        id:
          description: The unique, string identifier of this recipient category
          pattern: ^[\w-|:]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this is an active category
          title: Is Active
          type: boolean
        name:
          description: The name of the recipient category
          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:
        - award_id
        - id
        - name
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    RecipientSearchParameters:
      additionalProperties: false
      properties:
        award_ids:
          description: IDs of the awards to search
          items:
            type: string
          title: Awards
          type: array
        category_ids:
          description: IDs of the award categories
          items:
            type: string
          title: Categories
          type: array
        city:
          description: City to search
          title: City
          type: string
        contact_ids:
          description: The contact ids of the applications
          items:
            type: string
          title: Contacts
          type: array
        date:
          description: Date
          title: Date
          type: string
        email_address:
          title: Email Address
          type: string
        first_name:
          title: First Name
          type: string
        ids:
          description: IDs to search
          items:
            type: string
          title: Ids
          type: array
        job_title:
          title: Job Title
          type: string
        last_name:
          title: Last Name
          type: string
        name:
          title: Name
          type: string
        nickname:
          title: Nickname
          type: string
        organization_ids:
          items:
            type: string
          title: Organizations
          type: array
        owner_type:
          title: Owner Type
          type: string
        state:
          description: The state
          title: State
          type: string
      type: object
    RecipientSearchResults:
      additionalProperties: false
      properties:
        award_id:
          description: The id of the award
          title: Award
          type: string
        category_id:
          description: The award category
          title: Category
          type: string
        city:
          description: City to search
          title: City
          type: string
        contact_id:
          description: The contact_id of the application
          title: Contact
          type: string
        country:
          description: The country
          title: Country
          type: string
        date:
          description: The date of award
          format: date-time
          title: Date
          type: string
        email_address:
          description: The email address
          title: Email Address
          type: string
        id:
          title: ID
          type: string
        name:
          description: The name
          title: Name
          type: string
        organization_id:
          description: The organization_id of the application
          title: Organization
          type: string
        state:
          description: The state
          title: State
          type: string
      type: object
    Reference:
      additionalProperties: false
      properties:
        application_id:
          description: Id of the application on which this reference resides
          pattern: ^[\w:|-]+$
          title: Application
          type: string
        award_id:
          description: The id of the award
          title: Award
          type: string
        city:
          description: The member city
          title: City
          type: string
        completion_date:
          description: Date of reference completion
          format: date-time
          title: Completion Date
          type: string
        contact_id:
          description: The rolodex record for the reference
          title: Contact
          type: string
        country:
          description: The member country
          title: Country
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        email_address:
          description: The member's email address
          title: Email Address
          type: string
        first_name:
          description: The member's first name
          title: First Name
          type: string
        id:
          description: The unique, string identifier of this reference
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        job_title:
          description: The member job title
          title: Job Title
          type: string
        last_name:
          description: The member's last name
          title: Last Name
          type: string
        name:
          description: The member's name
          title: Name
          type: string
        notes:
          description: Notes about this references
          title: Notes
          type: string
        organization_id:
          description: The organization id of the contact, if applicable
          title: Organization
          type: string
        process_id:
          description: The id of the nomination process
          title: Process
          type: string
        state:
          description: The state
          title: State
          type: string
        status:
          enum:
            - completed
            - declined
            - pending
          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
        type_id:
          description: The type of reference
          title: Type
          type: string
      required:
        - application_id
        - award_id
        - completion_date
        - contact_id
        - id
        - name
        - process_id
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
        - type_id
      type: object
    ReferenceProcess:
      additionalProperties: false
      properties:
        application_notice_email:
          additionalProperties: false
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Application Notice Email
          type: object
        award_id:
          description: The id of the award
          title: Award
          type: string
        contact_form_options:
          additionalProperties: false
          properties:
            contact_form_id:
              description: >-
                The default contact form to present to the user to verify the
                contact info before proceeding
              pattern: ^rolodex-contacts__.*
              title: Contact Form
              type: string
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
          required:
            - contact_form_id
          title: Contact Form Options
          type: object
        display_in_portal:
          description: Whether or not to hide in the portal
          title: Display In Portal
          type: boolean
        display_in_portal_as:
          description: How to display this process in the portal
          title: Display In Portal As
          type: string
        enable_application_notice_email:
          description: >-
            If true, an email is sent to the applicant notifying them that their
            application still requires a reference
          title: Enable Application Notice Email
          type: boolean
        enable_reference_notification_email:
          description: >-
            If true, an email is sent to the reference once the application is
            processes
          title: Enable Reference Notification Email
          type: boolean
        id:
          description: The unique, string identifier of this reference
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this process is active
          title: Is Active
          type: boolean
        name:
          description: The name of the process
          title: Name
          type: string
        organization_form_options:
          additionalProperties: false
          properties:
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
            organization_form_id:
              description: >-
                The default organization form to present to the user to verify
                the organization info before proceeding
              pattern: ^rolodex-organizations__.*
              title: Organization Form
              type: string
          required:
            - organization_form_id
          title: Organization Form Options
          type: object
        reference_form_id:
          description: The form the reference should use
          pattern: ^awards-references__.*
          title: Reference Form
          type: string
        reference_notification_email:
          additionalProperties: false
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Reference Notification Email
          type: object
        show_contact_form:
          description: Whether or not to show a contact form
          title: Show Contact Form
          type: boolean
        show_organization_form:
          description: Whether or not to show an organization form
          title: Show Organization Form
          type: boolean
        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:
        - application_notice_email
        - award_id
        - contact_form_options
        - id
        - name
        - organization_form_options
        - reference_form_id
        - reference_notification_email
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ReferenceSearchParameters:
      additionalProperties: false
      properties:
        application_ids:
          description: IDs of award applications
          items:
            type: string
          title: Applications
          type: array
        award_ids:
          description: IDs of the awards to search
          items:
            type: string
          title: Awards
          type: array
        city:
          description: City to search
          title: City
          type: string
        contact_ids:
          description: The contact ids of the nominees
          items:
            type: string
          title: Contacts
          type: array
        date:
          description: Date
          title: Date
          type: string
        email_address:
          title: Email Address
          type: string
        first_name:
          title: First Name
          type: string
        ids:
          description: IDs to search
          items:
            type: string
          title: Ids
          type: array
        job_title:
          title: Job Title
          type: string
        last_name:
          title: Last Name
          type: string
        name:
          title: Name
          type: string
        nickname:
          title: Nickname
          type: string
        organization_id:
          items:
            type: string
          title: Organization
          type: array
        state:
          description: The state
          title: State
          type: string
      type: object
    ReferenceSearchResults:
      additionalProperties: false
      properties:
        application_id:
          description: The application id
          items:
            type: string
          title: Application
          type: array
        award_id:
          description: The id of the award
          title: Award
          type: string
        city:
          description: City to search
          title: City
          type: string
        completion_date:
          description: The date of application completion
          format: date-time
          title: Completion Date
          type: string
        contact_id:
          description: The contact_id of the nominee
          title: Contact
          type: string
        country:
          description: The country
          title: Country
          type: string
        email_address:
          description: The email address
          title: Email Address
          type: string
        id:
          title: ID
          type: string
        name:
          description: The name
          title: Name
          type: string
        organization_id:
          description: The organization_id of the nominee
          title: Organization
          type: string
        state:
          description: The state
          title: State
          type: string
        type_id:
          description: The type of award
          title: Type
          type: string
      type: object
    ReferenceType:
      additionalProperties: false
      properties:
        id:
          description: The unique, string identifier of this reference type
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this reference type is active
          title: Is Active
          type: boolean
        name:
          description: The name of the reference 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
    Review:
      additionalProperties: false
      properties:
        application_id:
          description: Abstract associated to this review
          title: Application
          type: string
        assignee:
          additionalProperties: false
          description: User who to which the review has been assigned
          properties:
            city:
              description: The member city
              title: City
              type: string
            committee_ids:
              items:
                type: string
              title: Committees
              type: array
            committee_membership_ids:
              items:
                type: string
              title: Committee Memberships
              type: array
            contact_id:
              title: Contact
              type: string
            country:
              description: The member country
              title: Country
              type: string
            email_address:
              description: The member's email address
              title: Email Address
              type: string
            first_name:
              description: The member's first name
              title: First Name
              type: string
            job_title:
              description: The member job title
              title: Job Title
              type: string
            last_name:
              description: The member's last name
              title: Last Name
              type: string
            name:
              description: The member's name
              title: Name
              type: string
            state:
              description: The state
              title: State
              type: string
          required:
            - contact_id
            - name
          title: Assignee
          type: object
        award_id:
          description: ID associating the review to the event
          title: Award
          type: string
        comments_to_staff:
          description: Comments displayed to the association staff
          title: Comments To Staff
          type: string
        comments_to_submitter:
          description: Comments displayed to abstract submitter
          title: Comments To Submitter
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        date:
          description: The date the review was generated
          format: date-time
          title: Date
          type: string
        display_in_portal:
          description: Should we display the process in the portal
          title: Display In Portal
          type: boolean
        id:
          description: The unique, string identifier of this award application reviews
          pattern: ^[\w-_:]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this abstract review is active
          title: Is Active
          type: boolean
        process_id:
          description: ID of review process
          title: Process
          type: string
        review_round_id:
          description: ID of review round
          title: Review Round
          type: string
        score:
          description: The score for this review
          title: Score
          type: string
        status:
          description: 'Status for this review: not started, draft, completed'
          enum:
            - completed
            - draft
            - not started
          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:
        - application_id
        - assignee
        - award_id
        - id
        - process_id
        - review_round_id
        - status
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ReviewProcess:
      additionalProperties: false
      properties:
        administrators:
          items:
            additionalProperties: false
            properties:
              committee_id:
                description: Rolodex Contact ID for an administrator for this review
                title: Committee
                type: string
              committee_position_ids:
                description: Array of position ids for the committee
                items:
                  type: string
                title: Committee Positions
                type: array
            required:
              - committee_id
            type: object
          type: array
        award_id:
          description: ID for the event associated with this process
          title: Award
          type: string
        contact_form_options:
          additionalProperties: false
          properties:
            contact_form_id:
              description: >-
                The default contact form to present to the user to verify the
                contact info before proceeding
              pattern: ^rolodex-contacts__.*
              title: Contact Form
              type: string
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
          required:
            - contact_form_id
          title: Contact Form Options
          type: object
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        display_in_portal:
          description: Whether or not to display in the portal
          title: Display In Portal
          type: boolean
        enable_review_assignment_email:
          description: >-
            Whether or not an email should be sent when the application is
            received
          title: Enable Review Assignment Email
          type: boolean
        enable_review_submission_confirmation_email:
          description: >-
            Whether or not an email should be sent when the application is
            received
          title: Enable Review Submission Confirmation Email
          type: boolean
        enable_reviews_administrators:
          description: Should have allow award administrators
          title: Enable Reviews Administrators
          type: boolean
        id:
          description: The unique, string identifier of this awards review process
          pattern: ^[\w-_:]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this award review process is active
          title: Is Active
          type: boolean
        name:
          description: The name of the award review process
          title: Name
          type: string
        organization_form_options:
          additionalProperties: false
          properties:
            html:
              description: Text to show on the top of the form
              title: Html
              type: string
            organization_form_id:
              description: >-
                The default organization form to present to the user to verify
                the organization info before proceeding
              pattern: ^rolodex-organizations__.*
              title: Organization Form
              type: string
          required:
            - organization_form_id
          title: Organization Form Options
          type: object
        review_assignment_email:
          additionalProperties: false
          description: The email to send when the application is received
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Review Assignment Email
          type: object
        review_submission_confirmation_email:
          additionalProperties: false
          description: The email to send when the application is received
          properties:
            bcc:
              description: Anyone that should be bcc'ed on the email
              title: Bcc
              type: string
            body:
              description: The email body
              title: Body
              type: string
            cc:
              description: Anyone that should be cc'ed on the email
              title: Cc
              type: string
            from:
              description: From email address
              title: From
              type: string
            from_name:
              description: From name
              title: From Name
              type: string
            reply_to:
              description: The reply to
              title: Reply To
              type: string
            subject:
              description: The email subject
              title: Subject
              type: string
          required:
            - body
            - subject
          title: Review Submission Confirmation Email
          type: object
        rounds:
          items:
            additionalProperties: false
            properties:
              round_id:
                description: ID of the round
                title: Round
                type: string
            required:
              - round_id
            type: object
          type: array
        show_contact_form:
          description: Whether or not to show a contact form
          title: Show Contact Form
          type: boolean
        show_organization_form:
          description: Whether or not to show an organization form
          title: Show Organization Form
          type: boolean
        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:
        - administrators
        - award_id
        - contact_form_options
        - id
        - name
        - organization_form_options
        - review_assignment_email
        - review_submission_confirmation_email
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ReviewRound:
      additionalProperties: false
      properties:
        award_id:
          description: Event associated with this review round
          title: Award
          type: string
        custom_field_values:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          title: Custom Field Values
          type: array
        date:
          description: The date the round was created
          format: date-time
          title: Date
          type: string
        display_order:
          description: Sequential number order for the rounds
          format: float
          title: Display Order
          type: number
        enable_blind_review:
          description: Flag to indicate of review should be blind
          title: Enable Blind Review
          type: boolean
        enable_review_assignment_rules:
          description: Flag for setting if assignment rules apply to round
          title: Enable Review Assignment Rules
          type: boolean
        id:
          description: The unique, string identifier of this award review round
          pattern: ^[\w-_:]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this award review round is active
          title: Is Active
          type: boolean
        name:
          description: The name of the award review round
          title: Name
          type: string
        process_id:
          description: The process associated with this round
          title: Process
          type: string
        review_assignment_rules:
          items:
            additionalProperties: false
            properties:
              display_order:
                description: The order in which the rules are to be matched
                format: float
                title: Display Order
                type: number
              matching_conditions:
                title: Matching Conditions
                type: object
              name:
                description: Description of the assignment rule
                title: Name
                type: string
              targets:
                items:
                  additionalProperties: false
                  properties:
                    committee_id:
                      description: The committee that will review the award
                      oneOf:
                        - x-required: true
                      title: Committee
                      type: string
                    committee_member_id:
                      description: The committee member that will review the award
                      oneOf:
                        - x-required: true
                      title: Committee Member
                      type: string
                    committee_position_id:
                      description: >-
                        The optional committee position; if excluded, all
                        members on the committee are assigned
                      title: Committee Position
                      type: string
                    contact_id:
                      description: The contact that will review the award
                      oneOf:
                        - x-required: true
                      title: Contact
                      type: string
                    type:
                      enum:
                        - committee
                        - committee member
                        - contact
                      title: Type
                      type: string
                  required:
                    - type
                  type: object
                type: array
            required:
              - matching_conditions
              - name
            type: object
          type: array
        review_form_id:
          description: Platform Webform for the Review Round
          title: Review Form
          type: string
        status:
          description: 'The status of the award review round: Open, Closed'
          enum:
            - closed
            - never opened
            - open
          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:
        - award_id
        - enable_review_assignment_rules
        - id
        - name
        - process_id
        - review_assignment_rules
        - review_form_id
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    ReviewSearchParameters:
      additionalProperties: false
      properties:
        application_id:
          title: Application
          type: string
        assignee:
          additionalProperties: false
          properties:
            city:
              description: The member city
              title: City
              type: string
            contact_id:
              title: Contact
              type: string
            country:
              description: The member country
              title: Country
              type: string
            email_address:
              description: The member's email address
              title: Email Address
              type: string
            first_name:
              description: The member's first name
              title: First Name
              type: string
            job_title:
              description: The member job title
              title: Job Title
              type: string
            last_name:
              description: The member's last name
              title: Last Name
              type: string
            name:
              description: The member's name
              title: Name
              type: string
            state:
              description: The state
              title: State
              type: string
          required:
            - name
          title: Assignee
          type: object
        award_id:
          title: Award
          type: string
        date:
          items:
            format: date-time
            type: string
          maxItems: 2
          minItems: 2
          title: Date
          type: array
        id:
          title: ID
          type: string
        status:
          title: Status
          type: string
      required:
        - assignee
        - award_id
      type: object
    ReviewSearchResults:
      additionalProperties: false
      properties:
        application_id:
          title: Application
          type: string
        assignee:
          additionalProperties: false
          properties:
            city:
              description: The member city
              title: City
              type: string
            contact_id:
              title: Contact
              type: string
            country:
              description: The member country
              title: Country
              type: string
            email_address:
              description: The member's email address
              title: Email Address
              type: string
            first_name:
              description: The member's first name
              title: First Name
              type: string
            job_title:
              description: The member job title
              title: Job Title
              type: string
            last_name:
              description: The member's last name
              title: Last Name
              type: string
            name:
              description: The member's name
              title: Name
              type: string
            state:
              description: The state
              title: State
              type: string
          required:
            - name
          title: Assignee
          type: object
        award_id:
          description: The award
          title: Award
          type: string
        date:
          items:
            format: date-time
            type: string
          maxItems: 2
          minItems: 2
          title: Date
          type: array
        id:
          description: The unique string identifier
          title: ID
          type: string
        status:
          title: Status
          type: string
      required:
        - award_id
      type: object
    Setting:
      additionalProperties: false
      properties:
        allow_customer_to_choose_installment_plan:
          description: If true, the customer can choose their installment plan
          title: Allow Customer To Choose Installment Plan
          type: boolean
        bank_account_id:
          description: >-
            The default bank account that the store should use to receive
            payments
          title: Bank Account
          type: string
        bill_my_organization_options:
          additionalProperties: false
          properties:
            billing_address:
              enum:
                - do not show
                - optional
                - required
              title: Billing Address
              type: string
            purchase_order_number:
              enum:
                - do not show
                - optional
                - required
              title: Purchase Order Number
              type: string
            reference_number:
              description: 'The reference #'
              title: Reference Number
              type: string
          title: Bill My Organization Options
          type: object
        bill_my_parent_organization_options:
          additionalProperties: false
          properties:
            billing_address:
              enum:
                - do not show
                - optional
                - required
              title: Billing Address
              type: string
            purchase_order_number:
              enum:
                - do not show
                - optional
                - required
              title: Purchase Order Number
              type: string
            reference_number:
              description: 'The reference #'
              title: Reference Number
              type: string
          title: Bill My Parent Organization Options
          type: object
        business_unit_id:
          description: The business unit of the store
          title: Business Unit
          type: string
        cancellation_fee_product_id:
          description: The ID of the product used for cancellation fees
          title: Cancellation Fee Product
          type: string
        checkout_donation_options:
          additionalProperties: false
          properties:
            simple_checkout_donation_options:
              additionalProperties: false
              oneOf:
                - x-required: true
              properties:
                allow_user_to_specify_custom_amount:
                  description: If set, the user can specify their own custom donation
                  title: Allow User To Specify Custom Amount
                  type: boolean
                donation_ask_text:
                  description: The text shown to the user when making the donation
                  title: Donation Ask Text
                  type: string
                donation_denominations:
                  items:
                    format: double
                    type: number
                  title: Donation Denominations
                  type: array
                donation_information:
                  description: Additional information about the donation
                  title: Donation Information
                  type: string
                donation_product_id:
                  description: The misc product that should be used
                  title: Donation Product
                  type: string
                override_donation_denominations:
                  description: >-
                    If set, donation denominations are specified here and the
                    defaults are not used
                  title: Override Donation Denominations
                  type: boolean
                suggested_donation:
                  description: A suggested donation
                  format: double
                  title: Suggested Donation
                  type: number
              required:
                - donation_product_id
              title: Simple Checkout Donation Options
              type: object
            type:
              enum:
                - simple
              title: Type
              type: string
          title: Checkout Donation Options
          type: object
        credit_card_minimum_range_end:
          description: If set, the maximum amount for which credit cards can be taken
          format: float
          title: Credit Card Minimum Range End
          type: number
        credit_card_minimum_range_start:
          description: If set, the minimum amount for which credit cards can be taken
          format: float
          title: Credit Card Minimum Range Start
          type: number
        credit_card_mode:
          description: Determines whether or not credit cards are accepted
          enum:
            - disabled
            - enabled
            - range
          title: Credit Card Mode
          type: string
        credit_card_processing_fee_mode:
          description: Determines how credit card processing fees should be handled
          enum:
            - charge
            - do not charge
            - prompt user
          title: Credit Card Processing Fee Mode
          type: string
        credit_card_processing_fee_options:
          additionalProperties: false
          properties:
            fee_percentage:
              description: 'The fee percentage to charge for credit card processing '
              format: float
              title: Fee Percentage
              type: number
            maximum_fee:
              description: >-
                The maximum amount to charge. If the fee comes out to be MORE
                than this, than this amount will be charged
              format: float
              title: Maximum Fee
              type: number
            minimum_fee:
              description: >-
                The minimum amount to charge. If the fee comes out to be less
                than this, than this amount will be charged
              format: float
              title: Minimum Fee
              type: number
            product_id:
              description: The misc product to use for the credit card processing
              title: Product
              type: string
            prompt_sub_text:
              description: >-
                Additional text that is shown to the user when asking if they
                want to pay for credit card processing fees. If not set a
                default will be used
              title: Prompt Sub Text
              type: string
            prompt_text:
              description: >-
                The checkbox text to show the user when asking if they want to
                pay for credit card processing fees. If not set a default will
                be used
              title: Prompt Text
              type: string
          required:
            - fee_percentage
            - product_id
          title: Credit Card Processing Fee Options
          type: object
        disable_electronic_payment_vaulting:
          description: If set, in the portal people are not allowed to save credit cards
          title: Disable Electronic Payment Vaulting
          type: boolean
        enable_bill_my_organization:
          description: If set, the user has the option to bill their organization
          title: Enable Bill My Organization
          type: boolean
        enable_bill_my_parent_organization:
          description: >-
            If set, the user has the option to bill their organization's parent
            organization
          title: Enable Bill My Parent Organization
          type: boolean
        enable_donations_at_checkout:
          description: >-
            If selected, users will be prompted to make a donation upon checking
            out
          title: Enable Donations At Checkout
          type: boolean
        enable_electronic_checks:
          description: If set, electronic checks are allowed
          title: Enable Electronic Checks
          type: boolean
        enable_pay_later:
          description: >-
            If set, pay later is enabled on this checkout regardless of product
            settings... if not, the product settings are observed
          title: Enable Pay Later
          type: boolean
        enable_payroll_deduction:
          description: If set, payroll deduction is allowed
          title: Enable Payroll Deduction
          type: boolean
        enable_split_payments:
          description: If set, users are allowed to split payments
          title: Enable Split Payments
          type: boolean
        installment_plan_options:
          items:
            additionalProperties: false
            properties:
              additional_cost:
                description: The additional cost of the installment plan
                format: double
                title: Additional Cost
                type: number
              installment_plan_id:
                description: The installment plan that this product supports
                title: Installment Plan
                type: string
              is_default:
                description: Whether this is the default installment plan option
                title: Is Default
                type: boolean
            required:
              - installment_plan_id
            type: object
          minItems: 1
          type: array
        invoice_payment_terms_id:
          description: The payment terms for invoices; if left blank, default is used
          title: Invoice Payment Terms
          type: string
        invoice_template_id:
          description: The template to use for invoices created during this process
          title: Invoice Template
          type: string
        merchant_account_id:
          description: The merchant account that the store should use to receive payments
          title: Merchant Account
          type: string
        notes:
          description: Notes on the settings
          title: Notes
          type: string
        pay_later_options:
          additionalProperties: false
          properties:
            billing_address:
              enum:
                - do not show
                - optional
                - required
              title: Billing Address
              type: string
            purchase_order_number:
              enum:
                - do not show
                - optional
                - required
              title: Purchase Order Number
              type: string
            reference_number:
              description: 'The reference #'
              title: Reference Number
              type: string
          title: Pay Later Options
          type: object
        restocking_fee_product_id:
          description: The ID of the product used for restocking fees
          title: Restocking Fee Product
          type: string
        special_instructions:
          description: Instructions shown to the user
          title: Special Instructions
          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
        use_pro_forma_invoices:
          description: Whether to use pro forma invoices when user elects to pay later
          title: Use Pro Forma Invoices
          type: boolean
      required:
        - bank_account_id
        - business_unit_id
        - checkout_donation_options
        - credit_card_processing_fee_options
        - installment_plan_options
        - merchant_account_id
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
      type: object
    StandardQueryDefinition:
      additionalProperties: false
      properties:
        category:
          title: Category
          type: string
        definition:
          additionalProperties: false
          properties: {}
          title: Definition
          type: object
        id:
          title: ID
          type: string
        name:
          title: Name
          type: string
      type: object
    Statistic:
      additionalProperties: false
      properties:
        dataSource:
          description: The datasource used to generate this value
          title: Datasource
          type: string
        error:
          description: If the cache encountered an error, this is it
          title: Error
          type: string
        id:
          description: The unique, string identifier of this statistic
          pattern: ^[\w-:%\/]+$
          title: ID
          type: string
        name:
          description: The name of the statistic
          title: Name
          type: string
        status:
          description: The description of the statistic
          enum:
            - error
            - processing
            - valid
          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
        value:
          description: The numeric value of the statistic
          format: float
          title: Value
          type: number
        value_difference_numeric:
          description: >-
            When a value & previous value is present, this is the numeric
            difference
          format: float
          title: Value Difference Numeric
          type: number
        value_difference_percentage:
          description: >-
            When a value & previous value is present, this is the percentage
            difference
          format: float
          title: Value Difference Percentage
          type: number
        value_for_previous_period:
          description: >-
            For statistics that can compare values from a previous period, this
            is the value
          format: float
          title: Value For Previous Period
          type: number
        values:
          description: If the stat hs values in a row form, this variable contains it
          items:
            additionalProperties: false
            properties: {}
            type: object
          type: array
      required:
        - id
        - name
        - status
        - sys_created_at
        - sys_created_by_id
        - sys_last_modified_at
        - sys_last_modified_by_id
        - value
      type: object
    Type:
      additionalProperties: false
      properties:
        display_order:
          description: Optional display order
          format: float
          title: Display Order
          type: number
        id:
          description: The unique, string identifier of this type
          pattern: ^[\w:|-]+$
          title: ID
          type: string
        is_active:
          description: Whether or not this type is active
          title: Is Active
          type: boolean
        name:
          description: The name of the 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: >-
    Service providing access to Awards (Awards & Nominations) resources and
    features
  title: Awards (Awards & Nominations)
  version: v1-2025-04-18
openapi: 3.0.0
paths:
  /applicationFees/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new application fee.
        If an ID is specified for the application fee, an error will be thrown.
      operationId: createApplicationFee
      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/ApplicationFee'
        description: The application fee that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationFee'
          description: The application fee 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 application fee 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 application fee 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 application fee 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 application fee record that does not already exist.
      tags:
        - Application Fees
  /applicationFees/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listFeesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListApplicationFeesResponse'
          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 award_id
      tags:
        - Application Fees
  /applicationFees/{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 application fee 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 application fee 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:
        - Application Fees
  /applicationFees/{tenantId}/{id}:
    delete:
      description: This method will delete a application fee with the specified ID.
      operationId: deleteApplicationFee
      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 application fee to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The application fee 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 application fee 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 application fee 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 application fee 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 application fee from the system by its ID.
      tags:
        - Application Fees
    get:
      description: >-
        This method will look up a application fee by the specified ID and
        return it back.
      operationId: getApplicationFee
      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 application fee 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/ApplicationFee'
          description: The application fee 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 application fee 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 application fee 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 application fee from the system by its ID.
      tags:
        - Application Fees
    patch:
      description: >-
        This method will patch an existing application fee with the specified
        ID, using the HTTP PATCH specification.
      operationId: patchApplicationFee
      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 application fee to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationFee'
          description: The application fee 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 application fee 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 application fee 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 application fee 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 application fee with the specified ID.
      tags:
        - Application Fees
    put:
      description: >-
        This method will update an existing application fee with the specified
        ID.
      operationId: updateApplicationFee
      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 application fee to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationFee'
        description: The updated application fee that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationFee'
          description: The application fee 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 application fee 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 application fee 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 application fee 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 application fee 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 application fee with the specified ID.
      tags:
        - Application Fees
  /applicationProcesses/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new application
        process. If an ID is specified for the application process, an error
        will be thrown.
      operationId: createApplicationProcess
      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/ApplicationProcess'
        description: The application process that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationProcess'
          description: The application process 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 application process 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 application process 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 application process 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 application process record that does not already exist.
      tags:
        - Application Processes
  /applicationProcesses/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listProcessesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListApplicationProcessesResponse'
          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 award_id
      tags:
        - Application Processes
  /applicationProcesses/{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 application process 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 application process 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:
        - Application Processes
  /applicationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{contactOrOrganizationId}:
    get:
      operationId: getEligibleProcesses
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed
          schema:
            type: string
        - in: path
          name: awardId
          required: true
          description: The award
          schema:
            type: string
        - in: path
          name: customerType
          required: true
          description: The contact or organization type
          schema:
            type: string
            enum:
              - contact
              - organization
        - in: path
          name: contactOrOrganizationId
          required: true
          description: The contact or organization id
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApplicationProcess'
                type: array
          description: Processes 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: 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: >-
            Request limit exceeded... please try your request again in a few
            seconds
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: An internal server error occured.
          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 processes a contact/org is eligible to use
      tags:
        - Application Processes
  /applicationProcesses/{tenantId}/{id}:
    delete:
      description: This method will delete a application process with the specified ID.
      operationId: deleteApplicationProcess
      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 application process to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The application process 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 application process 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 application process 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 application process 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 application process from the system by its ID.
      tags:
        - Application Processes
    get:
      description: >-
        This method will look up a application process by the specified ID and
        return it back.
      operationId: getApplicationProcess
      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 application process 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/ApplicationProcess'
          description: The application process 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 application process 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 application process 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 application process from the system by its ID.
      tags:
        - Application Processes
    patch:
      description: >-
        This method will patch an existing application process with the
        specified ID, using the HTTP PATCH specification.
      operationId: patchApplicationProcess
      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 application process to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationProcess'
          description: The application process 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 application process 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 application process 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 application process 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 application process with the specified ID.
      tags:
        - Application Processes
    put:
      description: >-
        This method will update an existing application process with the
        specified ID.
      operationId: updateApplicationProcess
      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 application process to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationProcess'
        description: The updated application process that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationProcess'
          description: The application process 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 application process 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 application process 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 application process 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 application process 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 application process with the specified ID.
      tags:
        - Application Processes
  /applicationStatusReasons/{tenantId}:
    get:
      description: >-
        This method will scan all application status reasons and and return them
        to the caller.
      operationId: listApplicationStatusReasons
      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/ApplicationStatusReason'
                type: array
          description: The application status reasonswere 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 application status reasons in the system.
      tags:
        - Application Status Reasons
    post:
      description: >-
        This method will auto-generate an ID and create a new application status
        reason. If an ID is specified for the application status reason, an
        error will be thrown.
      operationId: createApplicationStatusReason
      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/ApplicationStatusReason'
        description: The application status reason that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStatusReason'
          description: The application status reason 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 application status reason 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 application status reason 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 application status reason 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 application status reason record that does not already
        exist.
      tags:
        - Application Status Reasons
  /applicationStatusReasons/{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 application status reason 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 application status reason 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:
        - Application Status Reasons
  /applicationStatusReasons/{tenantId}/{id}:
    delete:
      description: >-
        This method will delete a application status reason with the specified
        ID.
      operationId: deleteApplicationStatusReason
      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 application status reason to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The application status reason 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 application status reason 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 application status reason 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 application status reason 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 application status reason from the system by its ID.
      tags:
        - Application Status Reasons
    get:
      description: >-
        This method will look up a application status reason by the specified ID
        and return it back.
      operationId: getApplicationStatusReason
      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 application status reason 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/ApplicationStatusReason'
          description: The application status reason 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 application status reason 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 application status reason 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 application status reason from the system by its ID.
      tags:
        - Application Status Reasons
    patch:
      description: >-
        This method will patch an existing application status reason with the
        specified ID, using the HTTP PATCH specification.
      operationId: patchApplicationStatusReason
      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 application status reason to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStatusReason'
          description: The application status reason 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 application status reason 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 application status reason 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 application status reason 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 application status reason with the specified ID.
      tags:
        - Application Status Reasons
    put:
      description: >-
        This method will update an existing application status reason with the
        specified ID.
      operationId: updateApplicationStatusReason
      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 application status reason to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationStatusReason'
        description: The updated application status reason that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStatusReason'
          description: The application status reason 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 application status reason 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 application status reason 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 application status reason 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 application status reason 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 application status reason with the specified ID.
      tags:
        - Application Status Reasons
  /applications/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new application. If an
        ID is specified for the application, an error will be thrown.
      operationId: createApplication
      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/Application'
        description: The application that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
          description: The application 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 application 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 application 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 application 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 application record that does not already exist.
      tags:
        - Applications
  /applications/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listApplicationsByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListApplicationsResponse'
          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 award_id
      tags:
        - Applications
  /applications/{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 application 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 application 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:
        - Applications
  /applications/{tenantId}/contact/{ownerType}/{contactOrOrgId}:
    get:
      description: Returns a list of records with the specified owner_type and id
      operationId: listApplicationsByOwnerTypeContactOrOrgId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: ownerType
          required: true
          description: The owner_type to use to for record lookup
          schema:
            type: string
        - in: path
          name: contactOrOrgId
          required: true
          description: The contact_id or organization_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/ListApplicationsResponse'
          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 owner_type and id
      tags:
        - Applications
  /applications/{tenantId}/generateOrder:
    post:
      description: >-
        This method will examine an awards application and generate an
        appropriate order
      operationId: generateOrder
      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/Application'
        description: The application to generate an order
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: Conflicts 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 search 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
        '429':
          description: Limit exceeded... unable to add order 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: Generates an order from an awards application
      tags:
        - Applications
  /applications/{tenantId}/previewEmail:
    post:
      description: Sends out a preview of the CRC notification email
      operationId: previewEmail
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PreviewEmailRequest'
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Sends out a preview of the CRC notification email
      tags:
        - Applications
  /applications/{tenantId}/process:
    post:
      description: Sends out a preview of the CRC notification email
      operationId: processApplication
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
        description: The domain_name to use to for record lookup
        required: true
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Sends out a preview of the CRC notification email
      tags:
        - Applications
  /applications/{tenantId}/search:
    post:
      description: Searches for applications using predefined parameters
      operationId: searchForApplications
      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/ApplicationSearchParameters'
        description: The application that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedApplicationSearchResults'
          description: The application 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 application 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 application 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 application 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 applications using predefined parameters
      tags:
        - Applications
  /applications/{tenantId}/{id}:
    delete:
      description: This method will delete a application with the specified ID.
      operationId: deleteApplication
      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 application to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The application 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 application 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 application 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 application 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 application from the system by its ID.
      tags:
        - Applications
    get:
      description: >-
        This method will look up a application by the specified ID and return it
        back.
      operationId: getApplication
      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 application 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/Application'
          description: The application 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 application 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 application 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 application from the system by its ID.
      tags:
        - Applications
    patch:
      description: >-
        This method will patch an existing application with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchApplication
      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 application to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
          description: The application 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 application 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 application 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 application 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 application with the specified ID.
      tags:
        - Applications
    put:
      description: This method will update an existing application with the specified ID.
      operationId: updateApplication
      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 application to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
        description: The updated application that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
          description: The application 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 application 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 application 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 application 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 application 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 application with the specified ID.
      tags:
        - Applications
  /awards/{tenantId}:
    get:
      description: This method will scan all awards and and return them to the caller.
      operationId: listAwards
      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/Award'
                type: array
          description: The awardswere 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 awards in the system.
      tags:
        - Awards
    post:
      description: >-
        This method will auto-generate an ID and create a new award. If an ID is
        specified for the award, an error will be thrown.
      operationId: createAward
      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/Award'
        description: The award that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
          description: The award 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 award 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 award 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 award 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 award record that does not already exist.
      tags:
        - Awards
  /awards/{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 award 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 award 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:
        - Awards
  /awards/{tenantId}/clone:
    post:
      description: Creates a copy of an award, along with other associated records
      operationId: cloneAward
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneAwardRequest'
              type: string
        description: The clone request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
          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: Creates a copy of an award, along with other associated records
      tags:
        - Awards
  /awards/{tenantId}/portal/browseOpen:
    get:
      description: Returns a list of open awards available/visible in the portal
      operationId: browseOpenAwardsForPortal
      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/ListAwardsResponse'
          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: Browse Open Awards for Portal
      tags:
        - Awards
  /awards/{tenantId}/search:
    post:
      description: Searches for awards using predefined parameters
      operationId: searchForAwards
      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/AwardSearchParameters'
        description: The award that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedAwardSearchResults'
          description: The award 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 award 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 award 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 award 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 awards using predefined parameters
      tags:
        - Awards
  /awards/{tenantId}/type/{type_id}:
    get:
      description: Returns a list of records with the specified type_id
      operationId: listAwardsByTypeId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: type_id
          required: true
          description: The type_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/ListAwardsResponse'
          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 type_id
      tags:
        - Awards
  /awards/{tenantId}/{id}:
    delete:
      description: This method will delete a award with the specified ID.
      operationId: deleteAward
      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 award to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The award 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 award 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 award 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 award 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 award from the system by its ID.
      tags:
        - Awards
    get:
      description: This method will look up a award by the specified ID and return it back.
      operationId: getAward
      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 award 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/Award'
          description: The award 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 award 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 award 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 award from the system by its ID.
      tags:
        - Awards
    patch:
      description: >-
        This method will patch an existing award with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchAward
      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 award to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
          description: The award 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 award 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 award 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 award 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 award with the specified ID.
      tags:
        - Awards
    put:
      description: This method will update an existing award with the specified ID.
      operationId: updateAward
      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 award to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Award'
        description: The updated award that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
          description: The award 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 award 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 award 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 award 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 award 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 award with the specified ID.
      tags:
        - Awards
  /categories/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new category. If an ID
        is specified for the category, an error will be thrown.
      operationId: createCategory
      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/Category'
        description: The category that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: The category 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 category 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 category 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 category 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 category record that does not already exist.
      tags:
        - Categories
  /categories/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listCategoriesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListCategoriesResponse'
          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 award_id
      tags:
        - Categories
  /categories/{tenantId}/{id}:
    delete:
      description: This method will delete a category with the specified ID.
      operationId: deleteCategory
      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 category to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The category 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 category 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 category 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 category 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 category from the system by its ID.
      tags:
        - Categories
    get:
      description: >-
        This method will look up a category by the specified ID and return it
        back.
      operationId: getCategory
      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 category 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/Category'
          description: The category 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 category 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 category 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 category from the system by its ID.
      tags:
        - Categories
    patch:
      description: >-
        This method will patch an existing category with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchCategory
      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 category to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: The category 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 category 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 category 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 category 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 category with the specified ID.
      tags:
        - Categories
    put:
      description: This method will update an existing category with the specified ID.
      operationId: updateCategory
      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 category to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Category'
        description: The updated category that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: The category 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 category 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 category 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 category 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 category 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 category with the specified ID.
      tags:
        - Categories
  /coupons/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new coupon. If an ID
        is specified for the coupon, an error will be thrown.
      operationId: createCoupon
      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/Coupon'
        description: The coupon that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupon'
          description: The coupon 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 coupon 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 coupon 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 coupon 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 coupon record that does not already exist.
      tags:
        - Coupons
  /coupons/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listCouponsByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListCouponsResponse'
          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 award_id
      tags:
        - Coupons
  /coupons/{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 coupon 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 coupon 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:
        - Coupons
  /coupons/{tenantId}/{id}:
    delete:
      description: This method will delete a coupon with the specified ID.
      operationId: deleteCoupon
      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 coupon to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The coupon 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 coupon 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 coupon 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 coupon 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 coupon from the system by its ID.
      tags:
        - Coupons
    get:
      description: >-
        This method will look up a coupon by the specified ID and return it
        back.
      operationId: getCoupon
      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 coupon 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/Coupon'
          description: The coupon 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 coupon 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 coupon 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 coupon from the system by its ID.
      tags:
        - Coupons
    patch:
      description: >-
        This method will patch an existing coupon with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchCoupon
      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 coupon to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupon'
          description: The coupon 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 coupon 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 coupon 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 coupon 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 coupon with the specified ID.
      tags:
        - Coupons
    put:
      description: This method will update an existing coupon with the specified ID.
      operationId: updateCoupon
      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 coupon to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Coupon'
        description: The updated coupon that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupon'
          description: The coupon 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 coupon 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 coupon 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 coupon 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 coupon 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 coupon with the specified ID.
      tags:
        - Coupons
  /nominationProcesses/{tenantId}:
    get:
      description: >-
        This method will scan all nomination processes and and return them to
        the caller.
      operationId: listNominationProcesses
      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/NominationProcess'
                type: array
          description: The nomination processeswere 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 nomination processes in the system.
      tags:
        - Nomination Processes
    post:
      description: >-
        This method will auto-generate an ID and create a new nomination
        process. If an ID is specified for the nomination process, an error will
        be thrown.
      operationId: createNominationProcess
      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/NominationProcess'
        description: The nomination process that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NominationProcess'
          description: The nomination process 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 process 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 nomination process 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 process 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 process record that does not already exist.
      tags:
        - Nomination Processes
  /nominationProcesses/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listProcessesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListNominationProcessesResponse'
          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 award_id
      tags:
        - Nomination Processes
  /nominationProcesses/{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 process 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 process 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:
        - Nomination Processes
  /nominationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{customer_id}:
    get:
      operationId: getEligibleProcesses
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed
          schema:
            type: string
        - in: path
          name: awardId
          required: true
          description: The award_id to use to for record lookup
          schema:
            type: string
        - in: path
          name: customerType
          required: true
          description: The customer type
          schema:
            type: string
        - in: path
          name: customer_id
          required: true
          description: The ID of the customer
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NominationProcess'
                type: array
          description: Processes 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: 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: >-
            Request limit exceeded... please try your request again in a few
            seconds
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: An internal server error occured.
          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 processes a contact/org is eligible to use
      tags:
        - Nomination Processes
  /nominationProcesses/{tenantId}/{id}:
    delete:
      description: This method will delete a nomination process with the specified ID.
      operationId: deleteNominationProcess
      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 process to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The nomination process 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 process 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 nomination process 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 process 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 process from the system by its ID.
      tags:
        - Nomination Processes
    get:
      description: >-
        This method will look up a nomination process by the specified ID and
        return it back.
      operationId: getNominationProcess
      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 process 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/NominationProcess'
          description: The nomination process 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 process 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 process 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 process from the system by its ID.
      tags:
        - Nomination Processes
    patch:
      description: >-
        This method will patch an existing nomination process with the specified
        ID, using the HTTP PATCH specification.
      operationId: patchNominationProcess
      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 process to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NominationProcess'
          description: The nomination process 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 process 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 nomination process 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 process 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 process with the specified ID.
      tags:
        - Nomination Processes
    put:
      description: >-
        This method will update an existing nomination process with the
        specified ID.
      operationId: updateNominationProcess
      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 process to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NominationProcess'
        description: The updated nomination process that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NominationProcess'
          description: The nomination process 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 process 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 process 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 nomination process 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 process 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 process with the specified ID.
      tags:
        - Nomination Processes
  /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}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listNominationsByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListNominationsResponse'
          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 award_id
      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}/contact/{contact_id}:
    get:
      description: Returns a list of records with the specified contact_id
      operationId: listNominationsByContactId
      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/ListNominationsResponse'
          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:
        - Nominations
  /nominations/{tenantId}/nominee/{nominee_id}:
    get:
      description: Returns a list of records with the specified nominee_id
      operationId: listNominationsByNomineeId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: nominee_id
          required: true
          description: The nominee_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/ListNominationsResponse'
          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 nominee_id
      tags:
        - Nominations
  /nominations/{tenantId}/organization/{organization_id}:
    get:
      description: Returns a list of records with the specified organization_id
      operationId: listNominationsByOrganizationId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: organization_id
          required: true
          description: The organization_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/ListNominationsResponse'
          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 organization_id
      tags:
        - Nominations
  /nominations/{tenantId}/previewEmail:
    post:
      description: Sends out a preview of the CRC notification email
      operationId: previewEmail
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PreviewEmailRequest'
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Sends out a preview of the CRC notification email
      tags:
        - Nominations
  /nominations/{tenantId}/search:
    post:
      description: Searches for nominations using predefined parameters
      operationId: searchForNominations
      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/NominationSearchParameters'
        description: The nomination that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedNominationSearchResults'
          description: The nomination 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 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: Searches for nominations using predefined parameters
      tags:
        - Nominations
  /nominations/{tenantId}/submit:
    post:
      operationId: submitNominations
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Nomination'
        description: Object definition of nomination
        required: true
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Submit a nomination
      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
  /nominees/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new nominee. If an ID
        is specified for the nominee, an error will be thrown.
      operationId: createNominee
      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/Nominee'
        description: The nominee that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nominee'
          description: The nominee 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 nominee 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 nominee 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 nominee 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 nominee record that does not already exist.
      tags:
        - Nominees
  /nominees/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listNomineesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListNomineesResponse'
          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 award_id
      tags:
        - Nominees
  /nominees/{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 nominee 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 nominee 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:
        - Nominees
  /nominees/{tenantId}/customer/{ownerType}/{contactOrOrganizationId}:
    get:
      description: Returns a list of records with the specified contact_id
      operationId: listNomineesByContactId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: ownerType
          required: true
          description: The type of authenticated user
          schema:
            type: string
        - in: path
          name: contactOrOrganizationId
          required: true
          description: The contact or organization 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/ListNomineesResponse'
          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:
        - Nominees
  /nominees/{tenantId}/search:
    post:
      description: Searches for nominees using predefined parameters
      operationId: searchForNominees
      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/NomineeSearchParameters'
        description: The nominee that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedNomineeSearchResults'
          description: The nominee 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 nominee 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 nominee 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 nominee 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 nominees using predefined parameters
      tags:
        - Nominees
  /nominees/{tenantId}/{id}:
    delete:
      description: This method will delete a nominee with the specified ID.
      operationId: deleteNominee
      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 nominee to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The nominee 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 nominee 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 nominee 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 nominee 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 nominee from the system by its ID.
      tags:
        - Nominees
    get:
      description: >-
        This method will look up a nominee by the specified ID and return it
        back.
      operationId: getNominee
      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 nominee 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/Nominee'
          description: The nominee 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 nominee 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 nominee 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 nominee from the system by its ID.
      tags:
        - Nominees
    patch:
      description: >-
        This method will patch an existing nominee with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchNominee
      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 nominee to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nominee'
          description: The nominee 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 nominee 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 nominee 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 nominee 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 nominee with the specified ID.
      tags:
        - Nominees
    put:
      description: This method will update an existing nominee with the specified ID.
      operationId: updateNominee
      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 nominee to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Nominee'
        description: The updated nominee that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Nominee'
          description: The nominee 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 nominee 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 nominee 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 nominee 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 nominee 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 nominee with the specified ID.
      tags:
        - Nominees
  /queryDefinitions/{tenantId}:
    get:
      description: Returns a list of records
      operationId: getQueryDefinitions
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStandardQueryDefinitionsResponse'
          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
      tags:
        - Query Definitions
  /recipientCategories/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new recipient
        category. If an ID is specified for the recipient category, an error
        will be thrown.
      operationId: createRecipientCategory
      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/RecipientCategory'
        description: The recipient category that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipientCategory'
          description: The recipient category 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 recipient category 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 recipient category 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 recipient category 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 recipient category record that does not already exist.
      tags:
        - Recipient Categories
  /recipientCategories/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listCategoriesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListRecipientCategoriesResponse'
          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 award_id
      tags:
        - Recipient Categories
  /recipientCategories/{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 recipient category 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 recipient category 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:
        - Recipient Categories
  /recipientCategories/{tenantId}/{id}:
    delete:
      description: This method will delete a recipient category with the specified ID.
      operationId: deleteRecipientCategory
      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 recipient category to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The recipient category 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 recipient category 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 recipient category 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 recipient category 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 recipient category from the system by its ID.
      tags:
        - Recipient Categories
    get:
      description: >-
        This method will look up a recipient category by the specified ID and
        return it back.
      operationId: getRecipientCategory
      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 recipient category 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/RecipientCategory'
          description: The recipient category 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 recipient category 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 recipient category 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 recipient category from the system by its ID.
      tags:
        - Recipient Categories
    patch:
      description: >-
        This method will patch an existing recipient category with the specified
        ID, using the HTTP PATCH specification.
      operationId: patchRecipientCategory
      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 recipient category to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipientCategory'
          description: The recipient category 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 recipient category 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 recipient category 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 recipient category 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 recipient category with the specified ID.
      tags:
        - Recipient Categories
    put:
      description: >-
        This method will update an existing recipient category with the
        specified ID.
      operationId: updateRecipientCategory
      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 recipient category to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipientCategory'
        description: The updated recipient category that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipientCategory'
          description: The recipient category 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 recipient category 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 recipient category 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 recipient category 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 recipient category 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 recipient category with the specified ID.
      tags:
        - Recipient Categories
  /recipients/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new recipient. If an
        ID is specified for the recipient, an error will be thrown.
      operationId: createRecipient
      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/Recipient'
        description: The recipient that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipient'
          description: The recipient 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 recipient 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 recipient 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 recipient 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 recipient record that does not already exist.
      tags:
        - Recipients
  /recipients/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listRecipientsByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListRecipientsResponse'
          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 award_id
      tags:
        - Recipients
  /recipients/{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 recipient 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 recipient 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:
        - Recipients
  /recipients/{tenantId}/ownerId/{ownerType}/{contactOrOrgId}:
    get:
      description: Returns a list of records with the specified owner_type
      operationId: listRecipientsByOwnerTypeContactOrOrgId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: ownerType
          required: true
          description: The owner_type to use to for record lookup
          schema:
            type: string
        - in: path
          name: contactOrOrgId
          required: true
          description: The id for the owner 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/ListRecipientsResponse'
          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 owner_type
      tags:
        - Recipients
  /recipients/{tenantId}/search:
    post:
      description: Searches for recipients using predefined parameters
      operationId: searchForRecipients
      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/RecipientSearchParameters'
        description: The recipient that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedRecipientSearchResults'
          description: The recipient 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 recipient 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 recipient 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 recipient 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 recipients using predefined parameters
      tags:
        - Recipients
  /recipients/{tenantId}/{id}:
    delete:
      description: This method will delete a recipient with the specified ID.
      operationId: deleteRecipient
      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 recipient to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The recipient 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 recipient 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 recipient 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 recipient 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 recipient from the system by its ID.
      tags:
        - Recipients
    get:
      description: >-
        This method will look up a recipient by the specified ID and return it
        back.
      operationId: getRecipient
      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 recipient 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/Recipient'
          description: The recipient 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 recipient 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 recipient 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 recipient from the system by its ID.
      tags:
        - Recipients
    patch:
      description: >-
        This method will patch an existing recipient with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchRecipient
      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 recipient to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipient'
          description: The recipient 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 recipient 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 recipient 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 recipient 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 recipient with the specified ID.
      tags:
        - Recipients
    put:
      description: This method will update an existing recipient with the specified ID.
      operationId: updateRecipient
      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 recipient to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Recipient'
        description: The updated recipient that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipient'
          description: The recipient 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 recipient 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 recipient 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 recipient 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 recipient 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 recipient with the specified ID.
      tags:
        - Recipients
  /referenceProcesses/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new reference process.
        If an ID is specified for the reference process, an error will be
        thrown.
      operationId: createReferenceProcess
      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/ReferenceProcess'
        description: The reference process that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceProcess'
          description: The reference process 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 reference process 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 reference process 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 reference process 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 reference process record that does not already exist.
      tags:
        - Reference Processes
  /referenceProcesses/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listProcessesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListReferenceProcessesResponse'
          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 award_id
      tags:
        - Reference Processes
  /referenceProcesses/{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 reference process 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 reference process 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:
        - Reference Processes
  /referenceProcesses/{tenantId}/{id}:
    delete:
      description: This method will delete a reference process with the specified ID.
      operationId: deleteReferenceProcess
      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 reference process to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The reference process 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 reference process 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 reference process 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 reference process 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 reference process from the system by its ID.
      tags:
        - Reference Processes
    get:
      description: >-
        This method will look up a reference process by the specified ID and
        return it back.
      operationId: getReferenceProcess
      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 reference process 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/ReferenceProcess'
          description: The reference process 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 reference process 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 reference process 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 reference process from the system by its ID.
      tags:
        - Reference Processes
    patch:
      description: >-
        This method will patch an existing reference process with the specified
        ID, using the HTTP PATCH specification.
      operationId: patchReferenceProcess
      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 reference process to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceProcess'
          description: The reference process 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 reference process 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 reference process 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 reference process 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 reference process with the specified ID.
      tags:
        - Reference Processes
    put:
      description: >-
        This method will update an existing reference process with the specified
        ID.
      operationId: updateReferenceProcess
      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 reference process to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferenceProcess'
        description: The updated reference process that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceProcess'
          description: The reference process 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 reference process 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 reference process 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 reference process 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 reference process 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 reference process with the specified ID.
      tags:
        - Reference Processes
  /referenceTypes/{tenantId}:
    get:
      description: >-
        This method will scan all reference types and and return them to the
        caller.
      operationId: listReferenceTypes
      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/ReferenceType'
                type: array
          description: The reference 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 reference types in the system.
      tags:
        - Reference Types
    post:
      description: >-
        This method will auto-generate an ID and create a new reference type. If
        an ID is specified for the reference type, an error will be thrown.
      operationId: createReferenceType
      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/ReferenceType'
        description: The reference type that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceType'
          description: The reference 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 reference 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 reference 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 reference 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 reference type record that does not already exist.
      tags:
        - Reference Types
  /referenceTypes/{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 reference 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 reference 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:
        - Reference Types
  /referenceTypes/{tenantId}/{id}:
    delete:
      description: This method will delete a reference type with the specified ID.
      operationId: deleteReferenceType
      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 reference type to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The reference 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 reference 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 reference 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 reference 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 reference type from the system by its ID.
      tags:
        - Reference Types
    get:
      description: >-
        This method will look up a reference type by the specified ID and return
        it back.
      operationId: getReferenceType
      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 reference 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/ReferenceType'
          description: The reference 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 reference 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 reference 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 reference type from the system by its ID.
      tags:
        - Reference Types
    patch:
      description: >-
        This method will patch an existing reference type with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchReferenceType
      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 reference type to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceType'
          description: The reference 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 reference 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 reference 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 reference 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 reference type with the specified ID.
      tags:
        - Reference Types
    put:
      description: >-
        This method will update an existing reference type with the specified
        ID.
      operationId: updateReferenceType
      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 reference type to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferenceType'
        description: The updated reference type that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceType'
          description: The reference 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 reference 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 reference 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 reference 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 reference 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 reference type with the specified ID.
      tags:
        - Reference Types
  /references/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new reference. If an
        ID is specified for the reference, an error will be thrown.
      operationId: createReference
      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/Reference'
        description: The reference that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reference'
          description: The reference 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 reference 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 reference 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 reference 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 reference record that does not already exist.
      tags:
        - References
  /references/{tenantId}/application/{application_id}:
    get:
      description: Returns a list of records with the specified reference_id
      operationId: listReferencesByApplicationId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: application_id
          required: true
          description: The application_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/ListReferencesResponse'
          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 reference_id
      tags:
        - References
  /references/{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 reference 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 reference 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:
        - References
  /references/{tenantId}/contact/{contact_id}:
    get:
      description: Returns a list of records with the specified contact_id
      operationId: listReferencesByContactId
      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/ListReferencesResponse'
          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:
        - References
  /references/{tenantId}/previewEmail:
    post:
      description: Sends out a preview of the CRC notification email
      operationId: previewEmail
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PreviewEmailRequest'
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Sends out a preview of the CRC notification email
      tags:
        - References
  /references/{tenantId}/process/{application_id}:
    post:
      description: Sends out a preview of the CRC notification email
      operationId: processReferences
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: application_id
          required: true
          description: The tenant
          schema:
            type: string
        - in: query
          name: reference_id
          required: false
          description: An optional reference ID that constraints processing
          schema:
            type: string
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Sends out a preview of the CRC notification email
      tags:
        - References
  /references/{tenantId}/search:
    post:
      description: Searches for references using predefined parameters
      operationId: searchForReferences
      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/ReferenceSearchParameters'
        description: The reference that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedReferenceSearchResults'
          description: The reference 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 reference 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 reference 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 reference 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 references using predefined parameters
      tags:
        - References
  /references/{tenantId}/submit:
    post:
      operationId: submitReference
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reference'
        description: Object definition of reference
        required: true
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Submit a reference
      tags:
        - References
  /references/{tenantId}/{id}:
    delete:
      description: This method will delete a reference with the specified ID.
      operationId: deleteReference
      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 reference to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The reference 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 reference 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 reference 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 reference 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 reference from the system by its ID.
      tags:
        - References
    get:
      description: >-
        This method will look up a reference by the specified ID and return it
        back.
      operationId: getReference
      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 reference 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/Reference'
          description: The reference 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 reference 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 reference 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 reference from the system by its ID.
      tags:
        - References
    patch:
      description: >-
        This method will patch an existing reference with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchReference
      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 reference to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reference'
          description: The reference 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 reference 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 reference 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 reference 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 reference with the specified ID.
      tags:
        - References
    put:
      description: This method will update an existing reference with the specified ID.
      operationId: updateReference
      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 reference to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reference'
        description: The updated reference that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reference'
          description: The reference 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 reference 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 reference 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 reference 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 reference 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 reference with the specified ID.
      tags:
        - References
  /reviewProcesses/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new review process. If
        an ID is specified for the review process, an error will be thrown.
      operationId: createReviewProcess
      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/ReviewProcess'
        description: The review process that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcess'
          description: The review process 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 review process 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 review process 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 review process 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 review process record that does not already exist.
      tags:
        - Review Processes
  /reviewProcesses/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listProcessesByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListReviewProcessesResponse'
          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 award_id
      tags:
        - Review Processes
  /reviewProcesses/{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 review process 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 review process 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:
        - Review Processes
  /reviewProcesses/{tenantId}/eligible/{contactId}:
    get:
      operationId: getEligibleProcesses
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed
          schema:
            type: string
        - in: path
          name: contactId
          required: true
          description: The contact id
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReviewProcessesResponse'
          description: Processes 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: 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: >-
            Request limit exceeded... please try your request again in a few
            seconds
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          description: An internal server error occured.
          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 processes a contact/org is eligible to use
      tags:
        - Review Processes
  /reviewProcesses/{tenantId}/{id}:
    delete:
      description: This method will delete a review process with the specified ID.
      operationId: deleteReviewProcess
      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 review process to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The review process 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 review process 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 review process 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 review process 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 review process from the system by its ID.
      tags:
        - Review Processes
    get:
      description: >-
        This method will look up a review process by the specified ID and return
        it back.
      operationId: getReviewProcess
      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 review process 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/ReviewProcess'
          description: The review process 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 review process 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 review process 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 review process from the system by its ID.
      tags:
        - Review Processes
    patch:
      description: >-
        This method will patch an existing review process with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchReviewProcess
      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 review process to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcess'
          description: The review process 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 review process 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 review process 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 review process 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 review process with the specified ID.
      tags:
        - Review Processes
    put:
      description: >-
        This method will update an existing review process with the specified
        ID.
      operationId: updateReviewProcess
      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 review process to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewProcess'
        description: The updated review process that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcess'
          description: The review process 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 review process 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 review process 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 review process 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 review process 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 review process with the specified ID.
      tags:
        - Review Processes
  /reviewRounds/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new review round. If
        an ID is specified for the review round, an error will be thrown.
      operationId: createReviewRound
      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/ReviewRound'
        description: The review round that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewRound'
          description: The review round 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 review round 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 review round 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 review round 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 review round record that does not already exist.
      tags:
        - Review Rounds
  /reviewRounds/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listRoundsByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListReviewRoundsResponse'
          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 award_id
      tags:
        - Review Rounds
  /reviewRounds/{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 review round 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 review round 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:
        - Review Rounds
  /reviewRounds/{tenantId}/{id}:
    delete:
      description: This method will delete a review round with the specified ID.
      operationId: deleteReviewRound
      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 review round to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The review round 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 review round 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 review round 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 review round 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 review round from the system by its ID.
      tags:
        - Review Rounds
    get:
      description: >-
        This method will look up a review round by the specified ID and return
        it back.
      operationId: getReviewRound
      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 review round 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/ReviewRound'
          description: The review round 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 review round 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 review round 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 review round from the system by its ID.
      tags:
        - Review Rounds
    patch:
      description: >-
        This method will patch an existing review round with the specified ID,
        using the HTTP PATCH specification.
      operationId: patchReviewRound
      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 review round to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewRound'
          description: The review round 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 review round 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 review round 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 review round 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 review round with the specified ID.
      tags:
        - Review Rounds
    put:
      description: This method will update an existing review round with the specified ID.
      operationId: updateReviewRound
      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 review round to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewRound'
        description: The updated review round that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewRound'
          description: The review round 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 review round 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 review round 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 review round 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 review round 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 review round with the specified ID.
      tags:
        - Review Rounds
  /reviews/{tenantId}:
    post:
      description: >-
        This method will auto-generate an ID and create a new review. If an ID
        is specified for the review, an error will be thrown.
      operationId: createReview
      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/Review'
        description: The review that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: The review 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 review 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 review 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 review 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 review record that does not already exist.
      tags:
        - Reviews
  /reviews/{tenantId}/award/{award_id}:
    get:
      description: Returns a list of records with the specified award_id
      operationId: listReviewsByAwardId
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: award_id
          required: true
          description: The award_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/ListReviewsResponse'
          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 award_id
      tags:
        - Reviews
  /reviews/{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 review 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 review 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:
        - Reviews
  /reviews/{tenantId}/contact/{contact_id}:
    get:
      description: Returns a list of records with the specified contact_id
      operationId: listReviewsByContactId
      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/ListReviewsResponse'
          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:
        - Reviews
  /reviews/{tenantId}/reviewRound/{review_round_id}/{status}:
    get:
      description: Returns a list of records with the specified review_round_id
      operationId: listReviewsByReviewRoundIdStatus
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
        - in: path
          name: review_round_id
          required: true
          description: The review_round_id to use to for record lookup
          schema:
            type: string
        - in: path
          name: status
          required: true
          description: The status of the review
          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/ListReviewsResponse'
          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 review_round_id
      tags:
        - Reviews
  /reviews/{tenantId}/search:
    post:
      description: Searches for reviews using predefined parameters
      operationId: searchForReviews
      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/ReviewSearchParameters'
        description: The review that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedReviewSearchResults'
          description: The review 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 review 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 review 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 review 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 reviews using predefined parameters
      tags:
        - Reviews
  /reviews/{tenantId}/submit:
    post:
      operationId: submitReview
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The tenant
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Review'
        description: Object definition of review
        required: true
      responses:
        '200':
          description: The record 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: Unable to locate any organizations with the specified domain
          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: Submit a review
      tags:
        - Reviews
  /reviews/{tenantId}/{id}:
    delete:
      description: This method will delete a review with the specified ID.
      operationId: deleteReview
      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 review to delete.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The review 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 review 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 review 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 review 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 review from the system by its ID.
      tags:
        - Reviews
    get:
      description: >-
        This method will look up a review by the specified ID and return it
        back.
      operationId: getReview
      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 review 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/Review'
          description: The review 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 review 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 review 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 review from the system by its ID.
      tags:
        - Reviews
    patch:
      description: >-
        This method will patch an existing review with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchReview
      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 review to patch.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: The review 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 review 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 review 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 review 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 review with the specified ID.
      tags:
        - Reviews
    put:
      description: This method will update an existing review with the specified ID.
      operationId: updateReview
      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 review to update.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Review'
        description: The updated review that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: The review 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 review 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 review 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 review 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 review 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 review with the specified ID.
      tags:
        - Reviews
  /settings/{tenantId}:
    delete:
      description: This method will delete a setting with the specified ID.
      operationId: deleteSetting
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The setting 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 setting 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 setting 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 setting 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 setting from the system by its ID.
      tags:
        - Settings
    get:
      description: >-
        This method will look up a setting by the specified ID and return it
        back.
      operationId: getSetting
      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: 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/Setting'
          description: The setting 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 setting 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 setting 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 setting from the system by its ID.
      tags:
        - Settings
    patch:
      description: >-
        This method will patch an existing setting with the specified ID, using
        the HTTP PATCH specification.
      operationId: patchSetting
      parameters:
        - in: path
          name: tenantId
          required: true
          description: The id of the tenant being accessed.
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/PatchDirectiveArray'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
          description: The setting 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 setting 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 setting 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 setting 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 setting with the specified ID.
      tags:
        - Settings
    post:
      description: >-
        This method will auto-generate an ID and create a new setting. If an ID
        is specified for the setting, an error will be thrown.
      operationId: createSetting
      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/Setting'
        description: The setting that you would like to be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
          description: The setting 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 setting 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 setting 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 setting 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 setting record that does not already exist.
      tags:
        - Settings
    put:
      description: This method will update an existing setting with the specified ID.
      operationId: updateSetting
      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/Setting'
        description: The updated setting that will be saved.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
          description: The setting 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 setting 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 setting 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 setting 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 setting 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 setting with the specified ID.
      tags:
        - Settings
  /statistics/{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 statistic 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 statistic 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:
        - Statistics
  /statistics/{tenantId}/{id}:
    get:
      description: >-
        This method will look up a statistic by the specified ID and return it
        back.
      operationId: getStatistic
      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 statistic to return.
          schema:
            type: string
        - in: query
          name: parameters
          required: false
          description: Parameters to the query
          schema:
            type: string
        - in: query
          name: recalculate
          required: false
          description: >-
            If true, the latest statistic will be calculated and the cache will
            be updated
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Statistic'
          description: The statistic 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 statistic 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 statistic 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 statistic from the system by its ID.
      tags:
        - Statistics
  /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://awards.api.rhythmsoftware.com
tags:
  - name: Application Fees
    description: Application Fees
  - name: Application Processes
    description: Application Processes
  - name: Application Status Reasons
    description: Application Status Reasons
  - name: Applications
    description: Applications
  - name: Awards
    description: Awards
  - name: Categories
    description: Categories
  - name: Coupons
    description: Coupons
  - name: Nomination Processes
    description: Nomination Processes
  - name: Nominations
    description: Nominations
  - name: Nominees
    description: Nominees
  - name: Query Definitions
    description: Query Definitions
  - name: Recipient Categories
    description: Recipient Categories
  - name: Recipients
    description: Recipients
  - name: Reference Processes
    description: Reference Processes
  - name: Reference Types
    description: Reference Types
  - name: References
    description: References
  - name: Review Processes
    description: Review Processes
  - name: Review Rounds
    description: Review Rounds
  - name: Reviews
    description: Reviews
  - name: Settings
    description: Settings
  - name: Statistics
    description: Statistics
  - name: Types
    description: Types
