openapi: 3.0.3
info:
  title: Talend Cloud Orchestration Artifacts Plans 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: Plans
paths:
  /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
components:
  parameters:
    PlanId:
      name: planId
      in: path
      required: true
      schema:
        type: string
      description: Plan identifier
  schemas:
    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
    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
  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/