openapi: 3.0.3
info:
  title: Talend Cloud Orchestration API
  description: >-
    The Talend Cloud Orchestration API manages tasks, plans, schedules,
    workspaces, environments, artifacts, connections, promotions, and resources
    in Qlik Talend Cloud. Use this API to automate data integration pipeline
    management, configure execution schedules, and manage workspace resources.
  version: 2021-03
  contact:
    name: Qlik Talend Support
    url: https://talend.qlik.dev
  termsOfService: https://www.qlik.com/us/legal/license-terms
externalDocs:
  description: Talend Orchestration API Documentation
  url: https://talend.qlik.dev/apis/orchestration/2021-03/
servers:
  - url: https://api.{region}.cloud.talend.com
    description: Talend Cloud API
    variables:
      region:
        description: Cloud region
        default: eu
        enum:
          - eu
          - us
          - us-west
          - ap
          - au
security:
  - BearerAuth: []
paths:
  /orchestration/workspaces:
    get:
      operationId: listWorkspaces
      summary: List Workspaces
      description: Retrieve all workspaces available in the Talend Cloud account
      tags:
        - Workspaces
      responses:
        '200':
          description: List of workspaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workspace'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createWorkspace
      summary: Create Workspace
      description: Create a new workspace in the Talend Cloud account
      tags:
        - Workspaces
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCreate'
      responses:
        '201':
          description: Workspace created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /orchestration/workspaces/{id}:
    get:
      operationId: getWorkspace
      summary: Get Workspace
      description: Retrieve a specific workspace by ID
      tags:
        - Workspaces
      parameters:
        - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Workspace details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateWorkspace
      summary: Update Workspace
      description: Update an existing workspace
      tags:
        - Workspaces
      parameters:
        - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCreate'
      responses:
        '200':
          description: Workspace updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
    delete:
      operationId: deleteWorkspace
      summary: Delete Workspace
      description: Remove a workspace from the Talend Cloud account
      tags:
        - Workspaces
      parameters:
        - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: Workspace deleted
  /orchestration/executables/tasks:
    get:
      operationId: listTasks
      summary: List Tasks
      description: Retrieve all data integration tasks in the account
      tags:
        - Tasks
      parameters:
        - name: workspaceId
          in: query
          schema:
            type: string
          description: Filter tasks by workspace
        - name: limit
          in: query
          schema:
            type: integer
            default: 100
          description: Maximum number of tasks to return
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
          description: Number of tasks to skip
      responses:
        '200':
          description: List of tasks
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Task'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createTask
      summary: Create Task
      description: Create a new data integration task
      tags:
        - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreate'
      responses:
        '201':
          description: Task created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
  /orchestration/executables/tasks/{taskId}:
    get:
      operationId: getTask
      summary: Get Task
      description: Retrieve details of a specific task
      tags:
        - Tasks
      parameters:
        - $ref: '#/components/parameters/TaskId'
      responses:
        '200':
          description: Task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
    put:
      operationId: updateTask
      summary: Update Task
      description: Update an existing task configuration
      tags:
        - Tasks
      parameters:
        - $ref: '#/components/parameters/TaskId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreate'
      responses:
        '200':
          description: Task updated
    delete:
      operationId: deleteTask
      summary: Delete Task
      description: Remove a task from the account
      tags:
        - Tasks
      parameters:
        - $ref: '#/components/parameters/TaskId'
      responses:
        '204':
          description: Task deleted
  /orchestration/executables/tasks/search:
    post:
      operationId: searchTasks
      summary: Search Tasks
      description: Search tasks with filters
      tags:
        - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                workspaceId:
                  type: string
                environmentId:
                  type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Task'
  /orchestration/executables/plans:
    get:
      operationId: listPlans
      summary: List Plans
      description: Retrieve all execution plans in the account
      tags:
        - Plans
      parameters:
        - name: workspaceId
          in: query
          schema:
            type: string
          description: Filter plans by workspace
      responses:
        '200':
          description: List of plans
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Plan'
    post:
      operationId: createPlan
      summary: Create Plan
      description: Create a new execution plan composed of tasks
      tags:
        - Plans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanCreate'
      responses:
        '201':
          description: Plan created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
  /orchestration/executables/plans/{planId}:
    get:
      operationId: getPlan
      summary: Get Plan
      description: Retrieve details of a specific plan
      tags:
        - Plans
      parameters:
        - $ref: '#/components/parameters/PlanId'
      responses:
        '200':
          description: Plan details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
    put:
      operationId: updatePlan
      summary: Update Plan
      description: Update an existing plan
      tags:
        - Plans
      parameters:
        - $ref: '#/components/parameters/PlanId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanCreate'
      responses:
        '200':
          description: Plan updated
    delete:
      operationId: deletePlan
      summary: Delete Plan
      description: Remove a plan
      tags:
        - Plans
      parameters:
        - $ref: '#/components/parameters/PlanId'
      responses:
        '204':
          description: Plan deleted
  /orchestration/schedules:
    get:
      operationId: listSchedules
      summary: List Schedules
      description: List all execution schedules in the account
      tags:
        - Schedules
      responses:
        '200':
          description: List of schedules
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Schedule'
    post:
      operationId: createSchedule
      summary: Create Schedule
      description: Create a new execution schedule
      tags:
        - Schedules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleCreate'
      responses:
        '201':
          description: Schedule created
  /orchestration/environments:
    get:
      operationId: listEnvironments
      summary: List Environments
      description: Retrieve all environments in the account
      tags:
        - Environments
      responses:
        '200':
          description: List of environments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
    post:
      operationId: createEnvironment
      summary: Create Environment
      description: Create a new environment
      tags:
        - Environments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentCreate'
      responses:
        '201':
          description: Environment created
  /orchestration/connections:
    get:
      operationId: listConnections
      summary: List Connections
      description: Retrieve all connections configured in the account
      tags:
        - Connections
      responses:
        '200':
          description: List of connections
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Connection'
    post:
      operationId: createConnection
      summary: Create Connection
      description: Create a new data source connection
      tags:
        - Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionCreate'
      responses:
        '201':
          description: Connection created
  /orchestration/artifacts:
    get:
      operationId: listArtifacts
      summary: List Artifacts
      description: Retrieve available deployment artifacts
      tags:
        - Artifacts
      responses:
        '200':
          description: List of artifacts
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Artifact'
  /orchestration/executables/promotions:
    get:
      operationId: listPromotions
      summary: List Promotions
      description: List all environment promotions in the account
      tags:
        - Promotions
      responses:
        '200':
          description: List of promotions
    post:
      operationId: createPromotion
      summary: Create Promotion
      description: Create a new environment promotion
      tags:
        - Promotions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                sourceEnvironmentId:
                  type: string
                targetEnvironmentId:
                  type: string
      responses:
        '201':
          description: Promotion created
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token from Talend Cloud personal access token or service account token
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Resource identifier
    TaskId:
      name: taskId
      in: path
      required: true
      schema:
        type: string
      description: Task identifier
    PlanId:
      name: planId
      in: path
      required: true
      schema:
        type: string
      description: Plan identifier
  responses:
    Unauthorized:
      description: Unauthorized - invalid or missing bearer token
    BadRequest:
      description: Bad Request - invalid request body
    NotFound:
      description: Not Found - resource does not exist
  schemas:
    Workspace:
      type: object
      description: A logical grouping of tasks, plans, and connections in Talend Cloud
      properties:
        id:
          type: string
          description: Unique workspace identifier
        name:
          type: string
          description: Workspace display name
        description:
          type: string
          description: Workspace description
        owner:
          type: string
          description: Owner user ID
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
    WorkspaceCreate:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        description:
          type: string
    Task:
      type: object
      description: A data integration task in Talend Cloud
      properties:
        id:
          type: string
          description: Unique task identifier
        name:
          type: string
          description: Task name
        workspaceId:
          type: string
          description: Parent workspace ID
        environmentId:
          type: string
          description: Execution environment ID
        description:
          type: string
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - DRAFT
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
    TaskCreate:
      type: object
      required:
        - name
        - workspaceId
      properties:
        name:
          type: string
        workspaceId:
          type: string
        environmentId:
          type: string
        description:
          type: string
    Plan:
      type: object
      description: An ordered sequence of tasks in Talend Cloud
      properties:
        id:
          type: string
        name:
          type: string
        workspaceId:
          type: string
        description:
          type: string
        steps:
          type: array
          items:
            type: object
            properties:
              taskId:
                type: string
              order:
                type: integer
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
    PlanCreate:
      type: object
      required:
        - name
        - workspaceId
      properties:
        name:
          type: string
        workspaceId:
          type: string
        description:
          type: string
        steps:
          type: array
          items:
            type: object
            properties:
              taskId:
                type: string
              order:
                type: integer
    Schedule:
      type: object
      description: A time-based trigger for task or plan execution
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        timezone:
          type: string
          description: IANA timezone name
        created:
          type: string
          format: date-time
    ScheduleCreate:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        description:
          type: string
        timezone:
          type: string
    Environment:
      type: object
      description: An execution environment in Talend Cloud
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        default:
          type: boolean
        created:
          type: string
          format: date-time
    EnvironmentCreate:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        description:
          type: string
    Connection:
      type: object
      description: A data source or destination connection configuration
      properties:
        id:
          type: string
        name:
          type: string
        workspaceId:
          type: string
        type:
          type: string
          description: Connection type (e.g., JDBC, S3, Snowflake)
        created:
          type: string
          format: date-time
    ConnectionCreate:
      type: object
      required:
        - name
        - workspaceId
        - type
      properties:
        name:
          type: string
        workspaceId:
          type: string
        type:
          type: string
        configuration:
          type: object
          additionalProperties: true
    Artifact:
      type: object
      description: A deployable Talend artifact (JAR, ZIP, etc.)
      properties:
        id:
          type: string
        name:
          type: string
        version:
          type: string
        description:
          type: string
        created:
          type: string
          format: date-time