openapi: 3.0.3
info:
  title: Talend Cloud Orchestration Artifacts Workspaces 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
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: []
tags:
- name: Workspaces
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
components:
  responses:
    NotFound:
      description: Not Found - resource does not exist
    BadRequest:
      description: Bad Request - invalid request body
    Unauthorized:
      description: Unauthorized - invalid or missing bearer token
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Resource identifier
  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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token from Talend Cloud personal access token or service account token
externalDocs:
  description: Talend Orchestration API Documentation
  url: https://talend.qlik.dev/apis/orchestration/2021-03/