aspera-cli 4.27.5 → 4.28.0

data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml

@@ -0,0 +1,4001 @@
+# DO NOT EDIT THIS FILE MANUALLY
+# This file is automatically downloaded from:
+# https://raw.githubusercontent.com/laurent-martin/aspera-api-examples/refs/heads/main/openapi/IBM%20Aspera%20Orchestrator%20API-v1-enhanced.yaml
+# Use 'rake tools:openapi' to update this file
+
+openapi: 3.1.0
+info:
+  title: Aspera Orchestrator API
+  version: v1
+  license:
+    name: (c) IBM. All rights reserved
+    url: https://ibm.com
+  description: |
+    API documentation for Aspera Orchestrator 4.1.6, checked against its source code (`config/routes.rb` and `ApiController`).
+
+    ## Authentication
+
+    The API supports two authentication modes:
+
+    ### JWT Authentication (Recommended)
+
+    When JWT authentication is enabled (default):
+
+    1. Obtain a JWT token by calling POST /api/login with your credentials
+    2. Include the token in subsequent requests using the Authorization header:
+       `Authorization: Bearer <your_token>`
+
+    ### Credentials in Each Request (When JWT is Disabled)
+
+    If JWT authentication is disabled in your Orchestrator configuration (`/api/login` then returns 403), give the credentials with every API request, either:
+
+    - as query parameters `login` and `password`, e.g. `/api/workflows_list?login=admin&password=mypassword&format=json`
+    - as query parameters `login` and `api_key` (the API key of the user)
+    - with HTTP Basic authentication
+
+    **Note:** Check your Orchestrator configuration to determine which authentication mode is active.
+
+    ## Routes
+
+    - Some endpoints have their own route, `/api/<endpoint>`, with the HTTP method given here.
+    - Every endpoint can also be called as `/api/<endpoint>/<id>`, with any HTTP method, where `<id>` is its main identifier.
+      Endpoints without their own route can only be called this way: when `id` is not used by the endpoint, any value works, for example `0`.
+    - Parameters can be given in the query, or in a JSON or form body.
+
+    ## Response format
+
+    Most endpoints return XML by default.
+    For JSON, add `format=json`, or the extension `.json` to the last segment of the path (e.g. `/api/work_order_status/123.json`).
+
+    ## Errors
+
+    Errors are returned with HTTP status 200, or 404 when the server option `strict_api_validation` is set.
+    The body is `<error time=... action=... id=...>message and backtrace</error>`, or in JSON `{"error": {"action": ..., "time": ..., "id": ..., "description": ...}}`.
+servers:
+  - url: https://158.176.9.141/aspera/orchestrator
+    description: 'Configured host: 158.176.9.141'
+  - url: https://orchestrator.aspera-emea.com/aspera/orchestrator
+    description: 'Configured host: orchestrator.aspera-emea.com'
+security:
+  - bearerAuth: []
+  - basicAuth: []
+  - loginQuery: []
+    passwordQuery: []
+  - loginQuery: []
+    apiKeyQuery: []
+paths:
+  /api/login:
+    post:
+      operationId: login
+      security: []
+      summary: Authenticate and obtain JWT token
+      tags:
+        - Authentication
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              description: '`username`, with either `password` or `api_key` (the API key of that user)'
+              oneOf:
+                - title: Username and password
+                  type: object
+                  required:
+                    - username
+                    - password
+                  properties:
+                    username:
+                      type: string
+                      description: User login name
+                    password:
+                      type: string
+                      format: password
+                      description: User password
+                  additionalProperties: false
+                - title: Username and API key
+                  type: object
+                  required:
+                    - username
+                    - api_key
+                  properties:
+                    username:
+                      type: string
+                      description: User login name
+                    api_key:
+                      type: string
+                      description: API key of the user
+                  additionalProperties: false
+            examples:
+              credentials:
+                summary: Username and password
+                value:
+                  username: admin
+                  password: mypassword
+              api_key:
+                summary: Username and API key
+                value:
+                  username: admin
+                  api_key: my_api_key
+      responses:
+        '200':
+          description: Successfully authenticated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    examples:
+                      - Logged in successfully
+                  user:
+                    type: object
+                    properties:
+                      id:
+                        type: integer
+                      login:
+                        type: string
+                      email:
+                        type: string
+                  token:
+                    type: string
+                    description: JWT token for subsequent API calls
+        '401':
+          description: Invalid credentials
+        '403':
+          description: Secure API auth disabled
+  /api/workflows_list:
+    get:
+      operationId: workflows_list
+      summary: List all workflows
+      tags:
+        - Workflows
+      parameters:
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of workflows
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  workflows:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                        description: UTC time
+                      action:
+                        type: string
+                        const: list
+                      id:
+                        type: integer
+                      workflow:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: integer
+                            name:
+                              type: string
+                            full_name:
+                              type: string
+                              description: Name with the folder path
+                            folder_id:
+                              type: [integer, 'null']
+                            portable_id:
+                              type: [string, 'null']
+                            published_status:
+                              type: string
+                              enum:
+                                - published
+                                - draft
+                            published_revision_id:
+                              type: [integer, string]
+                              description: '`-` when not published'
+                            latest_revision_id:
+                              type: [integer, string]
+                              description: '`-` when there is no whiteboard'
+                            last_modification:
+                              type: string
+                              format: date-time
+                            comments:
+                              type: [string, 'null']
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/workflows_status:
+    get:
+      operationId: workflows_status
+      summary: Running status of workflows
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: query
+          schema:
+            type: string
+          description: Workflow ID or portable ID. Not set, or `0`, for all workflows.
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Workflow status information
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  workflows:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                        description: UTC time
+                      action:
+                        type: string
+                        const: status
+                      id:
+                        type: integer
+                      workflow:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: integer
+                            name:
+                              type: string
+                            status:
+                              type: string
+                              enum:
+                                - running
+                                - not running
+                            last_activity:
+                              type: string
+                              description: Last update of the running work orders, or `-`
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/workflow_details/{id}:
+    get:
+      operationId: workflow_details
+      summary: Number of work orders of a workflow, by status
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Workflow ID
+        - name: start_date
+          in: query
+          schema:
+            type: string
+          description: Count work orders created after this date
+        - name: end_date
+          in: query
+          schema:
+            type: string
+          description: Count work orders created before this date
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Work order counts by status
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  workflows:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                        description: UTC time
+                      action:
+                        type: string
+                        const: status
+                      id:
+                        type: integer
+                      workflow:
+                        type: object
+                        properties:
+                          name:
+                            type: string
+                          id:
+                            type: integer
+                          statuses:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                count:
+                                  type: integer
+                                last_activity:
+                                  type: string
+                                  format: date-time
+                                workflow_name:
+                                  type: string
+                                status:
+                                  type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/workflow_inputs_spec/{id}:
+    get:
+      operationId: workflow_inputs_spec
+      summary: Runtime parameters of a workflow
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Workflow ID or portable ID, or `0` to use `workflow_name`, or `-1` to use `portable_id`
+        - name: workflow_name
+          in: query
+          schema:
+            type: string
+          description: Workflow name, when `id` is `0`
+        - name: portable_id
+          in: query
+          schema:
+            type: string
+          description: Workflow portable ID, when `id` is `-1`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Runtime parameters
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  workflow_inputs_spec:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                        description: UTC time
+                      action:
+                        type: string
+                        const: inputs_spec
+                      workflow_name:
+                        type: string
+                      workflow_id:
+                        type: integer
+                      parameter:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: integer
+                            name:
+                              type: string
+                            value_type:
+                              type: string
+                            optional:
+                              type: [boolean, 'null']
+                            value:
+                              type: string
+                              description: Default value, for an optional parameter
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/workflow_outputs_spec/{id}:
+    get:
+      operationId: workflow_outputs_spec
+      summary: Outputs of the steps of a workflow
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Workflow ID or portable ID (also accepted as query parameter `workflow_id`)
+        - name: workflow_id
+          in: query
+          schema:
+            type: string
+          description: Workflow ID or portable ID, takes precedence over `id`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Outputs of the workflow
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  workflow_outputs_spec:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                        description: UTC time
+                      action:
+                        type: string
+                        const: outputs_spec
+                      output:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            context_id:
+                              type: integer
+                            name:
+                              type: string
+                              description: '`<step name>:<output name>`'
+                            workflow_id:
+                              type: integer
+                            step_name:
+                              type: string
+                            variable_name:
+                              type: string
+                            value_type:
+                              type: string
+                            variable_type:
+                              type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/import_workflow:
+    post:
+      operationId: import_workflow
+      summary: Import a workflow
+      description: Always creates a new workflow. The response is the new workflow as JSON, whatever the format.
+      tags:
+        - Workflows
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required:
+                - import_file
+                - import_file_name
+              properties:
+                import_file:
+                  type: string
+                  contentMediaType: application/octet-stream
+                  description: The workflow file to import (.wkf or .yml)
+                import_file_name:
+                  type: string
+                  pattern: (wkf|yml)$
+                  description: File name ending with `wkf` or `yml`. The file is saved under this name in the import folder of the server.
+                  examples:
+                    - my_workflow.wkf
+                folder_id:
+                  type: integer
+                  description: Folder of the new workflow
+                link_to_subworkflows:
+                  type: string
+                  description: Link to existing sub-workflows instead of importing them. Any value, including `false`, is taken as true.
+                publish_workflow:
+                  type: string
+                  description: '`true` or `1` to publish the workflow after import. Default: server option `publish_api_imported_workflow`.'
+                format:
+                  type: string
+                  enum:
+                    - xml
+                    - json
+                  default: xml
+      responses:
+        '200':
+          description: The new workflow (JSON)
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Workflow'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+        '500':
+          description: Import failed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                  message:
+                    type: string
+                  details:
+                    type: string
+                    description: Error message
+  /api/find_constraints:
+    get:
+      operationId: find_constraints
+      summary: Find workflow import constraints
+      description: 'Analyzes a workflow file present on the Orchestrator host, and returns the list expected by `import_with_constraints`, with the possible choices for each conflict with existing sub-workflows, global templates and remote nodes, and the plugins that are not enabled. The file existence is not checked: a wrong path returns the same empty lists as a file without conflict.'
+      tags:
+        - Workflows
+      parameters:
+        - name: file
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Path of the workflow file (`.yml` or `.wkf`) on the Orchestrator host
+        - name: wf_id
+          in: query
+          schema:
+            type: integer
+          description: ID of an existing workflow, to import the file as a new revision of it
+      responses:
+        '200':
+          description: 'Array of six objects, in the order expected by `import_with_constraints`: `filename`, `add as revision`, `subwf constraints`, `action template constraints`, `remote node constraints`, and `missing plugins` with `Auto-enable missing plugins?`.'
+          content:
+            application/json:
+              schema:
+                type: array
+                minItems: 6
+                maxItems: 6
+                prefixItems:
+                  - type: object
+                    properties:
+                      filename:
+                        type: string
+                  - type: object
+                    properties:
+                      add as revision:
+                        type: [string, 'null']
+                        description: The `wf_id` parameter
+                  - type: object
+                    properties:
+                      subwf constraints:
+                        type: object
+                        description: Sub-workflow name to possible choices
+                        additionalProperties:
+                          type: array
+                          items:
+                            type: string
+                  - type: object
+                    properties:
+                      action template constraints:
+                        type: object
+                        description: Global template name to possible choices
+                        additionalProperties:
+                          type: array
+                          items:
+                            type: string
+                  - type: object
+                    properties:
+                      remote node constraints:
+                        type: object
+                        description: Remote node name to possible choices
+                        additionalProperties:
+                          type: array
+                          items:
+                            type: string
+                  - type: object
+                    properties:
+                      missing plugins:
+                        type: [array, 'null']
+                        description: Plugins to enable, or `null`
+                      Auto-enable missing plugins?:
+                        type: [array, 'null']
+                        description: '`[true, false]` when plugins are missing, else `null`'
+                items: false
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/import_with_constraints:
+    post:
+      operationId: import_with_constraints
+      summary: Import workflow with constraint resolution
+      description: 'Imports a workflow file present on the Orchestrator host, as a new workflow or as a new revision of an existing workflow. The workflow is not published. Orchestrator does not check what `find_constraints` reports: if plugins to enable are listed and `Auto-enable missing plugins?` is not `true`, the call fails with an internal error; a conflict without choice is imported as a copy, without error. `Auto-enable missing plugins?` must be a JSON boolean: the string `"false"` is taken as true.'
+      tags:
+        - Workflows
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              description: Array of six objects with one key each, in this order
+              minItems: 6
+              maxItems: 6
+              prefixItems:
+                - type: object
+                  required:
+                    - filename
+                  properties:
+                    filename:
+                      type: string
+                      description: Path of the workflow file on the Orchestrator host
+                  additionalProperties: false
+                - type: object
+                  required:
+                    - add as revision
+                  properties:
+                    add as revision:
+                      type: [integer, string, 'null']
+                      description: ID or portable ID of the workflow to add a revision to, or `null` for a new workflow
+                  additionalProperties: false
+                - type: object
+                  required:
+                    - subwf constraints
+                  properties:
+                    subwf constraints:
+                      type: object
+                      description: Sub-workflow name to choice
+                      additionalProperties:
+                        type: string
+                        enum:
+                          - Map to the Existing Sub-Workflow
+                          - Create a new Sub-Workflow with a unique name
+                          - Add a new revision to the existing Sub-Workflow
+                  additionalProperties: false
+                - type: object
+                  required:
+                    - action template constraints
+                  properties:
+                    action template constraints:
+                      type: object
+                      description: Global template name to choice
+                      additionalProperties:
+                        type: string
+                        enum:
+                          - Map to the existing Global Template
+                          - Create a new Global Template with a different name
+                          - Override the existing Global Template with this new template
+                  additionalProperties: false
+                - type: object
+                  required:
+                    - remote node constraints
+                  properties:
+                    remote node constraints:
+                      type: object
+                      description: Remote node name to choice
+                      additionalProperties:
+                        type: string
+                        enum:
+                          - Map to the existing Remote Node
+                          - Create a new Remote Node with a different name
+                          - Override the Existing Remote Node with this importing node
+                  additionalProperties: false
+                - type: object
+                  required:
+                    - Auto-enable missing plugins?
+                  properties:
+                    Auto-enable missing plugins?:
+                      type: boolean
+                  additionalProperties: false
+              items: false
+              examples:
+                - - filename: /opt/aspera/orchestrator/var/run/orchestrator/workflows/import/my_workflow.yml
+                  - add as revision: 239
+                  - subwf constraints: {}
+                  - action template constraints:
+                      Search Files: Map to the existing Global Template
+                  - remote node constraints:
+                      Baton: Map to the existing Remote Node
+                  - Auto-enable missing plugins?: true
+      responses:
+        '200':
+          description: The workflow that was imported (JSON)
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Workflow'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+        '500':
+          description: Internal error, e.g. plugins to enable and not auto-enabled, or a file that cannot be read
+  /api/publish_workflow:
+    post:
+      operationId: publish_workflow
+      summary: Publish a workflow
+      description: Publishes the last whiteboard revision. The result is `true`, or `false` when the whiteboard has no `error_free` value.
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: query
+          schema:
+            type: string
+          description: Workflow ID or portable ID (also accepted in a JSON body, or in the path `/api/publish_workflow/<id>`)
+          example: '123'
+        - $ref: '#/components/parameters/Format'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                id:
+                  type: string
+                  description: Workflow ID or portable ID
+      responses:
+        '200':
+          description: '`true` or `false` (JSON), or `<WorkflowPublish><Success>true</Success></WorkflowPublish>` (XML)'
+          content:
+            application/json:
+              schema:
+                type: boolean
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/export_workflow/{id}:
+    get:
+      operationId: export_workflow
+      summary: Export a workflow
+      description: Returns the workflow file (`.yml`), or a package (`.wkf`) with its sub-workflows and remote nodes.
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Workflow ID or portable ID
+        - name: export_with_dependencies
+          in: query
+          schema:
+            type: string
+          description: Export a package with dependencies. Any non-empty value, including `false`, enables it.
+      responses:
+        '200':
+          description: The workflow file
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/list_by_subworkflow/{id}:
+    get:
+      operationId: list_by_subworkflow
+      summary: Published workflows that use a sub-workflow
+      tags:
+        - Workflows
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Sub-workflow ID (or query parameter `sub_wf_id`, which takes precedence)
+        - name: sub_wf_id
+          in: query
+          schema:
+            type: integer
+          description: Sub-workflow ID
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: IDs of the parent workflows
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  parent_workflows:
+                    type: array
+                    items:
+                      type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/retrieve_steps/{id}:
+    get:
+      operationId: retrieve_steps
+      summary: Steps of a type in published workflows, with their work orders
+      tags:
+        - Workflows
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: type
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Step type (plugin class name), e.g. `CustomRuby`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of steps
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    step_id:
+                      type: string
+                    step_name:
+                      type: string
+                    step_status:
+                      type: [string, 'null']
+                      description: Status of the first prerequisite of the step
+                    wf_id:
+                      type: string
+                    wo_id:
+                      type: integer
+                    wo_status:
+                      type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_orders_list/{id}:
+    get:
+      operationId: work_orders_list
+      summary: List work orders of a workflow
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Workflow ID, portable ID or name, or `all` for all workflows
+        - name: status
+          in: query
+          schema:
+            type: string
+          description: Filter by work order status, e.g. `Failed`
+        - name: priority
+          in: query
+          schema:
+            type: string
+          description: Filter by priority
+        - name: from_date
+          in: query
+          schema:
+            type: string
+          description: Work orders updated after this date, e.g. `'06-27-2015 02:40:59'`
+        - name: to_date
+          in: query
+          schema:
+            type: string
+          description: Work orders updated before this date
+        - name: tag
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated list of tags, all required
+        - name: max_results
+          in: query
+          schema:
+            type: integer
+          description: Maximum number of work orders
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of work orders
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  work_orders:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/WorkOrder'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_order_status/{id}:
+    get:
+      operationId: work_order_status
+      summary: Get work order status
+      description: |
+        Returns the status of a work order and its work steps.
+
+        If the work order includes sub-workflows, only the sub-workflow status is displayed, not the steps within the sub-workflow.
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work order ID
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Work order status
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  work_order:
+                    allOf:
+                      - $ref: '#/components/schemas/WorkOrder'
+                    properties:
+                      percent_complete:
+                        type: integer
+                        minimum: 0
+                        maximum: 100
+                  work_steps:
+                    type: array
+                    description: Steps with `step_id` greater than 0
+                    items:
+                      $ref: '#/components/schemas/WorkStepStatus'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_order_output/{id}:
+    get:
+      operationId: work_order_output
+      summary: Outputs of a work order
+      description: |
+        All outputs, the outputs of a step (`step_name`), or the outputs of a given name (`variable_name`).
+        With both `step_name` and `variable_name`, JSON returns the value only.
+        Format `text` (or `string`) returns the values, one per line.
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work order ID (or query parameter `workorder_id`, which takes precedence)
+        - name: workorder_id
+          in: query
+          schema:
+            type: integer
+          description: Work order ID
+        - name: step_name
+          in: query
+          schema:
+            type: string
+          description: Only the outputs of this step
+        - name: variable_name
+          in: query
+          schema:
+            type: string
+          description: Only the outputs with this name
+        - name: detailed
+          in: query
+          schema:
+            type: string
+            enum:
+              - 'true'
+              - 'false'
+          description: 'JSON: also the variable type, value type, work order ID and status of each output'
+        - name: format
+          in: query
+          schema:
+            type: string
+            enum:
+              - xml
+              - json
+              - text
+              - string
+            default: xml
+          description: Response format
+      responses:
+        '200':
+          description: Outputs
+          content:
+            application/json:
+              schema:
+                description: |
+                  - Without both `step_name` and `variable_name`: object `{"<step name>:<output name>": <value>}`
+                  - With `detailed=true`: array of `{"<step name>:<output name>": <value>, "variable_type", "value_type", "<work order name>:WorkOrder_ID", "<work order name>:WorkOrder_Status"}`
+                  - With both `step_name` and `variable_name`: the value only
+            text/plain:
+              schema:
+                type: string
+                description: Format `text` or `string`, one value per line
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_order_cancel/{id}:
+    get:
+      operationId: work_order_cancel
+      summary: Cancel a work order
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work order ID
+        - name: force
+          in: query
+          schema:
+            type: string
+          description: Force the cancellation (any value except `false`)
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The work order
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorkOrder'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_order_reset/{id}:
+    get:
+      operationId: work_order_reset
+      summary: Reset a work order
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work order ID
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The work order and its work steps
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorkOrderWithSteps'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/reset/{id}.{format}:
+    post:
+      operationId: reset
+      summary: Reset a work order (XML result)
+      description: Same as `work_order_reset`, implemented by the work order pages. The response is always XML.
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work order ID
+        - name: format
+          in: path
+          required: true
+          schema:
+            type: string
+            const: xml
+          description: Required by the route
+      responses:
+        '200':
+          description: The work order (XML)
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+  /api/work_order_destroy/{id}:
+    get:
+      operationId: work_order_destroy
+      summary: Delete a work order and its dependents
+      tags:
+        - Work Orders
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work order ID
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Confirmation message
+          content:
+            application/json:
+              schema:
+                type: string
+                examples:
+                  - " Work order '123' was deleted"
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/initiate:
+    post:
+      operationId: initiate
+      summary: Initiate a new work order
+      description: |
+        Starts a new work order for the specified workflow.
+
+        Runtime input values are passed under the `external_parameters` key.
+        To discover what parameters a workflow accepts, call `/api/workflow_inputs_spec/{workflow_id}` first.
+        With format `json`, the keys of a JSON body are also merged into the runtime parameters.
+      tags:
+        - Work Orders
+      parameters:
+        - $ref: '#/components/parameters/Format'
+        - name: synchronous
+          in: query
+          schema:
+            type: string
+            enum:
+              - 'true'
+              - 'false'
+          description: '`true`: wait for the end of the work order'
+        - name: timeout
+          in: query
+          schema:
+            type: integer
+            minimum: 0
+          description: 'With `synchronous`, maximum wait in seconds (0 or not set: no limit)'
+        - name: explicit_output
+          in: query
+          schema:
+            type: string
+          description: Return only this output, as `<step name>:<output name>`
+        - name: explicit_output_step
+          in: query
+          schema:
+            type: string
+          description: Return only an output of this step (with `explicit_output_variable`)
+        - name: explicit_output_variable
+          in: query
+          schema:
+            type: string
+          description: Name of the output to return (with `explicit_output_step`)
+        - name: on_error_return_code
+          in: query
+          schema:
+            type: integer
+          description: HTTP status to return when the work order ends with status `Error`
+        - name: on_failed_return_code
+          in: query
+          schema:
+            type: integer
+          description: HTTP status to return when the work order ends with status `Failed`
+        - name: tags
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated tags of the work order
+        - name: preemptive_level
+          in: query
+          schema:
+            type: integer
+          description: Priority of the work order (its opposite is used)
+        - name: wo_id_only
+          in: query
+          schema:
+            type: string
+            enum:
+              - 'true'
+              - 'false'
+          description: '`true`: return only the work order ID'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - workflow_id
+              properties:
+                workflow_id:
+                  type: string
+                  description: ID, portable ID or name of the workflow to execute
+                  examples:
+                    - '123'
+                external_parameters:
+                  type: object
+                  description: Runtime parameters of the workflow (name to value)
+                  additionalProperties: true
+      responses:
+        '200':
+          description: Work order initiated (or the status given by `on_error_return_code`, `on_failed_return_code`)
+          content:
+            application/json:
+              schema:
+                anyOf:
+                  - title: Work order
+                    allOf:
+                      - $ref: '#/components/schemas/WorkOrderWithSteps'
+                    properties:
+                      parameters:
+                        type: object
+                        description: Runtime parameters of the work order
+                  - title: Output value
+                    description: With `explicit_output`, or `explicit_output_step` and `explicit_output_variable`
+        '400':
+          description: Workflow not found or not published, or missing required parameters
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '#/components/schemas/Error'
+                  - title: Missing parameters
+                    type: object
+                    required:
+                      - work_order
+                      - missing_parameters
+                    properties:
+                      work_order:
+                        allOf:
+                          - $ref: '#/components/schemas/WorkOrder'
+                        properties:
+                          status:
+                            const: Not started
+                          status_details:
+                            const: Missing required parameters
+                      missing_parameters:
+                        type: array
+                        items:
+                          type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+  /api/work_step_status/{id}:
+    get:
+      operationId: work_step_status
+      summary: Status, inputs and outputs of a work step, or change its status
+      description: |
+        Returns the work step with its inputs and outputs,
+        or only the value of an output (`output_name`), or only the status (`status_only`, as plain text).
+        With `set_status` or `set_status_details`, modifies the work step and returns its new status.
+      tags:
+        - Work Steps
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Work step ID, or `work_order` to use `work_order_id` and `step_name`
+        - name: work_order_id
+          in: query
+          schema:
+            type: integer
+          description: Work order ID, when `id` is `work_order`
+        - name: step_name
+          in: query
+          schema:
+            type: string
+          description: Step name, when `id` is `work_order`
+        - name: output_name
+          in: query
+          schema:
+            type: string
+          description: Return only the value of this output
+        - name: status_only
+          in: query
+          schema:
+            type: string
+          description: Return only the status (any value except `false`)
+        - name: set_status
+          in: query
+          schema:
+            type: string
+          description: New status of the work step
+        - name: set_status_details
+          in: query
+          schema:
+            type: string
+          description: New status details of the work step
+        - name: set_percent_complete
+          in: query
+          schema:
+            type: integer
+            minimum: 0
+            maximum: 100
+          description: New percentage of completion, with `set_status` or `set_status_details`
+        - name: format
+          in: query
+          schema:
+            type: string
+            enum:
+              - xml
+              - json
+              - txt
+            default: xml
+          description: Response format (`txt` for a value or a status as plain text)
+      responses:
+        '200':
+          description: Work step status
+          content:
+            application/json:
+              schema:
+                anyOf:
+                  - title: Work step
+                    type: object
+                    properties:
+                      work_step:
+                        $ref: '#/components/schemas/WorkStep'
+                      outputs:
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/StepVariable'
+                      inputs:
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/StepVariable'
+                      carry_thrus:
+                        type: array
+                        description: Variables of other steps
+                        items:
+                          $ref: '#/components/schemas/StepVariable'
+                  - title: New status
+                    description: With `set_status` or `set_status_details`
+                    type: object
+                    properties:
+                      Work_step_id:
+                        type: integer
+                      Work_step_status:
+                        type: string
+                      Work_step_status_details:
+                        type: [string, 'null']
+                      Work_step_percent_complete:
+                        type: [integer, 'null']
+                  - title: Output value
+                    description: With `output_name`
+            text/plain:
+              schema:
+                type: string
+                description: 'Format `txt`: a value or a status. With `status_only`, the status is also plain text in format `json`.'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_step_cancel/{id}:
+    get:
+      operationId: work_step_cancel
+      summary: Cancel a work step
+      tags:
+        - Work Steps
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Work step ID
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The work step
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorkStep'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/workstep_reset/{id}:
+    get:
+      operationId: workstep_reset
+      summary: Restart work orders from work steps
+      tags:
+        - Work Steps
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: array
+            items:
+              type: integer
+          description: Work step ID, or comma-separated list of IDs
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The restarted work orders
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '#/components/schemas/WorkstepReset'
+                  - type: array
+                    description: For several work step IDs
+                    items:
+                      $ref: '#/components/schemas/WorkstepReset'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/queues_list:
+    get:
+      operationId: queues_list
+      summary: List all queues
+      tags:
+        - Queues
+      parameters:
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of queues
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  Queues:
+                    type: object
+                    properties:
+                      queue:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: integer
+                            name:
+                              type: string
+                            displayed_name:
+                              type: [string, 'null']
+                            update_at:
+                              type: string
+                              format: date-time
+                            created_at:
+                              type: string
+                              format: date-time
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/queued_items/{id}:
+    get:
+      operationId: queued_items
+      summary: Items of a queue
+      tags:
+        - Queues
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Queue name
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Queued items
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QueuedItems'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/queue_item/{id}:
+    get:
+      operationId: queue_item
+      summary: Add an item to a queue
+      tags:
+        - Queues
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Queue name
+        - name: queued_item
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Item to queue
+        - name: description
+          in: query
+          schema:
+            type: string
+          description: Description of the item
+        - name: priority
+          in: query
+          schema:
+            type: integer
+          description: Priority of the item
+        - name: weight
+          in: query
+          schema:
+            type: integer
+          description: Weight of the item
+        - name: tags
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated tags
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The queued item
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  item:
+                    description: The queued item
+                  description:
+                    type: string
+                  rank:
+                    type: integer
+                  priority:
+                    type: integer
+                  weight:
+                    type: integer
+                  id:
+                    type: integer
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/lookup_queued_item:
+    get:
+      operationId: lookup_queued_item
+      summary: Find queued items
+      description: By item ID, by item (optionally in a queue), or by description (optionally in a queue). Same response as `queued_items`.
+      tags:
+        - Queues
+      parameters:
+        - name: queued_item_id
+          in: query
+          schema:
+            type: integer
+          description: ID of the queued item
+        - name: queued_item
+          in: query
+          schema:
+            type: string
+          description: Queued item
+        - name: queue_desc
+          in: query
+          schema:
+            type: string
+          description: Description of the queued item
+        - name: queue_name
+          in: query
+          schema:
+            type: string
+          description: Queue name, to restrict the search by `queued_item` or `queue_desc`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Queued items found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QueuedItems'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/reorder_queued_item:
+    get:
+      operationId: reorder_queued_item
+      summary: Move a queued item
+      tags:
+        - Queues
+      parameters:
+        - name: operation
+          in: query
+          required: true
+          schema:
+            type: string
+            enum:
+              - up
+              - down
+              - first
+              - last
+          description: Move
+        - name: queued_item_id
+          in: query
+          schema:
+            type: integer
+          description: ID of the queued item
+        - name: queued_item
+          in: query
+          schema:
+            type: string
+          description: Queued item, when `queued_item_id` is not given
+        - name: queue_name
+          in: query
+          schema:
+            type: string
+          description: Queue name, to find `queued_item`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The moved item
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QueuedItems'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/bulk_reorder_queue:
+    get:
+      operationId: bulk_reorder_queue
+      summary: Move several queued items
+      tags:
+        - Queues
+      parameters:
+        - name: queued_item_ids
+          in: query
+          style: form
+          explode: false
+          required: true
+          schema:
+            type: array
+            items:
+              type: integer
+          description: Comma-separated IDs of queued items
+        - name: operation
+          in: query
+          required: true
+          schema:
+            type: string
+            enum:
+              - up
+              - down
+              - first
+              - last
+          description: Move
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The moved items
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  queued_items:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        queued_item:
+                          $ref: '#/components/schemas/QueuedItem'
+                        queue_data:
+                          $ref: '#/components/schemas/QueueMetadata'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/delete_queued_item:
+    get:
+      operationId: delete_queued_item
+      summary: Delete a queued item
+      tags:
+        - Queues
+      parameters:
+        - name: queue_name
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Queue name
+        - name: queued_item_id
+          in: query
+          required: true
+          schema:
+            type: integer
+          description: ID of the queued item
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Confirmation message
+          content:
+            application/json:
+              schema:
+                type: string
+                description: Plain text, not JSON-encoded, although the content type is `application/json`
+                examples:
+                  - Item with id 21 was succesfully deleted.
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/monitor_snapshot:
+    get:
+      operationId: monitor_snapshot
+      summary: Status of the monitors
+      tags:
+        - Monitors
+      parameters:
+        - name: id
+          in: query
+          schema:
+            type: string
+            enum:
+              - workflows
+              - workorders
+              - folders
+              - nodes
+              - scripts
+          description: 'Only monitors of this type (also in the path `/api/monitor_snapshot/<type>`). Not set: all.'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Monitor snapshot data
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  monitor:
+                    type: object
+                    properties:
+                      monitor_workflows:
+                        type: object
+                        description: Empty when there is no monitor
+                        properties:
+                          monitor_workflow:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: integer
+                                workflow_id:
+                                  type: integer
+                                workflow_name:
+                                  type: string
+                                last_activity:
+                                  description: Only when active
+                                active:
+                                  type: boolean
+                                status:
+                                  type: string
+                                status_report:
+                                  description: Only when active
+                                last_polled:
+                                  description: Only when active
+                      monitor_workorders:
+                        type: object
+                        description: Empty when there is no monitor
+                        properties:
+                          monitor_workorder:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: integer
+                                workflow_id:
+                                  type: integer
+                                workflow_name:
+                                  type: string
+                                last_activity:
+                                  description: Only when active
+                                active:
+                                  type: boolean
+                                status:
+                                  type: string
+                                status_report:
+                                  description: Only when active
+                                last_polled:
+                                  description: Only when active
+                      monitor_folders:
+                        type: object
+                        description: Empty when there is no monitor
+                        properties:
+                          monitor_folder:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: integer
+                                folder:
+                                  type: string
+                                  description: Description of the monitor
+                                path:
+                                  type: string
+                                content:
+                                  description: Only when active
+                                age_range:
+                                  description: Only when active
+                                active:
+                                  type: boolean
+                                status:
+                                  type: string
+                                status_report:
+                                  description: Only when active
+                                last_polled:
+                                  description: Only when active
+                      monitor_nodes:
+                        type: object
+                        description: Empty when there is no monitor
+                        properties:
+                          monitor_node:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: integer
+                                name:
+                                  type: string
+                                remote_node:
+                                  type: string
+                                active:
+                                  type: boolean
+                                status:
+                                  type: string
+                                status_report:
+                                  description: Only when active
+                                last_polled:
+                                  description: Only when active
+                      monitor_scripts:
+                        type: object
+                        description: Empty when there is no monitor
+                        properties:
+                          monitor_script:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: integer
+                                script:
+                                  type: string
+                                  description: Description of the monitor
+                                node:
+                                  type: string
+                                path:
+                                  type: string
+                                active:
+                                  type: boolean
+                                status:
+                                  type: string
+                                status_report:
+                                  description: Only when active
+                                last_polled:
+                                  description: Only when active
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/list_monitors/{id}:
+    get:
+      operationId: list_monitors
+      summary: List the monitors of a type
+      tags:
+        - Monitors
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - $ref: '#/components/parameters/MonitorType'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of monitors
+          content:
+            application/json:
+              schema:
+                type: array
+                description: All the attributes of the monitors. For type `workorder`, each monitor is in an object with key `monitor-workorder`. Remote node monitors give the names of the monitored remote nodes (`remote_node_name`).
+                items:
+                  type: object
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/activate_monitor/{id}:
+    get:
+      operationId: activate_monitor
+      summary: Activate a monitor
+      tags:
+        - Monitors
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Monitor ID or portable ID
+        - name: portable_id
+          in: query
+          schema:
+            type: string
+          description: Portable ID of the monitor, used when the `id` segment is empty
+        - $ref: '#/components/parameters/MonitorType'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Monitor activated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MonitorChange'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/deactivate_monitor/{id}:
+    get:
+      operationId: deactivate_monitor
+      summary: Deactivate a monitor
+      tags:
+        - Monitors
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Monitor ID or portable ID
+        - name: portable_id
+          in: query
+          schema:
+            type: string
+          description: Portable ID of the monitor, used when the `id` segment is empty
+        - $ref: '#/components/parameters/MonitorType'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Monitor deactivated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MonitorChange'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/list_tasks/{id}:
+    get:
+      operationId: list_tasks
+      summary: Tasks (user inputs) waiting for a user
+      tags:
+        - Tasks
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: User login or ID, or `self`. Only an administrator can list the tasks of another user.
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of tasks
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  user:
+                    type: string
+                    description: Login of the user
+                  tasks:
+                    type: array
+                    items:
+                      allOf:
+                        - $ref: '#/components/schemas/Task'
+                      properties:
+                        event:
+                          type: string
+                        group:
+                          type: string
+                          description: Group the task is assigned to
+                        user:
+                          type: string
+                          description: User the task is assigned to
+                        requested_user_inputs:
+                          type: array
+                          items:
+                            type: object
+                            properties:
+                              name:
+                                type: string
+                              required:
+                                type: boolean
+                              value_type:
+                                type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/task_details/{id}:
+    get:
+      operationId: task_details
+      summary: Details of a task
+      tags:
+        - Tasks
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+            pattern: ^(WO)?[0-9]+$
+          description: Task ID, or `WO<work order ID>` for the user input of a work order
+        - name: step_name
+          in: query
+          schema:
+            type: string
+          description: 'With `WO<id>`, step of the user input when the work order has several. Orchestrator 4.1.6 checks that `Step_name` is set and compares `step_name`: give both.'
+        - name: Step_name
+          in: query
+          schema:
+            type: string
+          description: Same value as `step_name` (see `step_name`)
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Task details
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  task:
+                    $ref: '#/components/schemas/Task'
+                  task_inputs:
+                    type: object
+                    description: Parameters received by the task (name to value)
+                  user_inputs:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/UserInput'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/submit_task/{id}:
+    get:
+      operationId: submit_task
+      summary: Complete a task with the user inputs
+      tags:
+        - Tasks
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: Task ID
+        - name: outputs
+          in: query
+          style: deepObject
+          explode: true
+          schema:
+            type: object
+            additionalProperties: true
+          description: Values of the user inputs, e.g. `outputs[Filename]=tron.avi`. All required inputs must be given.
+        - name: input_provider
+          in: query
+          schema:
+            type: string
+          description: Login of the user who provides the inputs (administrator only)
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The completed task
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  task:
+                    $ref: '#/components/schemas/Task'
+                  user_inputs:
+                    type: object
+                    description: Values of the user inputs (name to value)
+                  input_provider:
+                    type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/search_tasks/{id}:
+    get:
+      operationId: search_tasks
+      summary: Search the tasks of the current user
+      tags:
+        - Tasks
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: value
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Search key
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Tasks found
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  anyOf:
+                    - title: Task
+                      type: object
+                      properties:
+                        id:
+                          type: integer
+                        task:
+                          $ref: '#/components/schemas/Task'
+                        task_inputs:
+                          type: object
+                          description: Parameters received by the task (name to value)
+                        user_inputs:
+                          type: array
+                          items:
+                            $ref: '#/components/schemas/UserInput'
+                    - title: Task without access
+                      type: object
+                      properties:
+                        id:
+                          type: integer
+                        error:
+                          type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/plugin_version:
+    get:
+      operationId: plugin_version
+      summary: Versions of the plugins
+      tags:
+        - Plugins
+      parameters:
+        - name: id
+          in: query
+          schema:
+            type: string
+          description: Only this plugin (action type), e.g. `ascp client` (also in the path `/api/plugin_version/<name>`)
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Plugin versions
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  Plugin:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        name:
+                          type: string
+                        version:
+                          type: string
+                          examples:
+                            - 1.2.3
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/reload_plugin:
+    get:
+      operationId: reload_plugin
+      summary: Reload a plugin, or all enabled plugins
+      tags:
+        - Plugins
+      parameters:
+        - name: action_type
+          in: query
+          schema:
+            type: string
+          description: 'Plugin class name, e.g. `Adi3Parser`. Not set: all enabled plugins.'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Reload status of each plugin
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PluginReloadStatus'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/reload_plugin_set:
+    post:
+      operationId: reload_plugin_set
+      summary: Reload a set of plugins
+      description: 'With format `json`, the body is `{"plugin_set": [...]}`; with format `xml`, `<plugin_set><action_type>...</action_type>...</plugin_set>`.'
+      tags:
+        - Plugins
+      parameters:
+        - $ref: '#/components/parameters/Format'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - plugin_set
+              properties:
+                plugin_set:
+                  type: array
+                  description: Plugin class names
+                  items:
+                    type: string
+                  examples:
+                    - - Adi3Parser
+                      - AdiParser
+          application/xml:
+            schema:
+              type: string
+              examples:
+                - <plugin_set><action_type>Adi3Parser</action_type></plugin_set>
+      responses:
+        '200':
+          description: Reload status of each plugin
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PluginReloadStatus'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/enable_plugin/{id}:
+    get:
+      operationId: enable_plugin
+      summary: Enable a plugin, or all plugins
+      tags:
+        - Plugins
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: action_type
+          in: query
+          schema:
+            type: string
+          description: 'Plugin class name. Not set: all plugins.'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Installation ID
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  install_id:
+                    type: integer
+                    description: '`0` for all plugins'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/import_plugin/{id}:
+    get:
+      operationId: import_plugin
+      summary: Import a plugin from a file on the Orchestrator host
+      tags:
+        - Plugins
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: file
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Path of the plugin archive on the Orchestrator host
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Class name of the imported plugin
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  action_type:
+                    type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/portlet_version:
+    get:
+      operationId: portlet_version
+      summary: Versions of the portlets
+      tags:
+        - Portlets
+      parameters:
+        - name: id
+          in: query
+          schema:
+            type: string
+          description: Only this portlet (name), also in the path `/api/portlet_version/<name>`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Portlet versions
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  Portlet:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        name:
+                          type: string
+                        version:
+                          type: string
+                          examples:
+                            - 1.2.3
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/processes_status:
+    get:
+      operationId: processes_status
+      summary: Status of the processes (engine, monitor, workers)
+      tags:
+        - System
+      parameters:
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Process status information
+          content:
+            application/json:
+              schema:
+                type: object
+                description: Conversion of the XML, so all values are strings
+                properties:
+                  processes:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                      action:
+                        type: string
+                        const: status
+                      engine_id:
+                        type: string
+                      node:
+                        description: A node, or a list when there are several
+                        oneOf:
+                          - $ref: '#/components/schemas/ProcessNode'
+                          - type: array
+                            items:
+                              $ref: '#/components/schemas/ProcessNode'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/control_process/{id}:
+    get:
+      operationId: control_process
+      summary: Start, stop or kill a process
+      description: Returns the status of the processes (in XML, the same as `processes_status`).
+      tags:
+        - System
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+            enum:
+              - engine
+              - monitor
+              - worker
+          description: Process type
+        - name: command
+          in: query
+          required: true
+          schema:
+            type: string
+            enum:
+              - start
+              - stop
+              - kill
+              - status
+          description: Command (`status` does nothing but returns the status)
+        - name: worker_id
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: integer
+          description: Comma-separated worker IDs, required for type `worker`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Status of the processes
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  processes:
+                    type: object
+                    properties:
+                      time:
+                        type: string
+                      action:
+                        type: string
+                        const: status
+                      engine_id:
+                        type: integer
+                      process:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            class:
+                              type: string
+                              enum:
+                                - engine
+                                - monitor
+                                - node_mesh
+                                - worker
+                            id:
+                              type: integer
+                              description: Worker ID
+                            pid:
+                              type: [integer, string]
+                              description: '`-` when not running'
+                            status:
+                              type: string
+                              enum:
+                                - running
+                                - not running
+                            type:
+                              type: string
+                              description: Worker type
+                              enum:
+                                - normal
+                                - asynchronous
+                                - dedicated
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/custom_api_call:
+    get:
+      operationId: custom_api_call
+      summary: Store data in the shared state, for a database trigger
+      description: The query parameters and the request body are stored in table `SharedState`, where a workflow can watch them with a database trigger. The response is always XML.
+      tags:
+        - System
+      parameters:
+        - name: identifier
+          in: query
+          schema:
+            type: string
+          description: 'Aggregate type of the shared state (default: `custom_api_call`)'
+        - name: uniq_id
+          in: query
+          required: true
+          schema:
+            type: integer
+          description: Aggregate ID of the shared state, an integer
+        - name: object
+          in: query
+          schema:
+            type: string
+          description: JSON text of the object to store
+      responses:
+        '200':
+          description: ID of the shared state (XML)
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/execution_queue_stats/{id}:
+    get:
+      operationId: execution_queue_stats
+      summary: Statistics of the execution queue of the engine
+      tags:
+        - System
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Queue statistics
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  next_polling_due:
+                    type: [integer, string]
+                    description: Seconds until the next polling, or `-`
+                  completed_items:
+                    type: integer
+                  unassigned_items:
+                    type: integer
+                  error_items:
+                    type: integer
+                  inprogress_synch_count:
+                    type: integer
+                  inprogress_asynch_count:
+                    type: integer
+                  created:
+                    type: integer
+                    description: Number of work orders with this status
+                  ready:
+                    type: integer
+                  initializing:
+                    type: integer
+                  initialized:
+                    type: integer
+                  in_progress:
+                    type: integer
+                  paused:
+                    type: integer
+                  time_executed:
+                    type: string
+                  engine_id:
+                    type: integer
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/alerts/{id}:
+    get:
+      operationId: alerts
+      summary: Alerts of the categories the user is subscribed to
+      tags:
+        - System
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: count_only
+          in: query
+          schema:
+            type: string
+            enum:
+              - 'true'
+              - 'false'
+          description: 'Return only the number of alerts: `{"count"}`'
+        - name: category
+          in: query
+          schema:
+            type: string
+          description: Only alerts of this category, e.g. `user`
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: List of alerts, or their number
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - title: Count
+                    description: With `count_only=true`
+                    type: object
+                    properties:
+                      count:
+                        type: integer
+                  - type: array
+                    items:
+                      $ref: '#/components/schemas/AlertNotification'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/remote_node_ping:
+    get:
+      operationId: remote_node_ping
+      summary: Version and platform of this Orchestrator
+      tags:
+        - Remote Nodes
+      parameters:
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Orchestrator information
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  remote_orchestrator_info:
+                    type: object
+                    properties:
+                      orchestrator-version:
+                        type: string
+                      platform:
+                        type: string
+                      engine_id:
+                        type: integer
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/test_step/{id}:
+    get:
+      operationId: test_step
+      summary: Launch test cases for a workflow step
+      description: |
+        Launches test cases against a workflow and returns a **Test_run_id** UUID.
+        Pass that UUID to `/api/test_step_status` to poll for results.
+      tags:
+        - Testing
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Workflow ID or portable ID to test
+          example: my_workflow
+        - name: step
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated step name(s) to test. Omit to test all steps.
+          example:
+            - Get file size
+        - name: case
+          in: query
+          schema:
+            type: string
+          description: Test case name to run. Omit to run all cases for the step.
+          example: File doesnt exist
+        - name: synchronous
+          in: query
+          schema:
+            type: string
+            enum:
+              - 'true'
+              - 'false'
+          description: '`true`: wait for all test cases to complete before returning'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Test run launched. Response contains `Test_run_id` UUID to use with `/api/test_step_status`.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TestRun'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+        '404':
+          description: Workflow not found
+  /api/test_step_status/{id}:
+    get:
+      operationId: test_step_status
+      summary: Get test step status
+      description: |
+        Poll the status of a test run previously launched by `/api/test_step`.
+        The `id` parameter must be the **Test_run_id UUID** returned by that call, not a numeric workflow or step ID.
+      tags:
+        - Testing
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+            format: uuid
+          description: Test run UUID returned by /api/test_step (e.g. 935e0080-97f5-0135-26f8-34363bc6aedc)
+          example: 935e0080-97f5-0135-26f8-34363bc6aedc
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Test status
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TestRun'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_order_stats/{id}:
+    get:
+      operationId: work_order_stats
+      summary: Work order statistics, monthly or for a day
+      description: Returns the text `No Statistics found. Change the filter and try again.` when there is none.
+      tags:
+        - Statistics
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: workflow_id
+          in: query
+          schema:
+            type: integer
+          description: Only this workflow
+        - name: label
+          in: query
+          schema:
+            type: string
+          description: Only work orders with this label
+        - name: date
+          in: query
+          schema:
+            type: string
+            format: date
+          description: 'Statistics of this day, e.g. `2017-04-04`. Not set: monthly statistics.'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Work order statistics
+          content:
+            application/json:
+              schema:
+                type: array
+                description: By day (monthly statistics of the last 30 days), or by hour (statistics of a day). The sums are decimal strings.
+                items:
+                  type: object
+                  properties:
+                    Date:
+                      type: string
+                    Last_hour:
+                      type: string
+                      format: date-time
+                    Complete_Work_Orders:
+                      type: [string, integer]
+                    Failed_Work_Orders:
+                      type: [string, integer]
+                    Errored_Work_Orders:
+                      type: [string, integer]
+                    Canceled_Work_Orders:
+                      type: [string, integer]
+                    Rolled_Back_Work_Orders:
+                      type: [string, integer]
+                    Destroyed_Work_Orders:
+                      type: [string, integer]
+                    Cleared_Work_Orders:
+                      type: [string, integer]
+                    Flagged_Work_Orders:
+                      type: [string, integer]
+                    Initializing_Work_Orders:
+                      type: [string, integer]
+                    Initialized_Work_Orders:
+                      type: [string, integer]
+                    Created_Work_Orders:
+                      type: [string, integer]
+                    Ready_Work_Orders:
+                      type: [string, integer]
+                    In_Progress_Work_Orders:
+                      type: [string, integer]
+                    Unknown_Work_Orders:
+                      type: [string, integer]
+            text/plain:
+              schema:
+                type: string
+                const: No Statistics found. Change the filter and try again.
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/work_step_stats/{id}:
+    get:
+      operationId: work_step_stats
+      summary: Work step statistics, monthly or for a day
+      description: 'Returns the text `No Statistics found. Change the filter and try again.` when there is none. The filters are inserted as is in an SQL condition (`workflow_id in (...)`): give comma-separated numbers or quoted values.'
+      tags:
+        - Statistics
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: workflow_id
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: integer
+          description: Comma-separated workflow IDs
+        - name: step_id
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: integer
+          description: Comma-separated step IDs
+        - name: step_type
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated step types, quoted (e.g. `'CustomRuby'`)
+        - name: date
+          in: query
+          schema:
+            type: string
+            format: date
+          description: 'Statistics of this day, e.g. `2017-04-04`. Not set: monthly statistics.'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Work step statistics
+          content:
+            application/json:
+              schema:
+                type: array
+                description: By day (monthly statistics of the last 30 days), or by hour (statistics of a day). The sums are decimal strings.
+                items:
+                  type: object
+                  properties:
+                    Date:
+                      type: string
+                    Last_hour:
+                      type: string
+                      format: date-time
+                    Completed_Steps:
+                      type: [string, integer]
+                    Failed_Steps:
+                      type: [string, integer]
+                    Errored_steps:
+                      type: [string, integer]
+                    Obsolete_Steps:
+                      type: [string, integer]
+                    Activating_Steps:
+                      type: [string, integer]
+                    In_Progress_Steps:
+                      type: [string, integer]
+                    Paused_Steps:
+                      type: [string, integer]
+                    Pausing_Steps:
+                      type: [string, integer]
+                    Canceling_Steps:
+                      type: [string, integer]
+                    Resuming_Steps:
+                      type: [string, integer]
+                    Rolling_Back_Steps:
+                      type: [string, integer]
+                    Undefined_Steps:
+                      type: [string, integer]
+            text/plain:
+              schema:
+                type: string
+                const: No Statistics found. Change the filter and try again.
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/journal_files/{id}:
+    get:
+      operationId: journal_files
+      summary: Files recorded in a journal book
+      tags:
+        - Journals
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Journal book name or ID
+        - name: details
+          in: query
+          schema:
+            type: string
+            enum:
+              - 'true'
+              - 'false'
+          description: '`false`: without the states (steps) of each file'
+        - name: status
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated statuses, e.g. `In Progress,Processing complete`
+        - name: file
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated file paths
+        - name: package
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated package names (not with `package_id`)
+        - name: package_id
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: integer
+          description: Comma-separated package IDs (not with `package`)
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Journal entries
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  Journal:
+                    type: object
+                    properties:
+                      name:
+                        type: string
+                      id:
+                        type: integer
+                      description:
+                        type: [string, 'null']
+                      active:
+                        type: [boolean, 'null']
+                  Packages:
+                    type: array
+                    description: Only when the journal has packages
+                    items:
+                      type: object
+                      properties:
+                        name:
+                          type: string
+                        id:
+                          type: integer
+                        files:
+                          type: array
+                          items:
+                            $ref: '#/components/schemas/JournalFile'
+                  Files:
+                    type: array
+                    description: Files without package
+                    items:
+                      $ref: '#/components/schemas/JournalFile'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/add_resource/{id}:
+    get:
+      operationId: add_resource
+      summary: Add a resource to a resource pool
+      tags:
+        - Resources
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - $ref: '#/components/parameters/PoolName'
+        - $ref: '#/components/parameters/ResourceName'
+        - name: capacity
+          in: query
+          schema:
+            type: integer
+            default: 1
+          description: Capacity of the resource
+        - name: tags
+          in: query
+          style: form
+          explode: false
+          schema:
+            type: array
+            items:
+              type: string
+          description: Comma-separated tags
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The new resource
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ManagedResource:
+                    $ref: '#/components/schemas/ManagedResource'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/edit_resource_capacity/{id}:
+    get:
+      operationId: edit_resource_capacity
+      summary: Change the capacity of a resource
+      tags:
+        - Resources
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+            minimum: 1
+          description: New capacity, a positive integer
+        - $ref: '#/components/parameters/PoolName'
+        - $ref: '#/components/parameters/ResourceName'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The resource
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ManagedResource:
+                    $ref: '#/components/schemas/ManagedResource'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/edit_pool_capacity/{id}:
+    get:
+      operationId: edit_pool_capacity
+      summary: Change the capacity of a resource pool
+      tags:
+        - Resources
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+            minimum: 1
+          description: New capacity, a positive integer
+        - $ref: '#/components/parameters/PoolName'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The resources of the pool
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ManagedResource:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ManagedResource'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/resource_online/{id}:
+    get:
+      operationId: resource_online
+      summary: Take a resource online
+      tags:
+        - Resources
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - $ref: '#/components/parameters/PoolName'
+        - $ref: '#/components/parameters/ResourceName'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The resource is online
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ManagedResource:
+                    type: object
+                    description: Resource ID (with `>` replaced by `-`) to new status
+                    additionalProperties:
+                      const: Online
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/resource_offline/{id}:
+    get:
+      operationId: resource_offline
+      summary: Take a resource offline
+      tags:
+        - Resources
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - $ref: '#/components/parameters/PoolName'
+        - $ref: '#/components/parameters/ResourceName'
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: The resource is offline
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ManagedResource:
+                    type: object
+                    description: Resource ID (with `>` replaced by `-`) to new status
+                    additionalProperties:
+                      const: Offline
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/pool_status/{id}:
+    get:
+      operationId: pool_status
+      summary: Resources of a resource pool and their status
+      tags:
+        - Resources
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - name: name
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Name of the resource pool (with or without the suffix `__a` of the database)
+        - $ref: '#/components/parameters/Format'
+      responses:
+        '200':
+          description: Pool status
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ManagedResource:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          description: Resource name
+                        taken:
+                          type: integer
+                        capacity:
+                          type: integer
+                        status:
+                          type: string
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+  /api/create_user/{id}:
+    post:
+      operationId: create_user
+      summary: Create a user
+      description: The response is JSON unless format is `xml`.
+      tags:
+        - Users
+      parameters:
+        - $ref: '#/components/parameters/AnyId'
+        - $ref: '#/components/parameters/Format'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - login
+                - password
+                - email
+              properties:
+                login:
+                  type: string
+                  description: Login of the user
+                password:
+                  type: string
+                  format: password
+                first_name:
+                  type: string
+                last_name:
+                  type: string
+                email:
+                  type: string
+                  format: email
+                  description: Email of the user, unique
+                phone:
+                  type: string
+                SMS:
+                  type: string
+                is_active:
+                  type: boolean
+                  default: false
+                require_password_change_on_login:
+                  type: boolean
+                  default: false
+                alternate_emails:
+                  type: array
+                  items:
+                    type: string
+                    format: email
+                groups:
+                  type: array
+                  description: Names of existing groups
+                  items:
+                    type: string
+      responses:
+        '200':
+          description: Confirmation message
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  create_user:
+                    type: object
+                    properties:
+                      success:
+                        type: string
+                        examples:
+                          - User 'jdoe' was successfully created.
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        default:
+          $ref: '#/components/responses/Error'
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: JWT token obtained from /api/login endpoint
+    basicAuth:
+      type: http
+      scheme: basic
+      description: Login and password, when JWT authentication is disabled
+    loginQuery:
+      type: apiKey
+      in: query
+      name: login
+      description: User login, with `password` or `api_key`, when JWT authentication is disabled
+    passwordQuery:
+      type: apiKey
+      in: query
+      name: password
+      description: User password, when JWT authentication is disabled
+    apiKeyQuery:
+      type: apiKey
+      in: query
+      name: api_key
+      description: API key of the user, when JWT authentication is disabled
+  parameters:
+    Format:
+      name: format
+      in: query
+      schema:
+        type: string
+        enum:
+          - xml
+          - json
+        default: xml
+      description: Response format (also given by the extension `.json` or `.xml` of the path)
+    AnyId:
+      name: id
+      in: path
+      required: true
+      schema:
+        type: string
+        default: '0'
+      description: Not used by the endpoint, but required by the route (any value, e.g. `0`)
+    MonitorType:
+      name: monitor_type
+      in: query
+      required: true
+      schema:
+        type: string
+        enum:
+          - workflow
+          - workorder
+          - folder
+          - node
+          - script
+      description: Type of monitor (also accepted `work_order`, `remotenode`, `remote_node`, `remotescript`, `remote_script`)
+    PoolName:
+      name: pool_name
+      in: query
+      required: true
+      schema:
+        type: string
+      description: Name of the resource pool
+    ResourceName:
+      name: resource_name
+      in: query
+      required: true
+      schema:
+        type: string
+      description: Name of the resource, e.g. an IP address
+  schemas:
+    Error:
+      type: object
+      description: 'Error of an API call in format `json`. In format `xml`: `<error time="..." action="..." id="...">message</error>`.'
+      required:
+        - error
+      properties:
+        error:
+          type: object
+          required:
+            - action
+            - time
+            - id
+            - description
+          properties:
+            action:
+              type: string
+              description: Called endpoint
+            time:
+              type: string
+              description: UTC time
+              examples:
+                - '2026-10-21 08:30:00'
+            id:
+              type: string
+              description: The `id` of the call, or `0`
+            description:
+              type: string
+              description: Error message and backtrace
+    Workflow:
+      type: object
+      description: Workflow (database record)
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        portable_id:
+          type: [string, 'null']
+        created_by:
+          type: [integer, 'null']
+          description: User ID
+        folder_id:
+          type: [integer, 'null']
+        generated_from:
+          type: [integer, 'null']
+          description: Published whiteboard, `null` for a draft
+        revision_id:
+          type: [integer, 'null']
+          description: Published revision
+        label:
+          type: [string, 'null']
+        run_as:
+          type: [string, 'null']
+        source_revision:
+          type: [string, 'null']
+        comments:
+          type: [string, 'null']
+        description:
+          type: [string, 'null']
+        tags:
+          type: [string, 'null']
+        templates:
+          type: [string, 'null']
+        max_running:
+          type: [integer, 'null']
+        cleanup_after_days:
+          type: [integer, 'null']
+        purge_after_days:
+          type: [integer, 'null']
+        user_lock:
+          type: [boolean, 'null']
+        locked_by:
+          type: [integer, 'null']
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    WorkOrder:
+      type: object
+      description: Work order (database record)
+      properties:
+        id:
+          type: integer
+        name:
+          type: [string, 'null']
+        monitor_id:
+          type: [integer, 'null']
+        workflow_id:
+          type: [integer, 'null']
+        workflow_revision_id:
+          type: [integer, 'null']
+        workflow_name:
+          type: [string, 'null']
+        branched_from_order:
+          type: [integer, 'null']
+          description: Parent work order, for a sub-workflow
+        branched_from:
+          type: [integer, 'null']
+          description: Parent work step, for a sub-workflow
+        forked_at:
+          type: [integer, 'null']
+        derived_from:
+          type: [integer, 'null']
+        master_id:
+          type: [integer, 'null']
+        launched_by:
+          type: [integer, 'null']
+          description: User ID
+        initiated_by:
+          type: [integer, 'null']
+          description: User ID
+        running_as:
+          type: [integer, 'null']
+        priority:
+          type: [integer, 'null']
+        exec_priority:
+          type: [number, 'null']
+        higher_priority:
+          type: [boolean, 'null']
+        label:
+          type: [string, 'null']
+        status:
+          type: [string, 'null']
+          examples:
+            - In Progress
+        status_details:
+          type: [string, 'null']
+        comments:
+          type: [string, 'null']
+        tags:
+          type: [string, 'null']
+          description: Tags separated by `|`, e.g. `|tag1|tag2|`
+        initiate_date:
+          type: [string, 'null']
+          format: date-time
+        completion_date:
+          type: [string, 'null']
+          format: date-time
+        max_running:
+          type: [integer, 'null']
+        cleanup_after_days:
+          type: [integer, 'null']
+        purge_after_days:
+          type: [integer, 'null']
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    WorkStepBase:
+      type: object
+      description: Work step (database record), common columns
+      properties:
+        id:
+          type: integer
+        action_id:
+          type: [integer, 'null']
+        step_id:
+          type: [integer, 'null']
+        step_type:
+          type: [string, 'null']
+          description: Plugin class name, e.g. `CustomRuby`
+        step_name:
+          type: [string, 'null']
+        work_step_name:
+          type: [string, 'null']
+        attempt:
+          type: [integer, 'null']
+        execution_timeout:
+          type: [integer, 'null']
+        group:
+          type: [integer, 'null']
+        percent_complete:
+          type: [integer, 'null']
+        rank:
+          type: [integer, 'null']
+        running_as:
+          type: [integer, 'null']
+        synch_filter:
+          type: [integer, 'null']
+        timeout:
+          type: [integer, 'null']
+        weight:
+          type: [integer, 'null']
+        activation_time:
+          type: [number, 'null']
+        on_timeout:
+          type: [string, 'null']
+        status:
+          type: [string, 'null']
+        status_details:
+          type: [string, 'null']
+        prerequisites:
+          type: [string, 'null']
+        episteps:
+          type: [string, 'null']
+        journaling:
+          type: [string, 'null']
+        work_inputs:
+          type: [string, 'null']
+        work_outputs:
+          type: [string, 'null']
+        activable_date:
+          type: [string, 'null']
+          format: date-time
+        activation_date:
+          type: [string, 'null']
+          format: date-time
+        original_activation_date:
+          type: [string, 'null']
+          format: date-time
+        completion_date:
+          type: [string, 'null']
+          format: date-time
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    WorkStep:
+      description: Work step (database record)
+      allOf:
+        - $ref: '#/components/schemas/WorkStepBase'
+      properties:
+        work_order_id:
+          type: [integer, 'null']
+        workflow_id:
+          type: [integer, 'null']
+        pre_processing:
+          type: [string, 'null']
+        post_processing:
+          type: [string, 'null']
+    WorkStepStatus:
+      description: Work step in `work_order_status`, without `workflow_id`, `pre_processing` and `post_processing`
+      allOf:
+        - $ref: '#/components/schemas/WorkStepBase'
+      properties:
+        percent_complete:
+          type: integer
+          description: 0 for a running step, 100 for a finished step, when not set
+        category:
+          type: string
+          description: Category of the plugin, e.g. `Basic/Ruby`, or `-`
+        work_order_id:
+          type: [integer, string]
+          description: 'Only for steps of type `SubWorkflow`, `WorkflowLauncher` and `FederatedWorkflow`: the launched work order, or `-`'
+        node_id:
+          type: string
+          description: 'Only for `FederatedWorkflow`: execution node, or `-`'
+        address:
+          type: string
+          description: 'Only for `FederatedWorkflow`: execution address, or `-`'
+    WorkOrderWithSteps:
+      type: object
+      properties:
+        work_order:
+          $ref: '#/components/schemas/WorkOrder'
+        work_steps:
+          type: array
+          items:
+            $ref: '#/components/schemas/WorkStep'
+    WorkstepReset:
+      allOf:
+        - $ref: '#/components/schemas/WorkOrderWithSteps'
+      properties:
+        workstep_reset:
+          const: true
+    StepVariable:
+      type: object
+      description: Input or output of a work step
+      properties:
+        value:
+          description: Value, of any type
+        name:
+          type: string
+        id:
+          type: integer
+        type:
+          type: string
+          description: Value type
+    QueuedItem:
+      type: object
+      description: Item of a queue (database record, without the columns of the queue)
+      properties:
+        id:
+          type: integer
+        queued_item:
+          description: The queued item
+        item_description:
+          type: [string, 'null']
+        priority:
+          type: [integer, 'null']
+        weight:
+          type: [integer, 'null']
+        position:
+          type: [integer, 'null']
+        rank:
+          type: [integer, 'null']
+          description: Position in the queue, from 0
+        originator_type:
+          type: [string, 'null']
+        originator_id:
+          type: [integer, 'null']
+        tags:
+          type: [string, 'null']
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    QueueMetadata:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Queue name given in the call (`queued_items` only)
+        name:
+          type: string
+          description: Displayed name of the queue
+        comments:
+          type: [string, 'null']
+        administrators:
+          type: object
+          properties:
+            groups:
+              type: array
+              items:
+                type: integer
+            users:
+              type: array
+              items:
+                type: integer
+        paused:
+          type: [boolean, 'null']
+    QueuedItems:
+      type: object
+      properties:
+        queued_items:
+          type: array
+          items:
+            $ref: '#/components/schemas/QueuedItem'
+        queue_metadata:
+          $ref: '#/components/schemas/QueueMetadata'
+    Task:
+      type: object
+      description: Task, i.e. a user input waiting for a user (database record)
+      properties:
+        id:
+          type: integer
+        state_id:
+          type: [integer, 'null']
+          description: Work step ID
+        user_input_id:
+          type: [integer, 'null']
+        role_id:
+          type: [integer, 'null']
+          description: Group ID
+        user_id:
+          type: [integer, 'null']
+        status:
+          type: [string, 'null']
+        completed_by:
+          type: [integer, 'null']
+          description: User ID
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    UserInput:
+      type: object
+      properties:
+        name:
+          type: string
+        type:
+          type: string
+          description: Value type
+        value:
+          description: Current value
+        required:
+          type: boolean
+    MonitorChange:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - activate_monitor
+            - deactivate_monitor
+        time:
+          type: string
+          description: Local time
+        id:
+          type: string
+          description: Monitor ID
+        description:
+          type: string
+          enum:
+            - activated
+            - deactivated
+    PluginReloadStatus:
+      type: object
+      description: 'Plugin class name, or `All Plugins`, to `true`, `false` or an error message'
+      additionalProperties:
+        type: [boolean, string]
+    ProcessNode:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        current:
+          type: string
+          enum:
+            - 'true'
+            - 'false'
+        process:
+          type: array
+          items:
+            type: object
+            properties:
+              class:
+                type: string
+                enum:
+                  - engine
+                  - monitor
+                  - process_manager
+                  - node_mesh
+                  - worker
+              id:
+                type: string
+                description: Worker ID
+              pid:
+                type: string
+                description: '`-` when not running'
+              status:
+                type: string
+              type:
+                type: string
+                description: Worker type
+                enum:
+                  - normal
+                  - asynchronous
+                  - dedicated
+    AlertNotification:
+      type: object
+      properties:
+        id:
+          type: integer
+        category_id:
+          type: [integer, 'null']
+        alert_header:
+          type: [string, 'null']
+        alert_description:
+          type: [string, 'null']
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    TestRun:
+      type: object
+      properties:
+        Test_run_id:
+          type: string
+          format: uuid
+        Workflow_id:
+          type: [integer, 'null']
+        Test_cases_launched:
+          type: integer
+        Steps:
+          type: array
+          description: Only when synchronous, and in `test_step_status`
+          items:
+            type: object
+            properties:
+              Step_name:
+                type: string
+              Result:
+                type: boolean
+              Test_cases:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    Id:
+                      type: integer
+                    Name:
+                      type: string
+                    status:
+                      type: string
+                    Status_details:
+                      type: [string, 'null']
+                    Result_message:
+                      type: [string, 'null']
+                    Last_update:
+                      type: string
+                      format: date-time
+                    Inputs:
+                      description: Inputs of the test case
+                    Outputs:
+                      description: Outputs of the test case
+                    Result:
+                      type: [boolean, 'null']
+        Result:
+          type: boolean
+          description: Only when synchronous, and in `test_step_status`
+    JournalFile:
+      type: object
+      properties:
+        file_id:
+          type: integer
+        file:
+          type: string
+        status:
+          type: [string, 'null']
+        status_details:
+          type: [string, 'null']
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+        states:
+          type: array
+          description: Steps that processed the file, unless `details=false`
+          items:
+            type: object
+            properties:
+              path:
+                type: [string, 'null']
+              status:
+                type: [string, 'null']
+              status_details:
+                type: [string, 'null']
+              progress:
+                type: [integer, 'null']
+              work_step_id:
+                type: [integer, 'null']
+              work_order_id:
+                type: [integer, 'null']
+              step_name:
+                type: [string, 'null']
+              workflow_id:
+                type: [integer, 'null']
+              workflow_name:
+                type: [string, 'null']
+              created_at:
+                type: string
+                format: date-time
+    ManagedResource:
+      type: object
+      description: Resource of a resource pool (database record)
+      properties:
+        id:
+          type: integer
+        resource_id:
+          type: string
+        resource_name:
+          type: string
+          description: Pool name, with the suffix `__a`
+        status:
+          type: [string, 'null']
+        max:
+          type: [integer, 'null']
+          description: Capacity
+        reserved:
+          type: [integer, 'null']
+        properties:
+          type: [string, 'null']
+        tags:
+          type: [string, 'null']
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+  responses:
+    UnauthorizedError:
+      description: Authentication required or token invalid
+      content:
+        application/json:
+          schema:
+            anyOf:
+              - title: JWT authentication
+                type: object
+                properties:
+                  error:
+                    type: string
+                    examples:
+                      - Unauthorized
+              - $ref: '#/components/schemas/Error'
+    Error:
+      description: 'Error: status 403 when access is denied, else 404 when the server option `strict_api_validation` is set, else 200 (see Errors in the introduction)'
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+tags:
+  - name: Authentication
+    description: Obtain JWT tokens for API access. All other endpoints require authentication.
+  - name: Workflows
+    description: Import, export, publish and inspect workflow definitions.
+  - name: Work Orders
+    description: Initiate and track workflow executions. Each work order is one execution of a workflow.
+  - name: Work Steps
+    description: Status and control of the steps of a work order.
+  - name: Queues
+    description: Managed queues (plugin Queue stager) and their items.
+  - name: Monitors
+    description: Monitors of workflows, work orders, folders, remote nodes and scripts.
+  - name: Tasks
+    description: User inputs (tasks) waiting for an operator.
+  - name: Plugins
+    description: Versions, import, enabling and reloading of action plugins.
+  - name: Portlets
+    description: Versions of the portlets of the web interface.
+  - name: System
+    description: Processes, execution queue, alerts, and shared state for external applications.
+  - name: Remote Nodes
+    description: Information on this Orchestrator, used by remote Orchestrator nodes.
+  - name: Testing
+    description: Test cases of workflow steps.
+  - name: Statistics
+    description: Statistics of work orders and work steps.
+  - name: Journals
+    description: Journal books and the files recorded in them.
+  - name: Resources
+    description: Resource pools (plugin Load manager) and their resources.
+  - name: Users
+    description: User accounts.