openapi: 3.2.0
info:
  title: Decipher Rest Check In Section API
  version: '1.0'
  description: The Decipher REST API allows comprehensive automation of your private or shared Decipher instance.
servers:
- url: https://{server}/api/v1
  description: Replace server with your instance domain.
  variables:
    server:
      default: selfserve.decipherinc.com
      description: Server domain
security:
- APIKey: []
tags:
- name: Check In Section
paths:
  /surveys/{survey}/sections/{section}/checkin:
    post:
      operationId: createSurveySectionCheckin
      summary: Check in survey section
      description: Merge checked out section of survey into main survey.
      tags:
      - Check In Section
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: section
        in: path
        description: Label for the section (i.e. block) to check in.
        example: b1
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  checked_in:
                    description: Date and time when survey was last updated, after checking in.
                    format: ISO 8601 timestamp with timezone
                    example: '2021-06-22T21:47:47Z'
                    type: string
                  checked_out:
                    description: 'Date and time when survey was last updated.

                      Always `null` for this endpoint.

                      '
                    example: null
                    type: string
                  checked_out_sections:
                    description: List of sections that are checked out.
                    type: array
                    items:
                      type: object
                      properties:
                        builder_path:
                          type: string
                        checked_out:
                          type: string
                        editor:
                          type: string
                        is_available:
                          type: boolean
                        label:
                          type: string
                        path:
                          type: string
                        title:
                          type: string
                        updates:
                          type: string
                    example:
                    - builder_path: 53a/210203/temp-subsection-b2
                      checked_out: '2021-06-22T21:22:35Z'
                      editor': Jane Doe
                      is_available: false
                      label: b2
                      path: selfserve/53a/210203/temp-subsection-b2
                      title: Block two
                      updates: true
                  disableSections:
                    description: Number of checked out sections for the survey.
                    example: 3
                    type: integer
                  editor:
                    description: '`null` if the operation was successful.

                      Name or email address of the editor user if there were errors while syncing with the main survey.

                      '
                    example: null
                    type: string
                  errors:
                    description: List of errors found if the operation was not successful.
                    example: []
                    type: array
                  is_available:
                    description: True if the section is available for check out again.
                    example: true
                    type: boolean
                  success:
                    description: True if the operation completed without errors.
                    example: true
                    type: boolean
                  title:
                    description: Section's (i.e. block element) title.
                    example: Block One
                    type: string
                  updates:
                    description: 'True if there have been any updates to the main survey. Can be false or null.

                      Always `null` for this endpoint.

                      '
                    example: null
                    type: string
components:
  parameters:
    survey:
      name: survey
      in: path
      required: true
      description: The survey path.
      example: selfserve/1a/123456
      schema:
        type: string
        format: uri
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: x-apikey
      description: 'In order to access the api, you''ll need to generate an API key. Refer to the

        instructions [here](/docs/decipher/api#section/API-Keys) to generate and

        configure an API key with the appropriate permission sets. You can generate

        as many keys as required.


        Configure each request to include your API key in the request header. For example:


        ```

        x-apikey: dp48ss3mgsaucyjtybxw728h7s4cgnwzhejtszdwhf4xpe8yhmtdwpk2ntdhtwbs

        ```

        '
x-tagGroups:
- name: Autoclose
  tags:
  - Autoclose
- name: Data Input and Output
  tags:
  - Data
  - Data Feed
  - Response Summary
  - Modifying Data
  - Datasources
  - Datasources Data
  - Umerge
- name: Survey Metadata
  tags:
  - Simulated Data
  - Survey State
  - Survey Evaluate
  - Survey Quotas
  - Survey Files
  - Survey Warnings
  - Survey Terms
  - Survey Subscribers
  - Survey Users
  - Survey Tasks
- name: Panels
  tags:
  - Panel Data
  - Panel Datapoints
  - Survey Panels
- name: Research Hub
  tags:
  - Users
  - Companies
  - Categories
  - Surveys
  - Panels
  - Crosstabs
  - Archives
  - Archival Reports
  - API Keys
  - Usage
  - Warnings Summary
- name: Crosstabs
  tags:
  - Crosstabs Configuration
  - Crosstabs Execution
  - Crosstabs Nets
  - Saved Crosstabs
  - Crosstabs Table Settings
  - Crosstabs Validation
  - Crosstabs Rim Weighting
- name: Dashboards
  tags:
  - Dashboards
- name: DQ APIs
  tags:
  - DQ-Specific API Calls
  - MaxDiff API Calls
  - Discrete Choice Model API Calls
  - Media Testimonial API Calls
- name: Response Summary
  tags:
  - Share Link
- name: Sample Management
  tags:
  - Bounced Emails
  - Participant Sources
- name: Distribution
  tags:
  - Email Distribution
  - SFTP Distribution
  - Slack Distribution
- name: Campaign Manager
  tags:
  - Campaigns
  - Campaign Email Invites
  - Campaign Exports
  - Campaign Lists
  - Shared Campaign Lists
  - Campaign Sends
  - Campaign Status Lists
  - Supression Lists
- name: Question Library
  tags:
  - Company Element
  - Company Elements
  - Survey Elements
  - Survey Element Report Settings
- name: Language Manager
  tags:
  - LM Application Data
  - LM Application Translations
  - Translation Resources
  - Translations
  - Translation Deltas
  - Translation Reservations
  - Primary Survey Language
  - Other Survey Languages
  - Unused Survey Languages
- name: Project Parameters
  tags:
  - Available Project Parameters
  - Saved Project Parameters
  - Project Parameters Configuration
- name: Multi-User Editing
  tags:
  - Available Sections
  - Check Out Section
  - Check In Section
  - Sync Section
  - Section Editor
  - Abandon Section
  - Validate Section
- name: Video Management
  tags:
  - Videos
  - Watermarked Videos
- name: Miscellaneous
  tags:
  - System Information
  - Logic Nodes
  - Logic Events
  - CATI
  - Global Search
  - Miscellaneous