Forsta Translation Reservations API

openapi: 3.2.0
info:
  title: Decipher Rest Translation Reservations 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: Translation Reservations
  description: 'The translation reservation system is used to mark translations which have

    already been pulled for translating and to prevent deltas from being pulled

    multiple times.'
paths:
  /translation/delta/reservation:
    get:
      operationId: getTranslationDeltaReservations
      summary: Get translation reservations
      description: Returns active reservations
      tags:
      - Translation Reservations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ackDatas:
                    type: array
                    items:
                      type: object
                      properties:
                        jobId:
                          type: string
                        targetLanguages:
                          type: array
                          items:
                            type: string
                        requests:
                          type: array
                          items:
                            type: object
                            properties:
                              documentId:
                                type: string
              example:
                ackDatas:
                - requests:
                  - documentId: selfserve/53a/171200
                  - documentId: selfserve/53a/171201
                  targetLanguages:
                  - es
                  - ja
                  jobId: 01e80a5cb03e4aa19521513c57e91f08
                - requests:
                  - documentId: selfserve/53a/171202
                  targetLanguages:
                  - ar-LB
                  jobId: 1195619ab8854e3ca81b593183edd398
    post:
      operationId: createTranslationDeltaReservation
      summary: Add translation reservation
      description: Add a new reservation
      tags:
      - Translation Reservations
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ackDatas:
                  type: array
                  items:
                    type: object
                    properties:
                      targetLanguages:
                        type: array
                        description: an array of languages to be reserved
                        items:
                          type: string
                      requests:
                        type: array
                        description: 'an array of objects with documentId which should be the

                          path to the survey

                          '
                        items:
                          type: object
                          properties:
                            documentId:
                              type: string
                              format: survey path
                      jobId:
                        type: string
                        description: a unique jobId to identify the reservation
              required:
              - ackDatas
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    targetLanguages:
                      type: array
                      items:
                        type: string
                    requests:
                      type: array
                      items:
                        type: object
                        properties:
                          documentId:
                            type: string
                    jobId:
                      type: string
              example:
              - targetLanguages:
                - es
                requests:
                - documentId: selfserve/53a/170201
                jobId: e724ce5c5b8b4eb08e50dda26ee89aac
  /translation/delta/reservation/delete:
    post:
      operationId: createTranslationDeltaReservationsDelete
      summary: Delete translation reservation
      description: Delete reservations by their jobIds
      tags:
      - Translation Reservations
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  description: A reason for the reservation cancellation
                  type: string
                cancelledBy:
                  description: Who is canceling this reservation
                  type: string
                jobIds:
                  description: An array of jobIds to cancel
                  type: array
                  items:
                    type: string
              required:
              - reason
              - cancelledBy
              - jobIds
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
components:
  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