{
  "openapi": "3.1.0",
  "info": {
    "title": "XStudio REST API",
    "version": "v15sp4",
    "description": "Generated from `www/js/ui.backend.js` (the frontend's API client). Each operation is one `command` of the `/api` endpoint, exposed here in the standard path form `/api/<command>` (the legacy query form `/api?command=<command>` is also accepted by the backend). `x-broadcast` names the jQuery event (`namespace.event`) the frontend broadcasts the response on.\n\n**Authentication** — either a per-user Bearer token (see D_4271), or HTTP Basic with the login/password."
  },
  "servers": [
    {
      "url": "/xqual",
      "description": "XStudio API (same origin)"
    }
  ],
  "tags": [
    {
      "name": "Administration"
    },
    {
      "name": "Agents"
    },
    {
      "name": "AI"
    },
    {
      "name": "Assets"
    },
    {
      "name": "Attachments"
    },
    {
      "name": "Authentication"
    },
    {
      "name": "Bugs"
    },
    {
      "name": "Campaigns"
    },
    {
      "name": "Categories"
    },
    {
      "name": "Chat"
    },
    {
      "name": "Companies"
    },
    {
      "name": "Custom Fields"
    },
    {
      "name": "Dashboard"
    },
    {
      "name": "Document"
    },
    {
      "name": "E-Signature"
    },
    {
      "name": "Embedded Images"
    },
    {
      "name": "Folders"
    },
    {
      "name": "Miscellaneous"
    },
    {
      "name": "Reports"
    },
    {
      "name": "Requirements"
    },
    {
      "name": "Settings"
    },
    {
      "name": "Similarity"
    },
    {
      "name": "Specifications"
    },
    {
      "name": "SQL Reports"
    },
    {
      "name": "SUTs"
    },
    {
      "name": "Tests"
    },
    {
      "name": "Tree Filters"
    },
    {
      "name": "Users"
    },
    {
      "name": "Versioning"
    }
  ],
  "paths": {
    "/api/GetCustomFields": {
      "get": {
        "tags": [
          "Custom Fields"
        ],
        "operationId": "GetCustomFields",
        "description": "TODO it would be good to generalize the channel practice in the future backend (with model)",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/addBugsFollower": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "addBugsFollower",
        "description": "This API allows adding a specified user as a follower to one or more bugs identified by their IDs. The API\nreceives a comma-separated list of bug IDs and the ID of the user to be added as a follower.",
        "parameters": [
          {
            "name": "followerId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatebugsfollower",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/addSessionsFollower": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "addSessionsFollower",
        "description": "This API endpoint allows adding a specified user as a follower to one or more test execution sessions. The\nfollower will likely receive notifications or updates related to the session(s).",
        "parameters": [
          {
            "name": "followerId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessionsfollower",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/adminPurge": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "adminPurge",
        "description": "This API endpoint deletes the old data (the type of data and the retention period being configurable) to\nkeep the database lean and efficient. It is part of the maintenance toolbox.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "toolbox.adminpurge",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/aiGenerateGherkinTests": {
      "post": {
        "tags": [
          "AI",
          "Tests"
        ],
        "operationId": "aiGenerateGherkinTests",
        "description": "This API endpoint uses AI to generate Gherkin tests from a source node of the tree (typically\nrequirements or specifications) and links them into a destination folder. It allows specifying default\nvalues for the generated test attributes and handling naming conflicts.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.aigenerategherkintests",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/aiGenerateSpecifications": {
      "post": {
        "tags": [
          "AI",
          "Specifications"
        ],
        "operationId": "aiGenerateSpecifications",
        "description": "This API endpoint uses AI to generate specifications from a source node of the tree (typically\nrequirements) and links them into a destination folder. It allows specifying default values for the\ngenerated specification attributes and handling naming conflicts.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.aigeneratespecifications",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/aiGenerateTestsAndTestcases": {
      "post": {
        "tags": [
          "AI",
          "Tests"
        ],
        "operationId": "aiGenerateTestsAndTestcases",
        "description": "This API endpoint uses AI to generate tests and test cases from a source node of the tree (typically\nrequirements or specifications) and links them into a destination folder. It allows specifying default\nvalues for the generated test attributes and handling naming conflicts.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.aigeneratetests",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/aiScoreRequirements": {
      "post": {
        "tags": [
          "AI",
          "Requirements"
        ],
        "operationId": "aiScoreRequirements",
        "description": "This API endpoint uses AI to compute a quality score for each requirement found under a given node of the\ntree. It helps identifying poorly written requirements that would deserve a manual review.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.aiscorerequirements",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/aiScoreSpecifications": {
      "post": {
        "tags": [
          "AI",
          "Specifications"
        ],
        "operationId": "aiScoreSpecifications",
        "description": "This API endpoint uses AI to compute a quality score for each specification found under a given node of\nthe tree. It helps identifying poorly written specifications that would deserve a manual review.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.aiscorespecifications",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/assignBugTo": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "assignBugTo",
        "description": "This API endpoint allows assigning a specific bug (identified by its ID) to one or more users. The user IDs\nare passed as a comma-separated list.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.assigndefecttousers",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/assignBugsTo": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "assignBugsTo",
        "description": "This API endpoint allows assigning one or more bugs, identified by their IDs, to a specific user. The bug IDs\nand user ID are passed as parameters in the request.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatebugsuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/authenticate": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "authenticate",
        "description": "This endpoint authenticates a user based on provided credentials and creates a session upon successful\nauthentication. The session is used to track the user's activity and maintain their logged-in state. It also\nhandles cases where the user is required to change their password upon first login.\n\n(also called by `checkPassword()`)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.loginsuccess",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "username": {
                    "type": "string"
                  },
                  "token": {
                    "type": "string"
                  },
                  "password": {
                    "type": "string"
                  },
                  "userLanguage": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/broadcastMessage": {
      "post": {
        "tags": [
          "Chat"
        ],
        "operationId": "broadcastMessage",
        "description": "This API endpoint allows sending a message to all currently connected clients. It is typically used for\nsystem-wide announcements or notifications. The message content is passed as a parameter in the request.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "messages.messageBroadcasted",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/buyPackage": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "buyPackage",
        "description": "This API endpoint allows a user to purchase a software package by providing the package ID and a valid license\nkey. It processes the purchase request and returns a result indicating success or failure.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "marketplace-purchase.buypackage",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "packageId": {
                    "type": "string"
                  },
                  "licenseKey": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/checkDatabase": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "checkDatabase",
        "description": "This API endpoint performs a complete diagnostic of the database to identify potential inconsistencies in\nthe database schema. It is part of the maintenance toolbox.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "toolbox.checkdatabase",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/checkDatabaseSchemaCompatibility": {
      "get": {
        "tags": [
          "Administration"
        ],
        "operationId": "checkDatabaseSchemaCompatibility",
        "description": "This API endpoint verifies that the current database schema is compatible with the version of the application.\nIt is used to ensure that the application can function correctly with the existing database. If the schema is\nincompatible or a connection cannot be established, an error is returned.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "backend.backendready"
      }
    },
    "/api/checkUserPassword": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "checkUserPassword",
        "description": "This API endpoint verifies a user's password. It is typically used to re-authenticate a user before performing\nsensitive actions, such as signing an item.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.checkpassword",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "username": {
                    "type": "string"
                  },
                  "password": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/confirmSsoAuthentication": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "confirmSsoAuthentication",
        "description": "This endpoint confirms that a user has been successfully authenticated via Single Sign-On (SSO). It adds the\ncurrent HTTP session to a synchronized session vector, effectively marking the session as authenticated. This\nis likely part of a larger SSO implementation.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.confirmssoauth",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/convertTestcaseToReusableTestcase": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "convertTestcaseToReusableTestcase",
        "description": "This API endpoint converts a standard test case of a test into a reusable test case. A new reusable test case is\ncreated in the folder 'destFolderId' of the tests tree from the test case details, procedure and custom fields,\nthen the test case itself is turned into a test case referencing it (same id, so that its parameters, results,\ncampaigns etc. are preserved). 'reusableTestcaseName' is optional (the test case name is used by default).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.converttestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseId": {
                    "type": "string"
                  },
                  "destFolderId": {
                    "type": "string"
                  },
                  "reusableTestcaseName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyCampaigns": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "copyCampaigns",
        "description": "This API endpoint allows copying one or more test campaigns to a specified destination folder. It takes a list\nof campaign IDs and corresponding new names for the copies, and places the copies within the folder indicated\nby the destination folder ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.copycampaign",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "campaignIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "campaignNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyChannels": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "copyChannels",
        "description": "This API endpoint copies a channel into a destination folder. It receives the channel ID and the\ndestination parent folder ID, and duplicates the channel and its pages at the target location.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.copychannel",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "channelIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyFolder": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "copyFolder",
        "description": "This API endpoint allows copying an existing folder to a new parent folder within a specific tree structure.\nThe folder's name can be optionally changed during the copy operation.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.copyfolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderId": {
                    "type": "string"
                  },
                  "folderName": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyFolderToCategory": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "copyFolderToCategory",
        "description": "This API copies a folder (identified by its ID and name) to a destination category. The folder's tree type and\nthe destination category's ID must be provided. This operation is typically used for organizing folders within\na category structure.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.copyfolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderId": {
                    "type": "string"
                  },
                  "folderName": {
                    "type": "string"
                  },
                  "destParentCategoryId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyFolderToCompany": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "copyFolderToCompany",
        "description": "This API copies a folder (and its contents) to a different company within a multi-tenant environment. The\nfolder is identified by its ID and the destination company is specified by its ID.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.copyfolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderId": {
                    "type": "string"
                  },
                  "folderName": {
                    "type": "string"
                  },
                  "destParentCompanyId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "copyRequirements",
        "description": "This API endpoint allows copying one or more requirements to a new parent folder. The requirements are\nidentified by their IDs and names, and the destination is specified by the ID of the parent folder.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.copyrequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "requirementNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyReusableTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "copyReusableTestcases",
        "description": "This API endpoint allows copying one or more reusable test cases to a new parent folder. The API takes a list\nof reusable test case IDs and their corresponding names, and the ID of the destination parent folder as input.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.copyreusabletestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "reusableTestcaseIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "reusableTestcaseNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copySchedules": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "copySchedules",
        "description": "This API copies one or more schedules to a specified destination campaign. It takes schedule IDs and names as\ninput and duplicates the schedules within the target campaign.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.copyschedule",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "scheduleIds": {
                    "type": "string"
                  },
                  "scheduleNames": {
                    "type": "string"
                  },
                  "destCampaignId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copySessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "copySessions",
        "description": "This API endpoint allows copying one or more test execution sessions to a different campaign. It takes a list\nof session IDs and corresponding session names, and the ID of the destination campaign where the sessions will\nbe copied.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.copysession",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  },
                  "sessionNames": {
                    "type": "string"
                  },
                  "destCampaignId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copySpecifications": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "copySpecifications",
        "description": "This API endpoint copies one or more specifications to a specified destination folder. It takes a list of\nspecification IDs and their corresponding names, and the ID of the destination parent folder where the copies\nshould be placed.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.copyspecification",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "specificationNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copySuts": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "copySuts",
        "description": "This API endpoint allows copying one or more SUTs to a specified destination folder. The SUTs are identified\nby their IDs and names, and the destination is specified by the parent folder ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.copysut",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sutIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "sutNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "copyTestcases",
        "description": "This API endpoint allows copying one or more test cases to a specified destination test. It takes a list of\ntest case IDs and names, and the ID of the destination test as input, and performs the copy operation.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.copytestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseIds": {
                    "type": "string"
                  },
                  "testcaseNames": {
                    "type": "string"
                  },
                  "destTestId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/copyTests": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "copyTests",
        "description": "This API endpoint allows copying one or more tests to a new location within the test tree. It takes a list of\ntest IDs and their corresponding names, along with the ID of the destination parent folder where the tests\nshould be copied.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.copytest",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "testNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/createAgent": {
      "post": {
        "tags": [
          "Agents"
        ],
        "operationId": "createAgent",
        "description": "This API endpoint allows the creation of a new test agent. The agent will be created within the folder\nspecified by the 'parentFolderId' parameter.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.createagent",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createAsset": {
      "post": {
        "tags": [
          "Assets"
        ],
        "operationId": "createAsset",
        "description": "This API endpoint allows the creation of a new asset. The asset will be placed inside the folder identified by\nthe provided `parentFolderId`.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.createasset",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createAttribute": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createAttribute",
        "description": "This API endpoint creates a new test attribute within the XStudio system. It delegates the creation to the\n`CApiXStudioWeb_Test.createAttribute` method, which handles the actual attribute creation logic.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.createtestattribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createBearerToken": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "createBearerToken",
        "description": "This API endpoint generates a new bearer token for a given user. It receives the token creation form and\nreturns the personal API token, which can then be used instead of a password to authenticate REST API\ncalls.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.createbearertoken",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createBug": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "createBug",
        "description": "This API endpoint allows the creation of a new bug or defect. It takes parameters specifying the parent\nfolder, users to assign the bug to, systems where the bug was found, and users to add as followers to the bug.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.createdefect",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createCampaign": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "createCampaign",
        "description": "This API endpoint allows the creation of a new test campaign. It requires a parent folder ID to determine\nwhere the campaign should be created within the folder structure. The API is part of the campaign management\nsuite.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.createcampaign",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createCategory": {
      "post": {
        "tags": [
          "Categories"
        ],
        "operationId": "createCategory",
        "description": "This API endpoint allows the creation of a new category within the system. It delegates the actual creation\nlogic to the `CApiXStudioWeb_Common.createCategory` method.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "categories.createcategory",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createChannel": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "createChannel",
        "description": "This API endpoint creates a new channel within the dashboard. The channel is created using the provided name\nand description.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.createchannel",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createCompany": {
      "post": {
        "tags": [
          "Companies"
        ],
        "operationId": "createCompany",
        "description": "This API endpoint allows administrators to create new companies, enabling multi-tenancy within the XQual\nsystem. It handles the creation of a new company record and associated configurations.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "companies.createcompany",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createConfiguration": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "createConfiguration",
        "description": "This API endpoint creates a new configuration for a test campaign. It requires a category ID and a\nconfiguration name to be provided as parameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.createconfiguration"
      }
    },
    "/api/createContent": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "createContent",
        "description": "This API endpoint creates a new content that can be placed on dashboard pages. It receives the content\nform along with its data source configuration and returns the created content.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.createcontent",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {},
                  "configuration": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createCustomField": {
      "post": {
        "tags": [
          "Custom Fields"
        ],
        "operationId": "createCustomField",
        "description": "This API endpoint allows the creation of a new custom field. The custom field is associated with a specific\nnode type, defining where the custom field will be available within the application.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createDefinition": {
      "post": {
        "tags": [
          "Settings"
        ],
        "operationId": "createDefinition",
        "description": "This API endpoint allows the creation of a new definition. The specific type of definition created depends on\nthe parameters provided in the request. It is typically used to define reusable elements or configurations\nwithin the XStudio environment.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.createdefinition",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createExploratorySession": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "createExploratorySession",
        "description": "This API endpoint creates a new exploratory session within the XStudio system. It requires a parent folder, an\nassigned user, and a system under test (SUT) to be specified.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "assignedToId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.createexploratorysession",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createExternalBug": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "createExternalBug",
        "description": "This API endpoint allows the creation of a new bug or defect in an external defect tracking system (e.g.,\nJira, Bugzilla) that is connected to the XStudio system. It requires parameters to identify the connector,\nproject, test session, test, and instance related to the bug.\n\n(also called by `createExternalDefectExploratoryRunSession()`)\n\n(also called by `createExternalDefectRunSession()`)\n\n(also called by `createExternalDefectSessionResults()`)",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.createexternaldefect",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createExternalRequirement": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "createExternalRequirement",
        "description": "This API endpoint creates a new requirement in an external system (e.g., Jira) via a configured connector. It\nrequires a connector index and project name to properly link the requirement to the external system and\nproject.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.createexternalrequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createFolder": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "createFolder",
        "description": "This API endpoint allows the creation of a new folder within a hierarchical tree structure. It requires\nspecifying the tree type and the ID of the parent folder under which the new folder will be created. The API\nis typically used for organizing data within a tree-like structure.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.createfolder.folder",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createFolderUnderCategory": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "createFolderUnderCategory",
        "description": "This API endpoint creates a new folder within the category folder structure. It requires the parent folder ID\nand the category ID to determine the location for the new folder.\n\n(also called by `createFolderUnderCategoryAuto()`)",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "categoryId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.createfolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createFolderUnderCompany": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "createFolderUnderCompany",
        "description": "This API endpoint allows the creation of a new folder within a hierarchical tree structure, associating it\nwith a specific company. The folder is created under a designated parent folder, enabling organization and\ncategorization of data within the company's context.\n\n(also called by `createFolderUnderCompanyAuto()`)",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.createfolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createGenericBug": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "createGenericBug",
        "description": "This API endpoint allows the creation of a new bug/defect within the defect tracking system. The bug is\ncreated as a generic bug and is placed inside the folder specified by the parentFolderId.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.creategenericdefect",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createGenericRequirement": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "createGenericRequirement",
        "description": "This API endpoint creates a new requirement of a generic type under a designated parent folder. It is used for\nadding new requirements to the requirement tracking system within a specific folder hierarchy.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.createrequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createMessage": {
      "post": {
        "tags": [
          "Chat"
        ],
        "operationId": "createMessage",
        "description": "This API endpoint creates a message and associates it with the specified nodes. The message creation is\ntriggered by a POST request. The message can be linked to nodes of a specific type.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "discussion.createmessage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createPage": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "createPage",
        "description": "This API endpoint creates a new dashboard page with the specified name and path. It is used to dynamically add\nnew pages to the dashboard for organizing widgets and visualizations.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.createpage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createParameter": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createParameter",
        "description": "This API endpoint creates a new parameter for a test case. It receives parameter details via HTTP POST and\npersists the new parameter in the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.createtestparam",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createProfile": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "createProfile",
        "description": "This API endpoint creates a new user profile with the provided profile name. It handles the creation logic.",
        "parameters": [
          {
            "name": "profileName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.createcopyprofileuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createRequirement": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "createRequirement",
        "description": "This API endpoint creates a new requirement in the system under a given parent folder. It takes the parent\nfolder ID as a parameter to determine where to create the requirement.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.createrequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createResidualCampaign": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createResidualCampaign",
        "description": "This API endpoint creates a new test campaign by extracting residual test cases from specified test execution\nsessions. It allows users to define rules to filter and mask data during the campaign creation process,\nplacing the new campaign in a specified destination folder.",
        "parameters": [
          {
            "name": "destParentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.generateresidualtestscampaign",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createReusableTestcase": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createReusableTestcase",
        "description": "This API endpoint allows the creation of a new reusable test case. The test case will be created within the\nfolder specified by the 'parentFolderId' parameter.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.createreusabletestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createSchedule": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "createSchedule",
        "description": "This API endpoint creates a new schedule associated with a specified test campaign and SUT (System Under\nTest). It allows for configuring rules for parent test results and linking monitoring configurations.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.createschedule",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createSession": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "createSession",
        "description": "This API endpoint initiates a new test execution session based on the provided campaign and System Under Test\n(SUT). It allows specifying optional parameters such as schedule, parent rule behavior, monitoring agent, and\nconfiguration.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.createsession",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createSpecification": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "createSpecification",
        "description": "This API endpoint allows the creation of a new specification document. The specification will be created as a\nchild of the folder identified by the provided `parentFolderId`.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.createspecification",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createSqlReport": {
      "post": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "createSqlReport",
        "description": "This API endpoint allows the creation of a new SQL report. The report will be created under the folder\nspecified by the 'parentFolderId' parameter.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.createsqlreport",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createStatement": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createStatement",
        "description": "This API endpoint creates a new Gherkin statement of a specified type with a description and help text. It is\nused to extend the vocabulary of Gherkin languages.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "gherkin.createstatement",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createSut": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "createSut",
        "description": "This API endpoint allows the creation of a new SUT. The SUT will be created as a child of the folder\nidentified by the 'parentFolderId' parameter.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.createsut",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createTeam": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "createTeam",
        "description": "This API endpoint allows the creation of a new team, which is essentially a user group, under a designated\nparent folder. The team is created using information provided in the request, and the parent folder ID is used\nto determine the location of the new team within the organizational structure.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.createusergroup",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createTest": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createTest",
        "description": "This API endpoint allows the creation of a new test case within the test management system. The test will be\ncreated as a child of the folder identified by the 'parentFolderId' parameter.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.createtest",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createTestcase": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createTestcase",
        "description": "This API endpoint creates a new test case within the system. It requires a test ID to associate the new test\ncase with a specific test.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.createtestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createTestcaseReferencingReusableTestcase": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "createTestcaseReferencingReusableTestcase",
        "description": "This API endpoint creates a new test case and establishes a reference to an existing reusable test case. The\nnew test case will inherit steps or data from the referenced reusable test case, promoting modularity and\nreusability in test design.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.createtestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createTimetag": {
      "post": {
        "tags": [
          "Versioning"
        ],
        "operationId": "createTimetag",
        "description": "This API endpoint creates a new timetag with the provided name. Timetags are likely used for marking specific\npoints in time within the application, possibly related to test execution or data versioning.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "timetags.createtimetag",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "timetagName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/createTreeFilter": {
      "post": {
        "tags": [
          "Tree Filters"
        ],
        "operationId": "createTreeFilter",
        "description": "This API endpoint allows the creation of a new tree filter. The filter is created based on the provided tree\ntype. This is typically used for filtering nodes in a tree-like structure within the application.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "treefilter.createtreefilter",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/createUser": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "createUser",
        "description": "This API endpoint allows the creation of a new user account. The user will be created within the folder\nspecified by the `parentFolderId` parameter.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.createuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteAgents": {
      "post": {
        "tags": [
          "Agents"
        ],
        "operationId": "deleteAgents",
        "description": "This API endpoint deletes one or more test agents based on the provided agent IDs.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.deleteagents",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "agentIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteAssets": {
      "post": {
        "tags": [
          "Assets"
        ],
        "operationId": "deleteAssets",
        "description": "This API endpoint allows for the deletion of assets. It receives a comma-separated list of asset IDs as input\nand removes the corresponding assets from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.deleteassets",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "assetIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteAttachments": {
      "post": {
        "tags": [
          "Attachments"
        ],
        "operationId": "deleteAttachments",
        "description": "This API endpoint allows the deletion of one or more attachments associated with a specific node within a\ndesignated tree structure. The attachments are identified by their IDs and names, and the node is identified\nby its type and ID.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attachmentIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attachmentNames",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.deleteattachments",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteAttributes": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteAttributes",
        "description": "This API endpoint allows the deletion of test attributes. It receives attribute types and IDs as parameters\nand removes the corresponding attributes from the system.",
        "parameters": [
          {
            "name": "attributeTypes",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.deletetestattribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteBugConnector": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "deleteBugConnector",
        "description": "This API endpoint deletes a bug connector from the system. The connector is identified by its index, which is\npassed as a request parameter.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.deletebugconnector",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteBugs": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "deleteBugs",
        "description": "This API endpoint allows for the deletion of one or more bugs from the system. The bugs to be deleted are\nidentified by their IDs, which are passed as a comma-separated string in the 'bugIds' parameter.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.deletedefects",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteCampaigns": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteCampaigns",
        "description": "This API endpoint deletes one or more test campaigns based on the provided campaign IDs.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.deletecampaigns",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "campaignIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteCategories": {
      "post": {
        "tags": [
          "Categories"
        ],
        "operationId": "deleteCategories",
        "description": "This API endpoint allows for the deletion of categories. It receives a comma-separated list of category IDs as\ninput and removes the corresponding categories from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "categories.deletecategories",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "categoryIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteChannels": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "deleteChannels",
        "description": "This API endpoint deletes one or more channels. It receives a comma-separated list of channel IDs and\nremoves the corresponding channels along with their pages.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.deletechannels",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "channelIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteCompanies": {
      "post": {
        "tags": [
          "Companies"
        ],
        "operationId": "deleteCompanies",
        "description": "This API endpoint allows for the deletion of companies based on a provided list of company IDs. It is intended\nfor use by administrators or authorized personnel to manage company accounts within the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "companies.deletecompanies",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "companyIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteConfigurations": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteConfigurations",
        "description": "This API endpoint allows the deletion of campaign configurations based on their IDs. It receives a\ncomma-separated list of configuration IDs as input and removes the corresponding configurations from the\nsystem.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.deleteconfiguration",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteContents": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "deleteContents",
        "description": "This API endpoint deletes one or more contents. It receives a comma-separated list of content IDs and\nremoves the corresponding contents from the catalog.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.deletecontents",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "contentIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteCustomFields": {
      "post": {
        "tags": [
          "Custom Fields"
        ],
        "operationId": "deleteCustomFields",
        "description": "This API endpoint allows the deletion of custom fields. It receives the tree type, custom field IDs, and\ncustom field types as parameters to identify and remove the specified custom fields from the system.",
        "parameters": [
          {
            "name": "customFieldTypes",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customFieldIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteDefinitions": {
      "post": {
        "tags": [
          "Settings"
        ],
        "operationId": "deleteDefinitions",
        "description": "This API endpoint allows deleting definitions (likely folder or category definitions) from the system. It\naccepts a comma-separated list of definition IDs to be deleted.",
        "parameters": [
          {
            "name": "definitionIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.deletedefinitions",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteDocuments": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "deleteDocuments",
        "description": "This API endpoint allows for the deletion of documents. It receives a comma-separated list of document IDs as\ninput and removes the corresponding documents from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.deletedocuments",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "documentIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteExploratorySessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteExploratorySessions",
        "description": "This API endpoint allows the deletion of exploratory test sessions. It receives a comma-separated list of\nexploratory session IDs to be deleted and removes them from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.deleteexploratorysessions",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "exploratorySessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteFolders": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "deleteFolders",
        "description": "This API endpoint deletes folders based on their IDs and a specified tree type. It is used for removing\nfolders from various tree structures within the application.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.deletefolders",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteGenericBugs": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "deleteGenericBugs",
        "description": "This API endpoint allows for the deletion of multiple bugs or defects at once. It receives a comma-separated\nlist of bug IDs and removes the corresponding bugs from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.deletedefects",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteGenericRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "deleteGenericRequirements",
        "description": "This API endpoint allows for the deletion of multiple requirements at once. It receives a comma-separated list\nof requirement IDs and removes the corresponding requirements from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.deleterequirements",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deletePages": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "deletePages",
        "description": "This API endpoint deletes one or more dashboard pages. It receives a comma-separated list of page IDs and\nremoves the corresponding pages from their channel.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.deletepages",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "pageIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteParameters": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteParameters",
        "description": "This API endpoint allows deleting test case parameters based on their types and IDs. It requires proper\nauthorization to perform the deletion.",
        "parameters": [
          {
            "name": "parameterTypes",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.deletetestparam",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteProfile": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "deleteProfile",
        "description": "This API endpoint deletes a user profile based on the provided profile ID.",
        "parameters": [
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.deleteuserprofileuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteRequirementConnector": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "deleteRequirementConnector",
        "description": "This API endpoint deletes a requirement connector based on its index. The connector is identified by the\n`connectorIndex` parameter.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.deleterequirementconnector",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "deleteRequirements",
        "description": "This API endpoint allows for the deletion of requirements. It receives a comma-separated list of requirement\nIDs and removes the corresponding requirements from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.deleterequirements",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteReusableTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteReusableTestcases",
        "description": "This API endpoint allows the deletion of reusable test cases. It receives a comma-separated list of reusable\ntest case IDs and removes the corresponding test cases from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.deletereusabletestcases",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "reusableTestcaseIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteScheduleAttributes": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteScheduleAttributes",
        "description": "This API endpoint deletes schedule-related attributes based on the provided session ID. It is used to clean up\nor reset schedule information associated with a specific session within the campaign management system.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.deletescheduleattributes"
      }
    },
    "/api/deleteScheduleParams": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteScheduleParams",
        "description": "This API endpoint allows the deletion of schedule parameters. It requires a schedule ID to identify the\nparameters to be removed. This is used for managing test campaign schedules.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.deletescheduleparams"
      }
    },
    "/api/deleteSchedules": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteSchedules",
        "description": "This API endpoint allows for the deletion of existing schedules. It receives a comma-separated list of\nschedule IDs and removes the corresponding schedules from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.deleteschedules",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "scheduleIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteSessionAttributes": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteSessionAttributes",
        "description": "This API endpoint allows the deletion of session attributes. It requires a session ID to identify the target\nsession and removes all attributes associated with that session. This is useful for cleaning up session data\nor resetting a session's state.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.deletesessionattributes"
      }
    },
    "/api/deleteSessionParams": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteSessionParams",
        "description": "This API endpoint allows the deletion of session parameters. It receives a session ID as input and removes the\nassociated parameters from the server-side session. This is typically used to clean up session data or reset\nthe session state.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.deletesessionparameters"
      }
    },
    "/api/deleteSessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "deleteSessions",
        "description": "This API endpoint allows deleting one or more test execution sessions. It receives a comma-separated list of\nsession IDs to be deleted and removes them from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.deletesessions",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteSpecifications": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "deleteSpecifications",
        "description": "This API endpoint allows the deletion of specifications. It receives a comma-separated list of specification\nIDs as input and removes the corresponding specifications from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.deletespecifications",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteSqlReports": {
      "post": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "deleteSqlReports",
        "description": "This API endpoint allows for the deletion of SQL reports. It receives a comma-separated list of SQL report IDs\nand removes the corresponding reports from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.deletesqlreports",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sqlReportIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteStatements": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteStatements",
        "description": "This API endpoint allows deleting Gherkin statements. It receives a comma-separated list of statement IDs and\nremoves the corresponding statements from the system.",
        "parameters": [
          {
            "name": "statementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "gherkin.deletestatements",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteSuts": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "deleteSuts",
        "description": "This API endpoint allows deleting one or more SUTs based on their IDs. The API receives a comma-separated list\nof SUT IDs to delete.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.deletesuts",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sutIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteTeams": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "deleteTeams",
        "description": "This API endpoint deletes teams based on the provided team IDs. It is available from API version 11 onwards.\nThe team IDs are passed as a comma-separated string.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.deleteusergroups",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "teamIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteTestcaseExecutionAttachments": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteTestcaseExecutionAttachments",
        "description": "This API endpoint allows for the deletion of attachments linked to a particular test case execution. It\nrequires specifying the attachment IDs, names, and context of the test case execution including session, test\ncase, agent, and instance index.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attachmentIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attachmentNames",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.deleteattachments",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteTestcases",
        "description": "This API endpoint allows deleting one or more test cases. It receives a comma-separated list of test case IDs\nand removes the corresponding test cases from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.deletetestcases",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteTests": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "deleteTests",
        "description": "This API endpoint allows for the deletion of one or more tests. It receives a comma-separated list of test IDs\nas input and removes the corresponding tests from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.deletetests",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteTimetag": {
      "post": {
        "tags": [
          "Versioning"
        ],
        "operationId": "deleteTimetag",
        "description": "This API endpoint deletes a timetag based on the provided timetag ID. Timetags are likely used for time-based\nannotations or markers within the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "timetags.deletetimetag",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "timetagId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/deleteTreeFilters": {
      "post": {
        "tags": [
          "Tree Filters"
        ],
        "operationId": "deleteTreeFilters",
        "description": "This API endpoint deletes tree filters based on the provided IDs. It is typically used to remove saved filter\nconfigurations from the system.",
        "parameters": [
          {
            "name": "treeFilterIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "treefilter.deletetreefilters",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteUserPhoto": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "deleteUserPhoto",
        "description": "This API endpoint allows a user to delete their profile photo. The API requires the user's ID\nto identify the photo to be deleted.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.removeavatar"
      }
    },
    "/api/deleteUserRole": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "deleteUserRole",
        "description": "This API endpoint allows for the removal of a user's role within a specific team. It requires the user ID,\nprofile ID, and team ID to identify the role to be deleted.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.deleteuserrole",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/deleteUsers": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "deleteUsers",
        "description": "This API endpoint deletes user accounts based on a provided list of user IDs. It requires proper permissions\nto execute.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.deleteusers",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "userIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/emptyFolders": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "emptyFolders",
        "description": "This API endpoint empties the folders identified by their IDs within a specified tree structure. It is used to\nremove all content from the designated folders, effectively clearing them out.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.emptyfolders",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeBug": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "freezeBug",
        "description": "This API endpoint freezes a specific bug identified by its ID. Freezing a bug typically means that it can no\nlonger be edited, updated, or have its status changed, effectively archiving it in its current state. This is\nuseful for historical tracking and preventing accidental modifications to resolved or closed bugs.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.freezedefect",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeCampaign": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "freezeCampaign",
        "description": "This API endpoint freezes a specified test campaign, preventing any further modifications to its configuration\nor associated data. Freezing a campaign is typically done after it has been finalized and executed to preserve\nits state for historical or reporting purposes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.freezecampaign",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "campaignId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "freezeDocument",
        "description": "This API endpoint freezes a specific document, effectively creating a snapshot and preventing any further\nmodifications to it. The document is identified by its unique ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.freezedocument",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeRequirement": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "freezeRequirement",
        "description": "This API endpoint freezes a specific requirement identified by its ID. Freezing a requirement typically\nprevents any further modifications to its attributes or status, ensuring its state remains consistent.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.freezerequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeSession": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "freezeSession",
        "description": "This API endpoint freezes a specified test execution session, making it immutable. Freezing a session is\ntypically done to preserve the state of a test run for reporting or auditing purposes. Once frozen, the\nsession cannot be modified.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.freezesession",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeSpecification": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "freezeSpecification",
        "description": "This API endpoint freezes a specification document, identified by its ID. Freezing a specification typically\nmarks it as a finalized version, preventing accidental or unauthorized changes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.freezespecification",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeSut": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "freezeSut",
        "description": "This API endpoint freezes a specified System Under Test (SUT). Freezing a SUT typically prevents further\nmodifications to it, creating a snapshot of its current state. The `sutId` parameter is required to identify\nthe SUT to be frozen.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.freezesut",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sutId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeTest": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "freezeTest",
        "description": "This API endpoint freezes a specific test, identified by its ID. Freezing a test typically prevents any\nfurther modifications to its properties or associated data, ensuring its state remains consistent.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.freezetest",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/freezeTestcase": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "freezeTestcase",
        "description": "This API endpoint freezes a specific test case, identified by its ID. Freezing a test case typically prevents\nany further modifications to its content or properties. This is useful for versioning and ensuring the\nintegrity of test cases used in specific test cycles.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.freezetestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/generateSpecifications": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "generateSpecifications",
        "description": "This API endpoint generates new specifications based on provided parameters, copying them from a source\nfolder to a destination folder. It allows specifying default values for the specification attributes and\nhandling naming conflicts.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.generatespecifications",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/generateTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "generateTestcases",
        "description": "This API endpoint takes an exploratory session ID and a destination folder ID as input. It generates test\ncases based on the data from the exploratory session and stores them within the specified destination folder\nin the test case tree.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "destParentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.generatetestcases",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/generateTests": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "generateTests",
        "description": "This API endpoint generates new tests based on provided parameters, copying them from a source folder to a\ndestination folder. It allows specifying default values for test attributes and handling naming conflicts.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.generatetests",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/getAgentDetails": {
      "get": {
        "tags": [
          "Agents"
        ],
        "operationId": "getAgentDetails",
        "description": "This API endpoint fetches detailed information about a test agent based on the provided agent ID. It is used\nto retrieve agent configurations and status.\n\n(also called by `getAgentDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.agentsummary"
      }
    },
    "/api/getAgentForm": {
      "get": {
        "tags": [
          "Agents"
        ],
        "operationId": "getAgentForm",
        "description": "This API endpoint retrieves the necessary data to render the agent form. It is used to display or edit agent\ninformation.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.agentform"
      }
    },
    "/api/getAgentsTree": {
      "get": {
        "tags": [
          "Agents"
        ],
        "operationId": "getAgentsTree",
        "description": "This API endpoint retrieves the hierarchical tree structure representing test agents. It allows for specifying\ncaching behavior via parameters.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.agentstree"
      }
    },
    "/api/getAiUsage": {
      "get": {
        "tags": [
          "AI"
        ],
        "operationId": "getAiUsage",
        "description": "This API endpoint retrieves the AI credits consumption of the current account, including the number of\ncredits remaining. It is used to display the remaining AI credits in the settings.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.getaiusage"
      }
    },
    "/api/getAllChannels": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getAllChannels",
        "description": "This API endpoint fetches a list of all available channels. It is used to populate channel selection options\nin the dashboard and allows users to view data from different sources.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getallchannels"
      }
    },
    "/api/getAllContents": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getAllContents",
        "description": "This API endpoint retrieves the list of all the contents available for the dashboard pages. It is used to\npopulate the content catalog from which the channel pages are composed.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getallcontents"
      }
    },
    "/api/getAllTimetags": {
      "get": {
        "tags": [
          "Versioning"
        ],
        "operationId": "getAllTimetags",
        "description": "This API endpoint retrieves a list of all timetags available in the system. It is used to populate dropdowns\nor lists of available time markers for various operations within the XStudio application.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "timetags.getalltimetags"
      }
    },
    "/api/getAllUsersFromLDAP": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getAllUsersFromLDAP",
        "description": "This API endpoint retrieves a list of all users from the LDAP server configured within XStudio. It is\navailable from API version 11 onwards.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.getallusersfromldap"
      }
    },
    "/api/getAssetChanges": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetChanges",
        "description": "This API endpoint retrieves a list of changes made to a given asset, identified by its asset ID. It provides a\nhistory of modifications, allowing users to track asset evolution and identify specific changes over time.",
        "parameters": [
          {
            "name": "assetId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getAssetDetails": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetDetails",
        "description": "This API endpoint retrieves detailed information about an asset based on its unique identifier. It is used to\nfetch asset properties and metadata for display or processing within the XStudio application.\n\n(also called by `getAssetDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "assetId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.assetsummary"
      }
    },
    "/api/getAssetDetailsRevision": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetDetailsRevision",
        "description": "This API endpoint retrieves detailed information about a particular revision of an asset. It requires the\nasset ID and the revision number to identify the specific asset version.",
        "parameters": [
          {
            "name": "assetId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.assetdetailsrevision"
      }
    },
    "/api/getAssetForm": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetForm",
        "description": "This API endpoint retrieves the form definition required for creating or updating assets. The form definition\nis likely used to dynamically generate the UI for asset management within the XStudio Web application.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.assetform"
      }
    },
    "/api/getAssetRevisions": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetRevisions",
        "description": "This API endpoint retrieves a list of revisions associated with a given asset ID. It allows users to track\nchanges and versions of an asset over time.",
        "parameters": [
          {
            "name": "assetId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getAssetTypes": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetTypes",
        "description": "This API endpoint retrieves a list of asset types that can be managed within the system. It is used to\npopulate asset type selection lists in the user interface.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.assettypes"
      }
    },
    "/api/getAssetsTree": {
      "get": {
        "tags": [
          "Assets"
        ],
        "operationId": "getAssetsTree",
        "description": "This API endpoint retrieves the hierarchical tree structure of assets. It allows specifying caching behavior\nvia parameters.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.assetstree"
      }
    },
    "/api/getAttachmentRevisions": {
      "get": {
        "tags": [
          "Attachments"
        ],
        "operationId": "getAttachmentRevisions",
        "description": "This API endpoint retrieves a list of revision numbers associated with a given attachment. It requires both\nthe node type and attachment ID to identify the attachment for which revisions are requested.",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.attachmentrevisions"
      }
    },
    "/api/getAttributeDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getAttributeDetails",
        "description": "This API endpoint retrieves detailed information about a specified attribute based on its ID and type. It is\nused to fetch attribute-specific properties and configurations within the test management system.",
        "parameters": [
          {
            "name": "attributeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.attributeformdetails"
      }
    },
    "/api/getAttributeForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getAttributeForm",
        "description": "This API endpoint retrieves the attribute form, likely used for defining or displaying attributes associated\nwith test cases, test suites, or test executions within the XStudio test management system. The form is\nreturned as a JSON string.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.attributeformdetails"
      }
    },
    "/api/getAttributes": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getAttributes",
        "description": "This API retrieves attributes associated with tests. It is used to fetch metadata or properties related to\ntest cases, suites, or executions within the XStudio test management system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getAuditLog": {
      "get": {
        "tags": [
          "Administration"
        ],
        "operationId": "getAuditLog",
        "description": "This API endpoint retrieves the audit log for the current session. The audit log provides a record of user\nactions and system events.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.auditlog"
      }
    },
    "/api/getAvailableModelList": {
      "get": {
        "tags": [
          "AI"
        ],
        "operationId": "getAvailableModelList",
        "description": "params: {protocol, url, key} for OpenAI, or {protocol, region, accessKey, secretKey} for\nBedrock/Bedrock (XQual) - see CApiXStudioWeb_Common.getAvailableModelList(). callback is\noptional, called with the raw response either way (also broadcast, like every other call here).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.availablemodellist"
      }
    },
    "/api/getBearerTokenForm": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "operationId": "getBearerTokenForm",
        "description": "This API endpoint retrieves the form used to generate a bearer token for a given user. It returns the\ncreation options of the personal API token, such as its label and its validity period.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.bearertokenform"
      }
    },
    "/api/getBearerTokens": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "operationId": "getBearerTokens",
        "description": "This API endpoint retrieves the list of the bearer tokens of a given user. Bearer tokens are personal API\ntokens that can be used instead of a password to authenticate REST API calls.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.bearertokens"
      }
    },
    "/api/getBugAssignedTo": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugAssignedTo",
        "description": "This API endpoint retrieves the user ID or username that is currently assigned to a bug, based on the provided\nbug ID. It is used for determining bug ownership and assignment within the defect tracking system.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectassignedusers"
      }
    },
    "/api/getBugAttachments": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugAttachments",
        "description": "This API endpoint retrieves a list of attachments associated with a given bug ID. It is used to fetch the\nfiles attached to a bug report, such as screenshots or log files.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugChanges": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugChanges",
        "description": "This API endpoint retrieves the change log or history associated with a given bug ID. It allows users to track\nmodifications and updates made to a specific bug throughout its lifecycle.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugDetails": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugDetails",
        "description": "This API endpoint fetches detailed information about a bug or defect. It requires a connector index and bug ID\nto identify the specific bug within the specified defect tracking system. The 'frozen' parameter indicates\nwhether to retrieve the frozen/historical version of the bug.\n\n(also called by `getDefectDetails()`)",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.defectsummary"
      }
    },
    "/api/getBugDetailsRevision": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugDetailsRevision",
        "description": "This API endpoint retrieves the details of a particular revision of a bug or defect. It requires the bug ID\nand the revision number as input parameters to identify the specific bug revision to retrieve.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectdetailsrevision"
      }
    },
    "/api/getBugFixedIn": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFixedIn",
        "description": "This API endpoint retrieves the version in which a specific bug was fixed. It is used to track bug resolution\nand release management.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectfixedin"
      }
    },
    "/api/getBugFolderFullTraceability": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFolderFullTraceability",
        "description": "This API endpoint retrieves the full traceability matrix for a specified bug folder or a bug connector. It\nsupports fetching traceability data from the root folder, a specific folder, or a virtual connector folder\nbased on the provided parameters.\n\n(also called by `getBugFolderFullTraceability()`)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugFolderProgress": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFolderProgress",
        "description": "This API endpoint fetches progress data related to bug tracking. It can retrieve progress for the root bug\nfolder, a specific bug connector, or a particular bug folder, based on the provided parameters and date range.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.getbugfolderprogress"
      }
    },
    "/api/getBugFolderStatisticsPerActiveBugAge": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFolderStatisticsPerActiveBugAge",
        "description": "This API endpoint fetches statistics for bug folders, categorizing bugs by their age. It supports retrieving\nstatistics for the root folder, specific folders, or connector folders, providing insights into the\ndistribution of active bugs across different age ranges.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugFolderStatisticsPerCustomField": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFolderStatisticsPerCustomField",
        "description": "This API endpoint retrieves the statistics of a bug folder grouped by the values of a given custom field.\nIt receives the connector index, the folder ID and the custom field identifier and type, and returns the\ndistribution of the bugs across the custom field values.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customFieldId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customFieldType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugFollowers": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFollowers",
        "description": "This API endpoint retrieves a list of users who are following a particular bug, identified by its ID. It is\nused to determine who is receiving notifications and updates related to the bug.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectfollowers"
      }
    },
    "/api/getBugForm": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugForm",
        "description": "This API endpoint retrieves the necessary data to populate a bug submission form, pre-filled with information\nrelated to a specific test case. It takes the relevant test identifiers as input to fetch the correct bug\nform data.\n\n(also called by `getDefectFormFromTestcase()`)\n\n(also called by `getDefectFormFromTest()`)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.integrateddefectform"
      }
    },
    "/api/getBugFoundIn": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFoundIn",
        "description": "This API endpoint retrieves the 'Found In' information associated with a specific bug, identified by its ID.\nThis is typically used in integrated bug tracking systems to determine where the bug was initially discovered.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectlinkedsuts"
      }
    },
    "/api/getBugFreezeStatus": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFreezeStatus",
        "description": "This API endpoint fetches the freeze status for a given bug ID. The freeze status indicates whether\nmodifications to the bug are currently restricted.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectfreezestatus"
      }
    },
    "/api/getBugFullTraceability": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugFullTraceability",
        "description": "This API retrieves the full traceability information for one or more bugs, including links to requirements and\nother related items. It uses the connector index to identify the bug connector and the bug IDs to identify the\nspecific bugs.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugInheritedAttachments": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments that are inherited by a specific bug, likely from parent\nfolders or related entities. The bug is identified by its unique ID. The API returns a JSON string containing\nthe details of the inherited attachments.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugLinkedRequirements": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugLinkedRequirements",
        "description": "This API endpoint retrieves a list of requirements that are linked to a specific bug within a defect tracking\nsystem. It requires the connector index and the bug ID to identify the bug and its associated requirements.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.buglinkedrequirements"
      }
    },
    "/api/getBugLinkedSessions": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugLinkedSessions",
        "description": "This API endpoint retrieves a list of test execution sessions that are linked to a specific bug within a given\ndefect connector. It allows users to trace the origin and context of a bug by identifying the sessions during\nwhich the bug was observed.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.buglinkedsessions"
      }
    },
    "/api/getBugLinkedSpecifications": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugLinkedSpecifications",
        "description": "This API endpoint retrieves a list of specifications that are linked to a particular bug within a specified\ndefect connector. It uses the connector index and bug ID to identify the bug and fetch its associated\nspecifications.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.buglinkedspecification"
      }
    },
    "/api/getBugLinkedSutsFoundIn": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugLinkedSutsFoundIn",
        "description": "This API endpoint retrieves a list of SUTs that are linked to a particular bug, identified by its ID, within a\nspecified defect connector. The connector is identified by its index. This is useful for tracing the impact of\na bug on different SUTs.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.buglinkedsuts"
      }
    },
    "/api/getBugLinkedTests": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugLinkedTests",
        "description": "This API endpoint fetches a list of tests that are linked to one or more bugs identified by their IDs, using a\nspecific defect connector. The connector is identified by its index. The API returns a JSON string containing\nthe linked test information.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.buglinkedtests_"
      }
    },
    "/api/getBugResultsTreeview": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugResultsTreeview",
        "description": "This API endpoint retrieves the results tree associated with a given bug. It returns the hierarchical\ntree of the sessions, campaigns, tests and test cases linked to the bug, along with their execution\nresults.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "results.resulttreeview"
      }
    },
    "/api/getBugRevisions": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugRevisions",
        "description": "This API endpoint retrieves a list of revisions associated with a given bug ID. It allows users to track\nchanges and updates made to a bug over time, providing an audit trail of modifications.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getBugsTree": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getBugsTree",
        "description": "This API endpoint fetches a hierarchical representation of bugs, allowing filtering based on criteria such as\nintegration status. It supports caching mechanisms to optimize performance and reduce server load. The\nendpoint also implements idempotency to prevent duplicate processing of requests.",
        "parameters": [
          {
            "name": "onlyIntegrated",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.defectstree"
      }
    },
    "/api/getCampaignAttachments": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignAttachments",
        "description": "This API endpoint retrieves a list of attachments linked to a given test campaign. It is used to access files\nand documents relevant to a particular campaign for review or download.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignAttributes": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignAttributes",
        "description": "This API endpoint retrieves the attributes associated with a specific test campaign. It is used during session\nor schedule creation to populate campaign-related information.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.getcampaignattributes"
      }
    },
    "/api/getCampaignCategories": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignCategories",
        "description": "This API endpoint retrieves a list of categories associated with a given campaign ID. It is used to categorize\nand organize campaigns within the system.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.campaigncategories"
      }
    },
    "/api/getCampaignDetails": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignDetails",
        "description": "This API endpoint fetches detailed information about a test campaign, identified by its campaign ID. It allows\nretrieving either the current version or a frozen (historical) version of the campaign details.\n\n(also called by `getCampaignDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.campaignsummary"
      }
    },
    "/api/getCampaignFolderResultsHistory": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsHistory",
        "description": "This API endpoint retrieves the execution history of a campaign (or of a campaign folder). It returns the\nchronological list of the results recorded for all the tests of the campaign or folder scope.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsRequirements": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsRequirements",
        "description": "This API endpoint retrieves the requirements results of a campaign (or of a campaign folder). It returns\nthe detailed results of the tests covering each requirement within the campaign or folder scope.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsRequirementsSummary": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsRequirementsSummary",
        "description": "This API endpoint retrieves a summary of the requirements coverage results of a campaign (or of a\ncampaign folder). It aggregates the test results per requirement to show the verification status of the\ncovered requirements.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "results.resultrequirementssummary"
      }
    },
    "/api/getCampaignFolderResultsSteps": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsSteps",
        "description": "This API endpoint retrieves the step results of a campaign (or of a campaign folder). It returns the\ndetailed outcome of every test step executed within the campaign or folder scope.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsTestProgress": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsTestProgress",
        "description": "This API endpoint retrieves the test execution progress of a campaign (or of a campaign folder) over a\ngiven period. It receives the campaign or folder ID along with a start and a stop date, and returns the\nday-by-day progression of the test results.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsTestcaseProgress": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsTestcaseProgress",
        "description": "This API endpoint retrieves the test case execution progress of a campaign (or of a campaign folder) over\na given period. It receives the campaign or folder ID along with a start and a stop date, and returns the\nday-by-day progression of the test case results.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsTestcases": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsTestcases",
        "description": "This API endpoint retrieves the test case results of a campaign (or of a campaign folder). It returns the\ndetailed results of every test case executed within the campaign or folder scope.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsTests": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsTests",
        "description": "This API endpoint retrieves the test results of a campaign (or of a campaign folder). It returns the\ndetailed results of every test executed within the campaign or folder scope.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignFolderResultsTreeview": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignFolderResultsTreeview",
        "description": "This API endpoint retrieves the results tree of a campaign (or of a campaign folder). It returns the\nhierarchical tree of the sessions, tests and test cases of the campaign along with their execution\nresults.\n\n(also called by `getBugResultsTreeview()`)",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "results.resulttreeview"
      }
    },
    "/api/getCampaignForm": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignForm",
        "description": "This API endpoint retrieves the necessary data to render a campaign creation or modification form. It is used\nto obtain the structure and initial values required for the campaign form.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.campaignform"
      }
    },
    "/api/getCampaignInheritedAttachments": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments that are inherited by a given test campaign. Inherited\nattachments are typically those associated with parent folders or global settings that apply to the campaign.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignLinkedRequirements": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignLinkedRequirements",
        "description": "This API endpoint retrieves a list of requirements that are linked to a given test campaign. The campaign is\nidentified by its unique campaign ID. This allows users to understand the requirement coverage for a specific\ncampaign.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.campaignlinkedreqs"
      }
    },
    "/api/getCampaignLinkedSpecifications": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignLinkedSpecifications",
        "description": "This API endpoint retrieves a list of specifications that are linked to a given test campaign. It uses the\ncampaignId to identify the target campaign and returns the associated specifications.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.campaignlinkedspecs"
      }
    },
    "/api/getCampaignLinkedSuts": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignLinkedSuts",
        "description": "This API endpoint retrieves a list of SUTs that are linked to a given test campaign. The campaign is\nidentified by its unique ID, which is passed as a request parameter. The API returns a JSON string\nrepresenting the linked SUTs.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.campaignlinkedsuts"
      }
    },
    "/api/getCampaignParameters": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignParameters",
        "description": "This API endpoint retrieves the parameters defined on a given campaign. It is used to display the\ncampaign parameter values in the scope of the sessions.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.getcampaignparameters"
      }
    },
    "/api/getCampaignResultsHistory": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsHistory",
        "description": "This API endpoint retrieves the execution history of a campaign (or of a campaign folder). It returns the\nchronological list of the results recorded for all the tests of the campaign or folder scope.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsRequirements": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsRequirements",
        "description": "This API endpoint retrieves the requirements results of a campaign (or of a campaign folder). It returns\nthe detailed results of the tests covering each requirement within the campaign or folder scope.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsRequirementsSummary": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsRequirementsSummary",
        "description": "This API endpoint retrieves a summary of the requirements coverage results of a campaign (or of a\ncampaign folder). It aggregates the test results per requirement to show the verification status of the\ncovered requirements.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "results.resultrequirementssummary"
      }
    },
    "/api/getCampaignResultsSteps": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsSteps",
        "description": "This API endpoint retrieves the step results of a campaign (or of a campaign folder). It returns the\ndetailed outcome of every test step executed within the campaign or folder scope.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsTestProgress": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsTestProgress",
        "description": "This API endpoint retrieves the test execution progress of a campaign (or of a campaign folder) over a\ngiven period. It receives the campaign or folder ID along with a start and a stop date, and returns the\nday-by-day progression of the test results.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsTestcaseProgress": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsTestcaseProgress",
        "description": "This API endpoint retrieves the test case execution progress of a campaign (or of a campaign folder) over\na given period. It receives the campaign or folder ID along with a start and a stop date, and returns the\nday-by-day progression of the test case results.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsTestcases": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsTestcases",
        "description": "This API endpoint retrieves the test case results of a campaign (or of a campaign folder). It returns the\ndetailed results of every test case executed within the campaign or folder scope.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsTests": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsTests",
        "description": "This API endpoint retrieves the test results of a campaign (or of a campaign folder). It returns the\ndetailed results of every test executed within the campaign or folder scope.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignResultsTreeview": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignResultsTreeview",
        "description": "This API endpoint retrieves the results tree of a campaign (or of a campaign folder). It returns the\nhierarchical tree of the sessions, tests and test cases of the campaign along with their execution\nresults.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "results.resulttreeview"
      }
    },
    "/api/getCampaignSessions": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignSessions",
        "description": "This API endpoint fetches a list of test execution sessions linked to a particular test campaign. It allows\nusers to view the execution history and results for a given campaign, providing insights into the campaign's\nprogress and outcomes.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessions_"
      }
    },
    "/api/getCampaignTests": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignTests",
        "description": "This API endpoint retrieves a list of tests that are part of a given test campaign. It requires a valid\ncampaign ID to identify the target campaign and returns the associated tests.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCampaignsTree": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getCampaignsTree",
        "description": "This API endpoint retrieves the hierarchical tree structure of test campaigns. It allows clients to fetch the\ncampaign organization for display and navigation within the test management system.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.campaignstree"
      }
    },
    "/api/getCategoryAttachments": {
      "get": {
        "tags": [
          "Categories"
        ],
        "operationId": "getCategoryAttachments",
        "description": "This API endpoint retrieves a list of attachments linked to a given category ID. It is used to fetch files or\nresources related to a particular category within the system.",
        "parameters": [
          {
            "name": "categoryId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCategoryDetails": {
      "get": {
        "tags": [
          "Categories"
        ],
        "operationId": "getCategoryDetails",
        "description": "This API endpoint retrieves detailed information about a category based on the provided category ID. It is\nused to fetch category-specific data for display or processing within the XStudio web application.\n\n(also called by `getCategoryDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "categoryId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.categorysummary"
      }
    },
    "/api/getCategoryForm": {
      "get": {
        "tags": [
          "Categories"
        ],
        "operationId": "getCategoryForm",
        "description": "This API endpoint retrieves the form data required for creating or updating categories. It is used to obtain\nthe necessary fields and configurations for category management within the XStudio application.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "categories.categoryform"
      }
    },
    "/api/getCategorySimilarityMatrix": {
      "get": {
        "tags": [
          "Similarity"
        ],
        "operationId": "getCategorySimilarityMatrix",
        "description": "_command forwarded by the wrapper as `getCategorySimilarityMatrix`_",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getChannelDetails": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getChannelDetails",
        "description": "\n\n(also called by `getChannelSummary()`)",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getchanneldetails"
      }
    },
    "/api/getChannelForm": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getChannelForm",
        "description": "This API endpoint retrieves the form describing the editable attributes of a channel (name, description\nand other settings). It is used to build the channel creation and edition dialogs.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.channelform"
      }
    },
    "/api/getChannelPages": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getChannelPages",
        "description": "This API endpoint retrieves a list of pages that belong to a given channel. The channel ID is used to identify\nthe channel and fetch its associated pages, which are likely used for displaying dashboard content.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.channelpages_"
      }
    },
    "/api/getChannelsTree": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getChannelsTree",
        "description": "This API endpoint retrieves the complete tree of the XQual TV dashboard channels, including their\nfolders, channels and pages. An optional cache mode allows reusing the client-side cached tree when it is\nstill up to date.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "clientCacheTimestampUTC",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getchannelstree"
      }
    },
    "/api/getCombinationsOfParameterValues": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "getCombinationsOfParameterValues",
        "description": "This API endpoint calculates and returns combinations of parameter values based on a specified algorithm. It\nis used for generating test data sets for test case execution, allowing for comprehensive testing with various\ninput combinations.",
        "parameters": [
          {
            "name": "algorithm",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.combinationsOfParameterValues",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/getCompanyAttachments": {
      "get": {
        "tags": [
          "Companies"
        ],
        "operationId": "getCompanyAttachments",
        "description": "This API endpoint retrieves a list of attachments related to a given company. It takes the companyId to\nidentify the target company. The attachments are returned as a JSON string.",
        "parameters": [
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getCompanyDetails": {
      "get": {
        "tags": [
          "Companies"
        ],
        "operationId": "getCompanyDetails",
        "description": "This API endpoint retrieves detailed information about a specific company. It takes the companyId as a\nparameter to identify the target company. The API is part of the common utility APIs for server info,\nsettings, and system operations.\n\n(also called by `getCompanyDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.companysummary"
      }
    },
    "/api/getCompanyForm": {
      "get": {
        "tags": [
          "Companies"
        ],
        "operationId": "getCompanyForm",
        "description": "This API endpoint retrieves the company form data associated with the current user session. The data is\nreturned as a JSON string. It is used to populate or manage company-related information within the\napplication.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "companies.companyform"
      }
    },
    "/api/getConfigurationForms": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getConfigurationForms",
        "description": "This API endpoint retrieves configuration forms associated with a specific category. It is used to fetch the\nnecessary form configurations for test campaigns based on the provided category ID.",
        "parameters": [
          {
            "name": "categoryId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.configurationform"
      }
    },
    "/api/getConfigurationsForCategory": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getConfigurationsForCategory",
        "description": "This API endpoint retrieves a list of configurations that are associated with a given category ID. It is used\nto fetch configuration details based on category for campaign management purposes.",
        "parameters": [
          {
            "name": "categoryId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.configurationforcategory"
      }
    },
    "/api/getContentDetails": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getContentDetails",
        "description": "This API endpoint retrieves the details of a given content, including its data source configuration and\ndisplay settings.",
        "parameters": [
          {
            "name": "contentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getcontentdetails"
      }
    },
    "/api/getContentForm": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getContentForm",
        "description": "This API endpoint retrieves the form describing the editable attributes of a content (name, description,\nrefresh settings and other options). It is used to build the content creation and edition dialogs.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getcontentdetailsform"
      }
    },
    "/api/getConvertTestcaseToReusableTestcaseForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getConvertTestcaseToReusableTestcaseForm",
        "description": "This API endpoint retrieves the form of the \"Convert to reusable testcase\" dialog: the name of the reusable test\ncase to create, pre-populated with the name of the test case 'testcaseId'.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.converttestcaseform"
      }
    },
    "/api/getDashboards": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getDashboards",
        "description": "This API endpoint retrieves a list of available dashboards for the current user session. The dashboards are\nreturned as a JSON string.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "dashboardsummary.dashboardgraphics"
      }
    },
    "/api/getDefaultUniqueName": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "getDefaultUniqueName",
        "description": "This API endpoint generates a unique name for a node within the system. It takes into account the node type,\noriginal name, parent ID, and a prefix to ensure uniqueness. This is useful when creating new nodes and\navoiding naming conflicts.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defaultname.defaultuniquename"
      }
    },
    "/api/getDefinitionForm": {
      "get": {
        "tags": [
          "Settings"
        ],
        "operationId": "getDefinitionForm",
        "description": "This API endpoint retrieves the definition form required for XStudio operations. The form is likely used for\ncreating or modifying definitions within the XStudio environment.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.definitionform"
      }
    },
    "/api/getDefinitions": {
      "get": {
        "tags": [
          "Settings"
        ],
        "operationId": "getDefinitions",
        "description": "This API endpoint retrieves definitions necessary for the XStudio Web application's functionality. It is\ntypically used to fetch configuration data or metadata required by the client-side application to render UI\nelements or process data. The definitions are returned as a JSON string.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.definitions"
      }
    },
    "/api/getDirectMessages": {
      "get": {
        "tags": [
          "Chat"
        ],
        "operationId": "getDirectMessages",
        "description": "This API endpoint retrieves direct messages associated with the user's session. It is specifically designed to\nfetch message content accessible from the dashboard, which might not be available through other redirection\nmechanisms.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "dashboardsummary.directmessages"
      }
    },
    "/api/getDiscussion": {
      "get": {
        "tags": [
          "Chat"
        ],
        "operationId": "getDiscussion",
        "description": "This API endpoint retrieves discussion information based on the provided node type and node ID. It is used to\nfetch comments, threads, or other discussion-related data linked to a particular entity within the system.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "discussion.messagelist"
      }
    },
    "/api/getDocumentChanges": {
      "get": {
        "tags": [
          "Document"
        ],
        "operationId": "getDocumentChanges",
        "description": "This API endpoint retrieves the changes made to a document, identified by its document ID. It is used to track\ndocument revisions and updates.",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getDocumentDetails": {
      "get": {
        "tags": [
          "Document"
        ],
        "operationId": "getDocumentDetails",
        "description": "This API endpoint retrieves detailed information about a document, identified by its document ID. It can also\nretrieve details for a frozen version of the document if specified.\n\n(also called by `getDocumentSummary()`)",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.documentdetails"
      }
    },
    "/api/getDocumentRevisions": {
      "get": {
        "tags": [
          "Document"
        ],
        "operationId": "getDocumentRevisions",
        "description": "This API endpoint fetches and returns a list of revisions associated with a given document ID. It provides a\nhistory of changes made to the document, enabling users to track modifications and revert to previous versions\nif needed.",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getDocumentsTree": {
      "get": {
        "tags": [
          "Document"
        ],
        "operationId": "getDocumentsTree",
        "description": "This API endpoint fetches the hierarchical structure of documents, allowing for filtered views and caching\nmechanisms to optimize performance. It is used to display the document organization within the system.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.documentstree"
      }
    },
    "/api/getExploratorySessionAssignedTo": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionAssignedTo",
        "description": "This API endpoint retrieves information about the user currently assigned to a given exploratory testing\nsession. It is used to determine who is actively working on a particular exploratory session within the\ncampaign management system.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessionassignedto"
      }
    },
    "/api/getExploratorySessionAttachments": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionAttachments",
        "description": "This API endpoint retrieves a list of attachments (e.g., files, screenshots, logs) that are associated with a\ngiven exploratory testing session. It is used to access resources generated during the exploratory session for\nanalysis and reporting.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getExploratorySessionAttributes": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionAttributes",
        "description": "This API endpoint retrieves the attributes associated with a given exploratory session. It is used to fetch\ndetails and metadata related to an exploratory testing session based on its ID.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessionattributes"
      }
    },
    "/api/getExploratorySessionBugs": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionBugs",
        "description": "This API endpoint retrieves a list of bugs that have been reported during a given exploratory testing session.\nIt takes the ID of the exploratory session as input.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessionbugs"
      }
    },
    "/api/getExploratorySessionChanges": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionChanges",
        "description": "This API endpoint fetches and returns the changes made during a given exploratory testing session. It is used\nto track modifications and activities within a session identified by its ID.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getExploratorySessionDetails": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionDetails",
        "description": "This API endpoint fetches and returns detailed information about a given exploratory testing session. The\nsession is identified by its unique ID, allowing clients to retrieve specific session data for analysis or\nreporting.\n\n(also called by `getExploratorySessionSummary()`)",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getExploratorySessionDetailsRevision": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionDetailsRevision",
        "description": "This API endpoint fetches the details for a particular revision of an exploratory testing session. It requires\nboth the exploratory session ID and the revision number to retrieve the correct data. The API is used to\naccess historical states or specific versions of an exploratory session's configuration or results.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessiondetailsrevision"
      }
    },
    "/api/getExploratorySessionForm": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionForm",
        "description": "This API endpoint retrieves the necessary form data and structure required to create a new exploratory testing\nsession within the XStudio campaign management system. It is used to present the user with a pre-populated\nform to configure and initiate a new exploratory session.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorySessionForm"
      }
    },
    "/api/getExploratorySessionInheritedAttachments": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments that are inherited by a given exploratory session.\nAttachments may be inherited from parent campaigns or other related entities. The exploratorySessionId is used\nto identify the session.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessioninheritedattachments"
      }
    },
    "/api/getExploratorySessionResults": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionResults",
        "description": "This API endpoint retrieves the results of a given exploratory session, including the annotations and the\nbugs raised by the tester during the session. It is used to draw the session results dashboards.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessionresults"
      }
    },
    "/api/getExploratorySessionRevisions": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionRevisions",
        "description": "This API endpoint fetches the list of revisions associated with a given exploratory session. It allows users\nto track changes and versions of an exploratory session over time, providing an audit trail of modifications.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getExploratorySessionSut": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getExploratorySessionSut",
        "description": "This API endpoint retrieves details about the System Under Test (SUT) associated with a specific exploratory\ntesting session. It requires a valid exploratorySessionId to identify the session. The API is used to provide\ncontext about the testing environment for a particular exploratory session.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.exploratorysessionsut"
      }
    },
    "/api/getExternalBugConnectorForm": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getExternalBugConnectorForm",
        "description": "This API endpoint retrieves the necessary form definition to configure a connection to an external bug\ntracking system. The form definition is likely used to dynamically generate a configuration UI in the client\napplication.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.externaldefectconnectorform"
      }
    },
    "/api/getExternalBugForm": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getExternalBugForm",
        "description": "This API endpoint retrieves the necessary form definition to create a bug in an external bug tracking system.\nIt uses the provided connector index and project name to fetch the appropriate form structure.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.externaldefectform"
      }
    },
    "/api/getExternalBugProjectForm": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getExternalBugProjectForm",
        "description": "This API retrieves the necessary form data to create a project within an external bug tracking system. The\nform is specific to the connector identified by the connector index.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.externaldefectprojectform"
      }
    },
    "/api/getExternalFolderDetails": {
      "get": {
        "tags": [
          "Folders"
        ],
        "operationId": "getExternalFolderDetails",
        "description": "This API endpoint fetches detailed information about a specific folder located within an external connector.\nIt uses the connector index, folder ID, and tree type to identify the folder.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "folder.folderdetails"
      }
    },
    "/api/getExternalRequirementForm": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getExternalRequirementForm",
        "description": "This API retrieves a form used for creating requirements from an external system. It requires a connector\nindex and project name to identify the external system and project to retrieve the form from.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.externalrequirementform"
      }
    },
    "/api/getFilteredTeams": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getFilteredTeams",
        "description": "This API endpoint retrieves a list of teams, potentially filtered based on user roles, permissions, or other\ncriteria related to the user's session. The filtering logic is encapsulated server-side in the\n`getFilteredTeams` method.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.selectedTeam"
      }
    },
    "/api/getFolderAttachments": {
      "get": {
        "tags": [
          "Folders"
        ],
        "operationId": "getFolderAttachments",
        "description": "This API endpoint retrieves a list of attachments associated with a given folder ID. It is used to display the\nfiles contained within a folder in the user interface.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getFolderDetails": {
      "get": {
        "tags": [
          "Folders"
        ],
        "operationId": "getFolderDetails",
        "description": "This API endpoint retrieves detailed information about a folder, identified by its unique ID. It is used to\nprovide folder-specific metadata to the client application.\n\n(also called by `getFolderDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.foldersummary"
      }
    },
    "/api/getFolderForm": {
      "get": {
        "tags": [
          "Folders"
        ],
        "operationId": "getFolderForm",
        "description": "This API endpoint retrieves the configuration required to render a folder creation or modification form. It is\ntypically used to dynamically generate the UI for folder management operations.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "folder.folderform"
      }
    },
    "/api/getFolderInheritedAttachments": {
      "get": {
        "tags": [
          "Folders"
        ],
        "operationId": "getFolderInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments that are inherited by a specific folder. Inheritance is\nbased on the folder hierarchy and configuration within the system. It takes the folder ID as input.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getFolderSimilarityMatrix": {
      "get": {
        "tags": [
          "Similarity"
        ],
        "operationId": "getFolderSimilarityMatrix",
        "description": "_command forwarded by the wrapper as `getFolderSimilarityMatrix`_",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getGenericBugForm": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "getGenericBugForm",
        "description": "This API endpoint retrieves a generic bug form, likely containing fields and options necessary for submitting\na new bug or defect report. The form is dynamically generated based on the application's configuration and\nuser session.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.genericdefectform"
      }
    },
    "/api/getGenericRequirementForm": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getGenericRequirementForm",
        "description": "This API endpoint retrieves a generic requirement form. It is used to obtain a pre-defined form structure for\ncreating new requirements within the system. The form is dynamically generated based on the application's\nconfiguration.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.requirementform"
      }
    },
    "/api/getLicense": {
      "get": {
        "tags": [
          "Administration"
        ],
        "operationId": "getLicense",
        "description": "This API endpoint retrieves the license details for the XStudio application. It returns a JSON string\ncontaining information about the license, such as its type, expiration date, and enabled features.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.license"
      }
    },
    "/api/getLicenseRemainingDays": {
      "get": {
        "tags": [
          "Administration"
        ],
        "operationId": "getLicenseRemainingDays",
        "description": "This API endpoint retrieves the number of days remaining before the current license expires. It is used\nto warn the users when the license is about to expire.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.getlicenseremainingdays"
      }
    },
    "/api/getLicenseWarning": {
      "get": {
        "tags": [
          "Administration"
        ],
        "operationId": "getLicenseWarning",
        "description": "This API endpoint retrieves a license warning message, typically a JSON string, indicating the status or\nexpiration of the software license. It is used to inform the user about potential licensing issues.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.licencewarning"
      }
    },
    "/api/getLongTaskProgress": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "getLongTaskProgress",
        "description": "This API endpoint retrieves the progress of a given long-running task, identified by its long task ID. It\nreturns the task's status and completion percentage and is typically polled until the task is finished.",
        "parameters": [
          {
            "name": "longTaskId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "longtasks.getlongtaskprogress"
      }
    },
    "/api/getLongTasksList": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "getLongTasksList",
        "description": "This API endpoint retrieves the list of the long-running tasks executed in the background (generations,\nimports, scorings, etc.). It allows the users to monitor the status and the final result of each task.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "longtasks.getlongtaskslist"
      }
    },
    "/api/getMarketplaceCatalog": {
      "get": {
        "tags": [
          "Administration"
        ],
        "operationId": "getMarketplaceCatalog",
        "description": "This API retrieves the catalog of available items from the marketplace. It is designed to provide a list of\navailable products or services that can be accessed through the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "marketplace.catalog"
      }
    },
    "/api/getMessageForm": {
      "get": {
        "tags": [
          "Chat"
        ],
        "operationId": "getMessageForm",
        "description": "This API endpoint retrieves a message form, likely used for displaying system messages or alerts to the user.\nThe form is generated based on the user's session and potentially their role or permissions.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "discussion.messageform"
      }
    },
    "/api/getNewFeatures": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "getNewFeatures",
        "description": "This API endpoint retrieves information about new features available in the application, likely for display on\na user dashboard.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "dashboardsummary.newfeatures"
      }
    },
    "/api/getNodeTreeType": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "getNodeTreeType",
        "description": "This API endpoint fetches the tree type associated with a specific node. The node is identified by its type\nand unique ID. This information is likely used for determining how the node is displayed or processed within a\ntree-like structure in the application.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "search.getnodetreetype"
      }
    },
    "/api/getNumberOfMessagesNotReadYet": {
      "get": {
        "tags": [
          "Chat"
        ],
        "operationId": "getNumberOfMessagesNotReadYet",
        "description": "This API endpoint retrieves the count of direct messages that have not yet been read by the user identified by\nthe provided userId. It is used to display the number of unread messages in the dashboard.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.dashboardnotification"
      }
    },
    "/api/getPageChannel": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getPageChannel",
        "description": "This API endpoint retrieves the channel a given dashboard page belongs to. It is used to navigate from a\npage back to its parent channel.",
        "parameters": [
          {
            "name": "pageId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "search.getpagechannel"
      }
    },
    "/api/getPageDetails": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getPageDetails",
        "description": "\n\n(also called by `getPageChannelSummary()`)",
        "parameters": [
          {
            "name": "pageId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getpagedetails"
      }
    },
    "/api/getPageForm": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getPageForm",
        "description": "This API endpoint retrieves the form describing the editable attributes of a dashboard page of a given\nchannel. It is used to build the page creation and edition dialogs.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getpageform"
      }
    },
    "/api/getPageLayout": {
      "get": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "getPageLayout",
        "description": "This API endpoint retrieves the layout of a given dashboard page, that is the position and the size of\neach content widget placed on the page.",
        "parameters": [
          {
            "name": "pageId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.getpagelayout"
      }
    },
    "/api/getParameterDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getParameterDetails",
        "description": "This API endpoint retrieves detailed information about a test parameter based on its ID and type. It is used\nto fetch specific parameter configurations or properties within the test management system.",
        "parameters": [
          {
            "name": "parameterId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.parameterformdetails"
      }
    },
    "/api/getParameterForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getParameterForm",
        "description": "This API endpoint retrieves the parameter form required for executing a test case or test suite. The form is\ndynamically generated based on the test's configuration and is used to collect necessary input values from the\nuser before execution.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.parameterformdetails"
      }
    },
    "/api/getParameters": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getParameters",
        "description": "This API endpoint retrieves parameters related to test execution. It is designed to provide configuration\ndetails necessary for running tests within the XStudio environment. The parameters are specific to the user's\nsession.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getProfile": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getProfile",
        "description": "This API endpoint retrieves a user profile based on the provided profile ID. It returns the profile data in\nJSON format.",
        "parameters": [
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.profilebyid"
      }
    },
    "/api/getProfiles": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getProfiles",
        "description": "This API endpoint retrieves user profile details associated with the current session. It is available from API\nversion 11 onwards.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.profiles"
      }
    },
    "/api/getReportForm": {
      "get": {
        "tags": [
          "Reports"
        ],
        "operationId": "getReportForm",
        "description": "This API endpoint retrieves a report form configuration. The form is determined by the provided tree type,\nnode type, and desired file extension. The API is intended to provide a dynamic form structure for report\ngeneration based on the context of the request.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fileExtension",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reports.reportform"
      }
    },
    "/api/getRequirementAttachments": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementAttachments",
        "description": "This API endpoint retrieves a list of attachments linked to a given requirement ID. It is used to provide\naccess to supporting documents and files related to a particular requirement within the system.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementChanges": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementChanges",
        "description": "This API endpoint retrieves the change history associated with a given requirement ID. It allows users to\ntrack modifications and updates made to a requirement over time, providing an audit trail of changes.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementCoverageSpecifications": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementCoverageSpecifications",
        "description": "This API retrieves the coverage specifications associated with a specific requirement, filtered by a given\nconnector index. It is used to determine how a requirement is covered by different elements within a project.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementCoverageTests": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementCoverageTests",
        "description": "This API endpoint retrieves a list of tests associated with a given requirement. It uses the connector index\nand requirement ID to identify the requirement and fetch its associated tests. This is useful for determining\nthe test coverage of a particular requirement.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementDetails": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementDetails",
        "description": "This API retrieves detailed information about a specific requirement based on the provided connector index,\nrequirement ID, and frozen status. It is used for requirement tracking and management within the XStudio Web\napplication.\n\n(also called by `getRequirementDetails()`)",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.requirementsummary"
      }
    },
    "/api/getRequirementDetailsRevision": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementDetailsRevision",
        "description": "This API endpoint fetches the details of a requirement based on its ID and a specific revision number. It is\nused to access historical versions of requirements for auditing or comparison purposes.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.requirementdetailsrevision"
      }
    },
    "/api/getRequirementFolderFullTraceability": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementFolderFullTraceability",
        "description": "This API endpoint retrieves the full traceability matrix for requirement folders. It supports fetching\ntraceability for the root folder, specific folders, or connectors based on the provided parameters. The API is\navailable from version 11 onwards.\n\n(also called by `getRequirementFolderFullTraceability()`)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementFolderInnerTraceability": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementFolderInnerTraceability",
        "description": "This API endpoint retrieves the inner traceability matrix for a specified requirement folder. It supports\nfetching traceability for the root folder, a specific folder, or a virtual connector folder based on the\nprovided parameters. The API is available from version 11 onwards.\n\n(also called by `getRequirementFolderInnerTraceability()`)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "relationships.relationship"
      }
    },
    "/api/getRequirementForm": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementForm",
        "description": "This API endpoint retrieves the requirement form, which is likely a JSON structure containing the necessary\nfields and metadata for creating or updating requirement records. It is used to obtain the structure needed\nfor submitting requirement data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.requirementform"
      }
    },
    "/api/getRequirementFreezeStatus": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementFreezeStatus",
        "description": "This API endpoint is used to determine whether a given requirement is currently frozen. Freezing a requirement\ntypically prevents modifications to it. The API requires a requirement ID as input and returns the freeze\nstatus.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.requirementfreezestatus"
      }
    },
    "/api/getRequirementFullTraceability": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementFullTraceability",
        "description": "This API retrieves the complete traceability graph for one or more requirements, starting from the specified\nconnector. It allows users to understand the relationships and dependencies of requirements within the system.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementInheritedAttachments": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementInheritedAttachments",
        "description": "This API retrieves a list of attachments that are inherited by a given requirement, likely from parent\nrequirements or a shared project context. It is used to provide a complete view of all attachments relevant to\na requirement, including those not directly associated with it.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementInnerTraceability": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementInnerTraceability",
        "description": "This API retrieves the inner traceability details for one or more requirements, based on the provided\nconnector index and requirement IDs. It allows users to trace the relationships and dependencies within the\nspecified requirements.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "relationships.relationship"
      }
    },
    "/api/getRequirementLinkedBugs": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementLinkedBugs",
        "description": "This API retrieves a list of bugs that are linked to a specified requirement within a given connector. It is\nused for requirement traceability and impact analysis.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.requirementdefects"
      }
    },
    "/api/getRequirementLinkedRequirements": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementLinkedRequirements",
        "description": "This API retrieves a list of requirements that are linked to one or more specified requirements through a\nconnector. It is used to trace dependencies and relationships between requirements within a project.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.reqlinkedreqs"
      }
    },
    "/api/getRequirementLinkedSpecifications": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementLinkedSpecifications",
        "description": "This API retrieves a list of specifications that are linked to the provided requirement IDs, based on the\nspecified connector index. It is used to trace the relationship between requirements and specifications within\nthe system.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.reqlinkedspecs"
      }
    },
    "/api/getRequirementLinkedSuts": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementLinkedSuts",
        "description": "This API retrieves a list of SUTs that are linked to the provided requirement IDs, using the specified\nconnector index. It is used for requirement traceability and impact analysis, allowing users to identify which\nSUTs are affected by changes to specific requirements.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.reqlinkedsuts"
      }
    },
    "/api/getRequirementLinkedTests": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementLinkedTests",
        "description": "This API endpoint retrieves a list of tests linked to specific requirements. It is available from API version\n11 onwards. The API uses the connector index to identify the data source and the requirement IDs to filter\nthe linked tests.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.reqlinkedtests_"
      }
    },
    "/api/getRequirementResultsSteps": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementResultsSteps",
        "description": "This API endpoint retrieves the execution results of test cases associated with a given requirement. It allows\nusers to track the status of requirements based on the outcome of related test executions. The API is\navailable from version 11 onwards.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementResultsTestcases": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementResultsTestcases",
        "description": "This API endpoint retrieves the test case execution results linked to a particular requirement. It requires a\nconnector index and a requirement ID to identify the requirement and its associated test results. The API is\navailable from version 11 onwards.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementResultsTests": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementResultsTests",
        "description": "This API endpoint fetches the test results linked to a particular requirement, identified by its ID and\nconnector index. It is used to track the verification status of requirements through associated tests.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementRevisions": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementRevisions",
        "description": "This API endpoint retrieves a list of revisions for a given requirement ID. It allows users to track changes\nmade to a requirement over time, providing an audit trail of modifications.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getRequirementTypes": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementTypes",
        "description": "This API endpoint retrieves a list of requirement types that can be used within the system. It is available\nfrom API version 11 onwards.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.requirementtypes"
      }
    },
    "/api/getRequirementsTree": {
      "get": {
        "tags": [
          "Requirements"
        ],
        "operationId": "getRequirementsTree",
        "description": "This API endpoint fetches a tree representation of requirements, allowing clients to filter the results based\non various criteria. It supports filtering by treeFilter, onlyIntegrated flag, caching options, and\nclient-side cache duration. The endpoint also enforces idempotency using the X-Request-ID header.",
        "parameters": [
          {
            "name": "onlyIntegrated",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.requirementstree"
      }
    },
    "/api/getReusableTestcaseChanges": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseChanges",
        "description": "This API endpoint retrieves the changes associated with a given reusable test case. It allows tracking\nmodifications and updates made to reusable test cases, providing a history of changes for auditing or review\npurposes.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getReusableTestcaseDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseDetails",
        "description": "This API endpoint retrieves detailed information about a specific reusable test case based on its ID. It is\nused to fetch the properties and attributes associated with the reusable test case, allowing users to view and\nmanage reusable test case definitions.\n\n(also called by `getReusableTestcaseDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.reusabletestcasesummary"
      }
    },
    "/api/getReusableTestcaseDetailsRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseDetailsRevision",
        "description": "This API endpoint fetches the details of a reusable test case for a given revision number. It allows users to\naccess historical versions of reusable test cases, enabling auditability and comparison of changes over time.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.reusabletestcasedetailsrevision"
      }
    },
    "/api/getReusableTestcaseForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseForm",
        "description": "This API endpoint retrieves the necessary form structure (likely a JSON schema or similar) required to\ndynamically render a form for creating a new reusable test case. The form structure is used by the client to\ngenerate the UI elements for inputting test case data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.reusabletestcaseform"
      }
    },
    "/api/getReusableTestcaseProcedure": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseProcedure",
        "description": "This API endpoint retrieves the detailed procedure, typically a list of steps or actions, defined for a\nspecific reusable test case. It is used to fetch the content of a reusable test case based on its ID.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.reusabletestcaseprocedure"
      }
    },
    "/api/getReusableTestcaseProcedureRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseProcedureRevision",
        "description": "This API endpoint retrieves a specific revision of a reusable test case procedure based on the provided\nreusable test case ID and revision number. It is used to access historical versions of reusable test case\nprocedures.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.reusabletestcaseprocedurerevision"
      }
    },
    "/api/getReusableTestcaseRevisions": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseRevisions",
        "description": "This API endpoint fetches and returns a list of revisions associated with a given reusable test case ID. It\nallows users to track changes and versions of reusable test cases over time.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getReusableTestcaseTests": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getReusableTestcaseTests",
        "description": "This API endpoint retrieves a list of tests that utilize a given reusable test case. It is used to determine\nthe impact of changes to a reusable test case by identifying the tests that depend on it.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.reusabletestcasetests"
      }
    },
    "/api/getScheduleAgents": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleAgents",
        "description": "This API endpoint retrieves a list of test agents that are assigned to a particular schedule. The schedule is\nidentified by its unique ID, which is passed as a parameter in the request.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.agents"
      }
    },
    "/api/getScheduleAttributes": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleAttributes",
        "description": "This API endpoint fetches the attributes of a schedule based on the provided schedule ID. It is used to\nretrieve details and configuration settings of a scheduled campaign.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.getscheduleattributes"
      }
    },
    "/api/getScheduleConfigurations": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleConfigurations",
        "description": "This API endpoint retrieves the configuration details associated with a given schedule ID. It is used to fetch\nthe settings and parameters of a specific schedule, allowing users to view and manage schedule configurations.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.scheduleconfigurations"
      }
    },
    "/api/getScheduleDetails": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleDetails",
        "description": "This API endpoint fetches detailed information about a test schedule based on the provided schedule ID. It\nallows retrieving schedule details, potentially including frozen versions.\n\n(also called by `getScheduleSummary()`)",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.scheduledetails"
      }
    },
    "/api/getScheduleFollowers": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleFollowers",
        "description": "This API endpoint fetches the user accounts that are following a particular schedule. It is used to determine\nwhich users are subscribed to receive updates or notifications related to the schedule's execution or status\nchanges.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.followers"
      }
    },
    "/api/getScheduleForm": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleForm",
        "description": "This API endpoint retrieves the necessary form data required to display the schedule creation/editing form\nwithin the campaign management section. It is used to obtain the structure and initial values needed for users\nto define or modify campaign schedules.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.scheduleform.schedules"
      }
    },
    "/api/getScheduleOperator": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleOperator",
        "description": "This API endpoint fetches the user or operator responsible for a given schedule, identified by its schedule\nID. It is used to determine who is assigned to manage or execute a particular schedule within the system.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.operator"
      }
    },
    "/api/getScheduleParams": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleParams",
        "description": "This API endpoint retrieves the parameters associated with a specific schedule. It is used to fetch the\nconfiguration details of a scheduled test campaign, such as execution time, frequency, and target SUTs.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getScheduleScheduling": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleScheduling",
        "description": "This API endpoint retrieves the scheduling details for a given schedule ID. It allows fetching schedule\ninformation, potentially considering whether the schedule is in a frozen state.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.scheduling"
      }
    },
    "/api/getScheduleSessions": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleSessions",
        "description": "This API endpoint retrieves session information related to a particular schedule. It is used to fetch details\nabout the sessions that have been executed or are planned for a given schedule, providing insights into the\nschedule's activity.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.sessions_"
      }
    },
    "/api/getScheduleSut": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getScheduleSut",
        "description": "This API endpoint retrieves a list of Systems Under Test (SUTs) that are linked to a particular schedule,\nidentified by its schedule ID. The API is used to determine which SUTs are targeted by a given schedule.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.sut"
      }
    },
    "/api/getServerSettingsForm": {
      "get": {
        "tags": [
          "Settings"
        ],
        "operationId": "getServerSettingsForm",
        "description": "This API endpoint retrieves the necessary data to render the server settings form in the user interface. It is\nused to display and configure server-specific settings.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.serversettingsform"
      }
    },
    "/api/getSessionAgents": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionAgents",
        "description": "This API endpoint retrieves a list of test agents that participated in a given test execution session. It\nallows filtering by session ID and optionally by a specific agent ID.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessionagents"
      }
    },
    "/api/getSessionAttachments": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionAttachments",
        "description": "This API endpoint retrieves a list of attachments that are linked to a particular test execution session. The\nsession is identified by its unique session ID. The API is used to access files and documents related to a\nspecific test session.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionAttributes": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionAttributes",
        "description": "This API endpoint retrieves session attributes stored on the server, given a session ID. It is used to access\nand manage session-specific data for a user.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.getsessionattributes"
      }
    },
    "/api/getSessionBugs": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionBugs",
        "description": "This API endpoint retrieves a list of bugs linked to a particular test session. It requires a valid session ID\nto identify the target test session and returns bug details in JSON format.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessionbugs"
      }
    },
    "/api/getSessionCampaign": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionCampaign",
        "description": "This API endpoint retrieves the campaign information linked to a particular test execution session. It uses\nthe session ID to identify the relevant campaign data.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "search.getsessioncampaign"
      }
    },
    "/api/getSessionConfigurations": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionConfigurations",
        "description": "This API endpoint retrieves the configurations associated with a specific test execution session. It requires\na valid session ID to identify the target session and returns the configuration details as a JSON string.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessionconfigurations"
      }
    },
    "/api/getSessionDetails": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionDetails",
        "description": "This API endpoint retrieves detailed information about a test execution session, identified by its session ID.\nIt allows fetching session details, potentially including whether the session is frozen or not. The API is\npart of the campaign management functionality.\n\n(also called by `getSessionDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.sessionsummary"
      }
    },
    "/api/getSessionFollowers": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionFollowers",
        "description": "This API endpoint retrieves a list of users who are following a particular test execution session. The session\nID is used to identify the target session for which to retrieve the followers.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessionfollowers"
      }
    },
    "/api/getSessionForm": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionForm",
        "description": "This API endpoint fetches the session form data associated with a given campaign ID. The session form likely\ncontains information related to the test execution session within the context of the specified campaign.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessionform"
      }
    },
    "/api/getSessionFreezeStatus": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionFreezeStatus",
        "description": "This API endpoint is used to determine whether a given test execution session is currently frozen, preventing\nfurther modifications. It requires a valid session ID to identify the target session.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessionfreezestatus"
      }
    },
    "/api/getSessionOperator": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionOperator",
        "description": "This API endpoint retrieves information about the operator (user) currently associated with a given session\nID. It allows clients to identify the user who is actively using a particular session.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessionoperator"
      }
    },
    "/api/getSessionParams": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionParams",
        "description": "This API endpoint fetches session-specific parameters based on the provided session ID. It is used to retrieve\nconfiguration details or runtime information related to a particular test session, which can be used for\nreporting or analysis.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionResultsStatistics": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionResultsStatistics",
        "description": "This API endpoint fetches statistical data related to a test execution session, identified by its session ID.\nIt provides insights into the session's progress and results.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionResultsSteps": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionResultsSteps",
        "description": "This API endpoint retrieves the test case results associated with a given test execution session. It requires\na valid session ID to identify the target session and returns the results in JSON format.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionResultsTestcases": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionResultsTestcases",
        "description": "This API endpoint retrieves the test case results associated with a given test session ID. It allows users to\nview the outcome of individual test cases within a specific session, providing detailed insights into the test\nexecution process.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionResultsTests": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionResultsTests",
        "description": "This API endpoint retrieves the test results associated with a given session ID. It is used to fetch the\noutcome of tests executed within a particular session, allowing users to analyze test performance and identify\npotential issues.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionSut": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionSut",
        "description": "This API endpoint retrieves the SUT details linked to a given test session. It is used to identify the system\nbeing tested within the context of a particular session, allowing for session-specific SUT information\nretrieval.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.sessionsut"
      }
    },
    "/api/getSessionTestBugs": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestBugs",
        "description": "This API endpoint retrieves the bugs linked to a given test executed within a session. The results can\noptionally be restricted to a specific test instance, agent or agent instance.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.getsessiontestdefects"
      }
    },
    "/api/getSessionTestDataForBug": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestDataForBug",
        "description": "This API endpoint retrieves test session data related to a bug, using the session ID, test ID, and an optional\nexternal format parameter. The data is returned in a JSON format.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "externalFormat",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessiontestdataforexternalbug"
      }
    },
    "/api/getSessionTestcaseAttachments": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestcaseAttachments",
        "description": "This API endpoint retrieves a list of attachments related to a particular test case instance executed during a\ntest session. It requires the session ID, test case ID, agent ID, and instance index to identify the specific\ntest case execution.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "instanceIndex",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSessionTestcaseDataForBug": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestcaseDataForBug",
        "description": "This API endpoint fetches test case data related to a given session and test case ID. It allows specifying an\nexternal format for the data, enabling integration with other systems or tools. The data is likely related to\na bug or defect found during the session.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "externalFormat",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessiontestcasedataforexternalbug"
      }
    },
    "/api/getSessionTestcaseForExecution": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestcaseForExecution",
        "description": "This API endpoint retrieves a test case identified by its ID for execution within the context of a specific\nsession. It is used to fetch the necessary test case data before starting or continuing a test execution\nsession.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessiontestcasesforexec"
      }
    },
    "/api/getSessionTestcaseMessages": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestcaseMessages",
        "description": "This API endpoint fetches messages related to a particular test case instance executed during a test session.\nIt allows filtering messages based on session ID, test case ID, agent ID, and instance index to pinpoint\nspecific execution details.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessiontestcasemessages"
      }
    },
    "/api/getSessionTestcaseResults": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestcaseResults",
        "description": "This API endpoint retrieves the test case results associated with a particular test execution session, test\nidentifier, agent, and instance index. It is used to fetch detailed results for individual test case\nexecutions within a campaign.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "instanceIndex",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessiontestcaseresults"
      }
    },
    "/api/getSessionTestsAndTestcasesForExecution": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestsAndTestcasesForExecution",
        "description": "This API endpoint fetches the list of tests and test cases that are part of a given execution session. It\nallows clients to retrieve the details of tests and test cases scheduled for execution within a specific\nsession, optionally including session messages.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeMessages",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessiontestsandtestcases"
      }
    },
    "/api/getSessionTestsAndTestcasesResults": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "getSessionTestsAndTestcasesResults",
        "description": "This API endpoint retrieves the results of tests and test cases associated with a given session, agent, and\ninstance index. It is used to fetch detailed execution data for test campaigns.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessionresulttestsandtestcases"
      }
    },
    "/api/getSettings": {
      "get": {
        "tags": [
          "Settings"
        ],
        "operationId": "getSettings",
        "description": "This API endpoint retrieves various application settings specific to the user's current session. These\nsettings may include user preferences, system configurations, or other parameters that affect the user's\nexperience within the application.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.settings"
      }
    },
    "/api/getSignatureForm": {
      "get": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "getSignatureForm",
        "description": "This API endpoint retrieves the necessary data to render a signature form. It is typically used to obtain the\nstructure and initial values for a form that requires a user's signature.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.digitalsignform"
      }
    },
    "/api/getSignatureLog": {
      "get": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "getSignatureLog",
        "description": "This API endpoint retrieves the signature log associated with the current user's session. The signature log\nlikely contains information about actions performed by the user that require a digital signature, such as\napprovals or modifications to sensitive data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signaturelog"
      }
    },
    "/api/getSimilarBugs": {
      "get": {
        "tags": [
          "Bugs",
          "Similarity"
        ],
        "operationId": "getSimilarBugs",
        "description": "This API endpoint retrieves the bugs similar to a given bug. It is used by the similarity search feature\nto detect potential duplicates or closely related defects.",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSimilarRequirements": {
      "get": {
        "tags": [
          "Requirements",
          "Similarity"
        ],
        "operationId": "getSimilarRequirements",
        "description": "This API endpoint retrieves the requirements similar to a given requirement. It is used by the similarity\nsearch feature to detect potential duplicates or closely related requirements.",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSimilarSpecifications": {
      "get": {
        "tags": [
          "Specifications",
          "Similarity"
        ],
        "operationId": "getSimilarSpecifications",
        "description": "This API endpoint retrieves the specifications similar to a given specification. It is used by the\nsimilarity search feature to detect potential duplicates or closely related specifications.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSimilarTestcases": {
      "get": {
        "tags": [
          "Tests",
          "Similarity"
        ],
        "operationId": "getSimilarTestcases",
        "description": "This API endpoint retrieves the test cases similar to a given test case or reusable test case (depending\non the provided type). It is used by the similarity search feature to detect potential duplicates or\nclosely related test cases.",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSimilarTests": {
      "get": {
        "tags": [
          "Tests",
          "Similarity"
        ],
        "operationId": "getSimilarTests",
        "description": "This API endpoint retrieves the tests similar to a given test. It is used by the similarity search\nfeature to detect potential duplicates or closely related tests.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationAttachments": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationAttachments",
        "description": "This API endpoint retrieves a list of attachments linked to a given specification. It is used to access\nsupporting documents and files related to test specifications or documentation within the XStudio system.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationChanges": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationChanges",
        "description": "This API endpoint retrieves the changes made to a specific specification, identified by its ID. It is used to\ntrack modifications and updates to test specifications or documentation within the XStudio environment.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationCoverageTests": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationCoverageTests",
        "description": "This API endpoint retrieves a list of tests associated with a given specification. It is used to determine the\ntest coverage for a particular specification based on its ID.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationDetails": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationDetails",
        "description": "This API endpoint retrieves detailed information about a test specification based on its ID. It allows\nfetching details for both frozen and non-frozen specifications. The API is available from version 10 onwards.\n\n(also called by `getSpecificationDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.specificationsummary"
      }
    },
    "/api/getSpecificationDetailsRevision": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationDetailsRevision",
        "description": "This API endpoint retrieves the detailed information for a particular revision of a given specification. It is\nused to access historical versions of specifications, providing a snapshot of the specification at that point\nin time.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.specificationdetailsrevision"
      }
    },
    "/api/getSpecificationFolderFullTraceability": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationFolderFullTraceability",
        "description": "This API endpoint retrieves the complete traceability data associated with a given specification folder. The\nfolder can be the root folder or any other folder within the specification hierarchy. The traceability\ninformation is returned as a JSON string.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationForm": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationForm",
        "description": "This API endpoint retrieves the specification form, likely used for creating or modifying test specifications\nand related documentation. It is part of the specification management functionality within the XStudio Web\napplication.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.specificationform"
      }
    },
    "/api/getSpecificationFreezeStatus": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationFreezeStatus",
        "description": "This API endpoint is used to determine whether a given specification is currently frozen, preventing\nmodifications. It requires a specification ID to identify the target specification and returns its freeze\nstatus.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.specificationfreezestatus"
      }
    },
    "/api/getSpecificationFullTraceability": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationFullTraceability",
        "description": "This API endpoint retrieves the complete traceability details for one or more specifications, identified by\ntheir IDs. It allows users to trace the relationships and dependencies of a specification within the system.",
        "parameters": [
          {
            "name": "specificationIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationInheritedAttachments": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments inherited by a given specification. Inheritance is based on\nthe specification's configuration and hierarchy within the system.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationLinkedBugs": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationLinkedBugs",
        "description": "This API endpoint retrieves a list of bugs that are linked to a given specification. It is used to provide\ntraceability between specifications and reported defects, aiding in requirements management and testing\nefforts.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.specificationdefects"
      }
    },
    "/api/getSpecificationLinkedRequirements": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationLinkedRequirements",
        "description": "This API endpoint retrieves a list of requirements that are linked to the provided specification IDs. It\nallows users to identify the requirements associated with specific specifications within the system.",
        "parameters": [
          {
            "name": "specificationIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.speclinkedreqs"
      }
    },
    "/api/getSpecificationLinkedSpecifications": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationLinkedSpecifications",
        "description": "This API endpoint retrieves a list of specifications that are linked to the specifications identified by the\nprovided IDs. It is used for managing and exploring relationships between specifications within the system.",
        "parameters": [
          {
            "name": "specificationIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.speclinkedspecs"
      }
    },
    "/api/getSpecificationLinkedSuts": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationLinkedSuts",
        "description": "This API endpoint retrieves a list of SUTs that are associated with the provided specification IDs. It is used\nto determine which systems are being tested by a given specification. The API is available from version 10\nonwards.",
        "parameters": [
          {
            "name": "specificationIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.speclinkedsuts"
      }
    },
    "/api/getSpecificationLinkedTests": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationLinkedTests",
        "description": "This API endpoint retrieves a list of test cases that are linked to the specified specification(s). It accepts\na comma-separated list of specification IDs and returns the associated tests.",
        "parameters": [
          {
            "name": "specificationIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.speclinkedtests"
      }
    },
    "/api/getSpecificationResultsSteps": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationResultsSteps",
        "description": "This API endpoint retrieves the test case results steps associated with a specific specification. It requires\na valid 'specificationId' to identify the target specification and returns the results in JSON format.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationResultsTestcases": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationResultsTestcases",
        "description": "This API endpoint retrieves the test case results associated with a given specification ID. It is used to\nfetch and display the results of test executions performed against a particular specification, providing\ninsights into the specification's compliance and quality.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationResultsTests": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationResultsTests",
        "description": "This API endpoint retrieves the test results associated with a given specification ID. It is used to fetch and\ndisplay the outcome of tests performed against a specification, providing insights into its quality and\ncompliance.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationRevisions": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationRevisions",
        "description": "This API endpoint retrieves a list of revisions for a given specification, identified by its specification ID.\nIt allows users to track changes and versions of a specification over time.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSpecificationsTree": {
      "get": {
        "tags": [
          "Specifications"
        ],
        "operationId": "getSpecificationsTree",
        "description": "This API endpoint retrieves a hierarchical tree representation of specifications, likely for display in a user\ninterface. It allows filtering and caching of the specification tree data. The API is versioned.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.specificationstree"
      }
    },
    "/api/getSqlReportChanges": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportChanges",
        "description": "This API endpoint retrieves the changes associated with a given SQL report, identified by its ID. It is used\nto track modifications or updates made to the report definition or data.",
        "parameters": [
          {
            "name": "sqlReportId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSqlReportDetails": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportDetails",
        "description": "This API endpoint fetches and returns the details of an SQL report based on the provided SQL report ID. The\nreport details are returned as a JSON string.\n\n(also called by `getSqlReportDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sqlReportId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.sqlreportsummary"
      }
    },
    "/api/getSqlReportDetailsRevision": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportDetailsRevision",
        "description": "This API endpoint retrieves the details of a particular revision of an SQL report, identified by its ID and\nrevision number. It is used to access historical versions of SQL reports.",
        "parameters": [
          {
            "name": "sqlReportId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.sqlreportdetailsrevision"
      }
    },
    "/api/getSqlReportForm": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportForm",
        "description": "This API endpoint retrieves the necessary form structure and metadata required to render a user interface for\ncreating or modifying SQL reports. The form definition is returned as a JSON string.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.sqlreportform"
      }
    },
    "/api/getSqlReportOutput": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportOutput",
        "description": "This API endpoint retrieves the output generated by executing a specified SQL report. The report is identified\nby its unique ID. The output is returned as a JSON string.",
        "parameters": [
          {
            "name": "sqlReportId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.sqlreportoutput"
      }
    },
    "/api/getSqlReportRevisions": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportRevisions",
        "description": "This API endpoint fetches and returns a list of revisions associated with a given SQL report ID. It allows\nusers to track changes and versions of SQL reports over time.",
        "parameters": [
          {
            "name": "sqlReportId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSqlReportsTree": {
      "get": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "getSqlReportsTree",
        "description": "This API endpoint fetches the hierarchical tree structure representing available SQL reports. It allows for\noptional caching control via parameters.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.sqlreportstree"
      }
    },
    "/api/getSsoSettings": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "operationId": "getSsoSettings",
        "description": "This API endpoint retrieves the current SSO configuration settings. It is used to obtain information about how\nthe application is configured to authenticate users via SSO.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.ssosettings"
      }
    },
    "/api/getSsoSettingsForm": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "operationId": "getSsoSettingsForm",
        "description": "This API retrieves the form used to configure Single Sign-On (SSO) settings. It is intended for administrative\ninterfaces to allow modification of SSO parameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.ssosettingsform"
      }
    },
    "/api/getStatementSimilarityMatrix": {
      "get": {
        "tags": [
          "Tests",
          "Similarity"
        ],
        "operationId": "getStatementSimilarityMatrix",
        "parameters": [
          {
            "name": "statementType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "similaritymatrix.similaritymatrix"
      }
    },
    "/api/getStatementTests": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getStatementTests",
        "description": "This API endpoint retrieves a list of tests that are linked to a particular Gherkin statement, identified by\nits statement ID. It is used to trace the relationship between Gherkin statements and the tests that validate\nthem.",
        "parameters": [
          {
            "name": "statementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "gherkin.statementtests"
      }
    },
    "/api/getStatements": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getStatements",
        "description": "This API endpoint retrieves Gherkin statements. When a 'statementType' is provided, it returns basic\ninformation for use in the editor. Otherwise, it's used in the statement management panel to retrieve more\ndetailed information.",
        "parameters": [
          {
            "name": "_v",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "gherkin.givenstatements"
      }
    },
    "/api/getStatementsByIds": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getStatementsByIds",
        "description": "This API endpoint retrieves the Gherkin statements matching a comma-separated list of statement IDs. It is\nused to resolve only the steps referenced by a Gherkin test instead of loading the whole catalog. callback\nis optional, called with the raw response either way (also broadcast, like every other call here).",
        "parameters": [
          {
            "name": "statementIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "_v",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "gherkin.statementsbyids"
      }
    },
    "/api/getSutAttachments": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutAttachments",
        "description": "This API endpoint retrieves a list of attachments related to a given System Under Test (SUT). It takes the SUT\nID to identify the target SUT. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutChanges": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutChanges",
        "description": "This API endpoint retrieves the changes associated with a given System Under Test (SUT). It takes the SUT ID\nto identify the target SUT and fetch its changes. The changes are returned as a JSON string.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutCometTestsPrioritization": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutCometTestsPrioritization",
        "description": "This API endpoint fetches the prioritized list of tests for a given System Under Test (SUT) within the context\nof a specific campaign. The prioritization is likely used by the Comet test execution engine to determine the\norder in which tests should be run.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutscomettestsprioritization",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/getSutCoverageRequirements": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutCoverageRequirements",
        "description": "This API endpoint retrieves the coverage requirements associated with a given System Under Test (SUT). It\ntakes the SUT ID to identify the specific SUT for which coverage requirements are needed. The API is\navailable from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutCoverageSpecifications": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutCoverageSpecifications",
        "description": "This API endpoint retrieves the coverage specifications associated with a given System Under Test (SUT). It\ntakes the SUT ID to identify the target SUT.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutCoverageTests": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutCoverageTests",
        "description": "This API endpoint retrieves a list of coverage tests associated with a given System Under Test (SUT). The SUT\nis identified by its unique ID. This API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutCustomFields": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutCustomFields",
        "description": "This API endpoint retrieves the custom fields defined for a given System Under Test (SUT). It takes the SUT ID\nas input. The custom fields are returned as a JSON string.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutcustomfields"
      }
    },
    "/api/getSutDefectsFixedIn": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutDefectsFixedIn",
        "description": "This API endpoint retrieves a list of defects that have been marked as fixed within a given System Under Test\n(SUT). The SUT is identified by its unique ID. This API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutdefectsfixedin"
      }
    },
    "/api/getSutDefectsFoundInManually": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutDefectsFoundInManually",
        "description": "This API endpoint retrieves a list of defects that were manually identified and recorded for a given System\nUnder Test (SUT). The SUT is identified by its unique ID, which is passed as a parameter. This API is\navailable from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutdefectsfoundinmanually"
      }
    },
    "/api/getSutDefectsFoundInThroughTests": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutDefectsFoundInThroughTests",
        "description": "This API endpoint retrieves a list of defects associated with a specific System Under Test (SUT), identified\nby its ID, that were discovered during testing. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutdefectsfoundinthroughtests"
      }
    },
    "/api/getSutDetails": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutDetails",
        "description": "This API endpoint fetches detailed information about a System Under Test (SUT) based on its ID. It allows\nretrieving either the current or a frozen (historical) state of the SUT, depending on the 'frozen' parameter.\n\n(also called by `getSutDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.sutsummary"
      }
    },
    "/api/getSutDetailsRevision": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutDetailsRevision",
        "description": "This API endpoint retrieves detailed information about a specific revision of a System Under Test (SUT). It\ntakes the SUT ID and revision number as input parameters to identify the desired SUT revision.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutdetailsrevision"
      }
    },
    "/api/getSutFolderFullTraceability": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutFolderFullTraceability",
        "description": "This API endpoint retrieves the complete traceability information for a given SUT folder, identified by its\nfolder ID. The folder can be the root folder or any other normal folder within the SUT structure. This API is\navailable from version 11 onwards.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutForm": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutForm",
        "description": "This API endpoint retrieves the form data associated with the System Under Test (SUT). It is used to obtain\nthe necessary information for configuring or interacting with the SUT within the XStudio environment.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutform"
      }
    },
    "/api/getSutFullTraceability": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutFullTraceability",
        "description": "This API retrieves comprehensive traceability data for one or more SUTs (Systems Under Test). It accepts a\ncomma-separated list of SUT IDs and returns the corresponding traceability information.",
        "parameters": [
          {
            "name": "sutIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutInheritedAttachments": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments that are inherited by a specific SUT. The SUT is identified\nby its unique ID. This functionality is available from API version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutLinkedRequirements": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutLinkedRequirements",
        "description": "This API endpoint retrieves a list of requirements that are linked to the provided System Under Test (SUT)\nIDs. It is used to fetch the associations between SUTs and their corresponding requirements, facilitating\ntraceability and impact analysis.",
        "parameters": [
          {
            "name": "sutIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutlinkedreqs"
      }
    },
    "/api/getSutLinkedSpecifications": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutLinkedSpecifications",
        "description": "This API endpoint retrieves a list of specifications that are linked to one or more SUTs, identified by their\nIDs. The API takes the SUT IDs as a parameter.",
        "parameters": [
          {
            "name": "sutIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutlinkedspecs"
      }
    },
    "/api/getSutLinkedTests": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutLinkedTests",
        "description": "This API endpoint retrieves a list of tests linked to the specified System Under Test (SUT) IDs. It takes the\n'sutIds' parameter containing the IDs of the SUTs to query.",
        "parameters": [
          {
            "name": "sutIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutlinkedtests"
      }
    },
    "/api/getSutProgress": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutProgress",
        "description": "This API endpoint retrieves the progress information for a specific System Under Test (SUT) identified by its\nID. The progress is returned as a JSON string.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutPyramid": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutPyramid",
        "description": "This API endpoint fetches and returns the SUT pyramid structure. The SUT pyramid provides a hierarchical\nrepresentation of the system under test, allowing for a structured view of its components and their\nrelationships. The API requires a valid 'sutId' to identify the specific SUT.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutRadar": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutRadar",
        "description": "This API endpoint retrieves the radar chart data associated with a given SUT ID. The radar chart provides a\nvisual representation of the SUT's performance or characteristics across different metrics.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsHistory": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsHistory",
        "description": "This API endpoint fetches the execution history of a given System Under Test (SUT). It takes the SUT ID as\ninput to retrieve the relevant results. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsRequirements": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsRequirements",
        "description": "This API endpoint retrieves the requirements associated with the results of a given System Under Test (SUT).\nIt is used to fetch the criteria or conditions that the SUT's results must meet.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsRequirementsPerType": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsRequirementsPerType",
        "description": "This API endpoint retrieves the System Under Test (SUT) results requirements, categorized by type, based on\nthe provided SUT ID. It is used to fetch the specific requirements associated with a particular SUT for\nanalysis and reporting purposes.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsRequirementsSummary": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsRequirementsSummary",
        "description": "This API endpoint fetches a summary of the SUT results, focusing on the fulfillment of requirements. It\nprovides an overview of how the SUT performs against defined requirements, useful for assessing test coverage\nand overall system quality.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "results.resultrequirementssummary"
      }
    },
    "/api/getSutResultsSteps": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsSteps",
        "description": "This API endpoint fetches the detailed steps and their results for a given SUT ID. It is used to provide a\ngranular view of test execution within a specific System Under Test, allowing users to analyze individual step\noutcomes.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsTestProgress": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsTestProgress",
        "description": "This API endpoint fetches the test progress data for a specified System Under Test (SUT). The progress is\ncalculated based on the provided start and stop dates, allowing users to monitor testing activities over a\nspecific period.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsTestcaseProgress": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsTestcaseProgress",
        "description": "This API endpoint fetches the progress of test cases executed on a specified System Under Test (SUT) between a\nstart and end date. It is used to monitor and analyze the execution status of test suites for a particular SUT\nover time. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "stopDate",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsTestcases": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsTestcases",
        "description": "This API endpoint retrieves the test case results associated with a given System Under Test (SUT). It requires\na valid 'sutId' to identify the specific SUT for which the test results are requested. The API is available\nfrom version 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutResultsTests": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutResultsTests",
        "description": "This API endpoint retrieves the test results associated with a given System Under Test (SUT). It requires a\nvalid 'sutId' to identify the SUT for which the test results are being requested. The API is available from\nversion 11 onwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutRevisions": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutRevisions",
        "description": "This API endpoint retrieves a list of revisions associated with a given System Under Test (SUT). It requires a\nvalid 'sutId' to identify the SUT for which revisions are requested. The API is available from version 11\nonwards.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getSutsTree": {
      "get": {
        "tags": [
          "SUTs"
        ],
        "operationId": "getSutsTree",
        "description": "This API endpoint retrieves the SUTs tree, allowing clients to browse and manage systems under test. It\nsupports filtering, cache management, and forced retrieval of results.",
        "parameters": [
          {
            "name": "forceRetrievingResults",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.sutstree"
      }
    },
    "/api/getTaskDetails": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "getTaskDetails",
        "description": "This API endpoint retrieves the details of a given task, identified by its task ID, as a frozen snapshot\nof its current state. It is used to display the task summary in the tree tooltips.",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "taskId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.tasksummary"
      }
    },
    "/api/getTeamAccessRights": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getTeamAccessRights",
        "description": "This API endpoint retrieves the access rights associated with a given team. It is used to determine the\npermissions and privileges granted to members of the specified team within the system.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.teamaccessrights"
      }
    },
    "/api/getTeamAccessRightsBugConnector": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getTeamAccessRightsBugConnector",
        "description": "This API endpoint fetches the user group access rights for a given team in the context of a specific bug\nconnector. It allows administrators to determine the permissions a team has when interacting with a particular\nbug tracking system.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.teamaccessrightsbugconnector"
      }
    },
    "/api/getTeamAccessRightsRequirementConnector": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getTeamAccessRightsRequirementConnector",
        "description": "This API endpoint fetches the access rights configuration for a given team, specifically concerning its\ninteraction with a requirement connector. It allows administrators to determine the permissions a team has\nwhen linking to or managing requirements through a connector.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.teamaccessrightsreqconnector"
      }
    },
    "/api/getTeamDetails": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getTeamDetails",
        "description": "This API endpoint fetches detailed information about a team based on its unique identifier. It is used to\nretrieve team-specific data such as members, roles, and permissions.\n\n(also called by `getUserGroupDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.usergroupsummary"
      }
    },
    "/api/getTeamForm": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getTeamForm",
        "description": "This API endpoint retrieves the user group form, likely containing fields and options for creating or\nmodifying teams and user group assignments. It is used in the context of team management within the\napplication.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.usergroupform"
      }
    },
    "/api/getTeamUsers": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getTeamUsers",
        "description": "This API endpoint retrieves a list of users associated with a given team ID. It is used to manage team\nmembership and access rights within the application. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.usergroupusers"
      }
    },
    "/api/getTestAttachments": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestAttachments",
        "description": "This API endpoint retrieves a list of attachments associated with a given test case ID. It is used to access\nsupporting files or resources related to a particular test.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestAttributes": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestAttributes",
        "description": "This API endpoint retrieves the attributes associated with a given test case. It takes the testId of the test\ncase to fetch the attributes.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testattributesdetails"
      }
    },
    "/api/getTestAuthor": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestAuthor",
        "description": "This API endpoint retrieves the author of a specific test case, identified by its ID. It is used to determine\nwho created or last modified a particular test.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testauthor"
      }
    },
    "/api/getTestCampaigns": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestCampaigns",
        "description": "This API endpoint retrieves a list of test campaigns associated with a given test ID. It is used to fetch the\ncampaigns linked to a particular test for execution or analysis purposes.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testcampaigns"
      }
    },
    "/api/getTestChanges": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestChanges",
        "description": "This API endpoint retrieves the changes associated with a given test case. It is used to track modifications\nand updates made to a specific test, identified by its unique ID.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestDetails",
        "description": "This API endpoint retrieves detailed information about a test case, identified by its unique ID. It supports\nretrieving either the current version or a frozen (historical) version of the test case details.\n\n(also called by `getTestDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.testsummary"
      }
    },
    "/api/getTestDetailsRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestDetailsRevision",
        "description": "This API endpoint retrieves the details of a test case for a specific revision. It is used to access\nhistorical versions of a test case, allowing users to view or compare changes made over time.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testdetailsrevision"
      }
    },
    "/api/getTestDeveloper": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestDeveloper",
        "description": "This API endpoint retrieves developer details linked to a particular test case. It requires a valid 'testId'\nto identify the test case and returns the developer information as a JSON string.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testdeveloper"
      }
    },
    "/api/getTestExecutionsBugs": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestExecutionsBugs",
        "description": "This API endpoint fetches bug details related to test executions, filtering by session ID, agent ID, instance\nindex, and a list of test IDs. It allows users to retrieve information about defects found during specific\ntest runs.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.sessiongettestexecutionsbugs"
      }
    },
    "/api/getTestFolderFullTraceability": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestFolderFullTraceability",
        "description": "This API retrieves the complete traceability data associated with a given test folder. The folder can be the\nroot folder or any other folder within the test structure. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestFolderInnerTraceability": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestFolderInnerTraceability",
        "description": "This API retrieves the traceability details within a given test folder. The folder can be the root folder or\nany other folder within the test structure. It is available from version 11 onwards.\n\n(also called by `getTestFolderInnerTraceability()`)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "relationships.relationship"
      }
    },
    "/api/getTestForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestForm",
        "description": "This API endpoint retrieves a test form, likely containing fields and metadata necessary for creating or\nmodifying test cases within the XStudio testing environment. The form is dynamically generated based on the\nuser's session and application configuration. It is available from API version 11 onwards.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testform"
      }
    },
    "/api/getTestFreezeStatus": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestFreezeStatus",
        "description": "This API endpoint retrieves the freeze status for a given test case. The freeze status indicates whether the\ntest case can be modified or not. It is used to prevent unintended changes to tests that are currently in use\nor under review.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testfreezestatus"
      }
    },
    "/api/getTestFullTraceability": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestFullTraceability",
        "description": "This API retrieves comprehensive traceability data for one or more tests, identified by their IDs. The API is\navailable from version 11 onwards.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestInheritedAttachments": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestInheritedAttachments",
        "description": "This API endpoint retrieves a list of attachments that are inherited by a test case, identified by its unique\nID. It is used to provide a comprehensive view of all attachments relevant to a test, including those\ninherited from parent entities.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestInnerTraceability": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestInnerTraceability",
        "description": "This API retrieves detailed traceability information for one or more tests, identified by their IDs. It allows\nusers to understand the relationships and dependencies of tests within the system. The API is available from\nversion 11 onwards.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "relationships.relationship"
      }
    },
    "/api/getTestLinkedBugs": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestLinkedBugs",
        "description": "This API endpoint retrieves a list of bugs that are linked to a specific test case identified by its ID. It is\nused to provide traceability between tests and reported defects.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testlinkedbugs"
      }
    },
    "/api/getTestLinkedRequirements": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestLinkedRequirements",
        "description": "This API retrieves a list of requirements that are linked to the provided test case IDs. It is used to\ndetermine the requirements covered by specific tests within the XStudio test management system.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testlinkedreqs"
      }
    },
    "/api/getTestLinkedSpecifications": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestLinkedSpecifications",
        "description": "This API retrieves a list of specifications that are linked to the provided test IDs. It is used to fetch\nrelated specification documents for given test cases within the XStudio test management system.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testlinkedspecs"
      }
    },
    "/api/getTestLinkedSuts": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestLinkedSuts",
        "description": "This API retrieves the SUTs linked to the provided test IDs. It is used to determine which systems are\nassociated with specific tests within the XStudio test management system. The API is available from version\n11 onwards.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testlinkedsuts"
      }
    },
    "/api/getTestParamsCombinations": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestParamsCombinations",
        "description": "This API endpoint retrieves the possible combinations of test parameters for a specified test case. It is used\nto generate test data sets for execution. The API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestResultsHistory": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestResultsHistory",
        "description": "This API endpoint fetches the execution history of a given test case, allowing users to track the test's\nperformance over time. It takes the testId of the test case as input.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestResultsSteps": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestResultsSteps",
        "description": "This API endpoint retrieves the detailed steps and their results associated with a given test execution. It is\nused to provide a granular view of the test outcome, showing the pass/fail status of each individual step\nwithin the test.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestResultsTestcases": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestResultsTestcases",
        "description": "This API endpoint retrieves the test case results associated with a given test execution ID. It is used to\nfetch detailed information about the individual test cases that were executed as part of a specific test.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestRevisions": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestRevisions",
        "description": "This API endpoint fetches the revision history of a test case, allowing users to track changes made over time.\nIt requires a valid testId to identify the test case.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestTestcases": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestTestcases",
        "description": "This API endpoint retrieves a list of test cases that are associated with a given test ID. It is used to fetch\nthe test cases for a specific test within the test management system.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testcases_"
      }
    },
    "/api/getTestTypes": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestTypes",
        "description": "This API endpoint retrieves a list of test types supported by the system. It is used to populate test type\nselection options in the user interface when creating or editing test cases.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.testtypes"
      }
    },
    "/api/getTestcaseAttachments": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseAttachments",
        "description": "This API endpoint retrieves a list of attachments associated with a given test case ID. It is used to provide\naccess to files and documents related to a specific test case, such as screenshots, logs, or data files.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseChanges": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseChanges",
        "description": "This API endpoint retrieves the change history for a given test case. It allows users to track modifications\nand updates made to a test case over time, aiding in debugging and understanding test evolution.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseDetails",
        "description": "This API endpoint retrieves detailed information for a given test case, identified by its ID. It supports\nretrieving either the current version or a frozen (historical) version of the test case.\n\n(also called by `getTestcaseDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.testcasesummary"
      }
    },
    "/api/getTestcaseDetailsRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseDetailsRevision",
        "description": "This API endpoint fetches the details of a test case for a given revision. It takes the testcaseId and\nrevision parameters to identify the specific test case revision to retrieve.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcasedetailsrevision"
      }
    },
    "/api/getTestcaseForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseForm",
        "description": "This API endpoint retrieves the necessary form data required to display or edit a specific test case. The test\ncase is identified by its unique ID, which is passed as a request parameter. The API is part of the test\nmanagement suite, allowing users to manage test cases.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcaseform"
      }
    },
    "/api/getTestcaseFreezeStatus": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseFreezeStatus",
        "description": "This API endpoint is used to determine whether a particular test case is currently frozen, preventing\nmodifications. It takes the ID of the test case to check.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcasefreezestatus"
      }
    },
    "/api/getTestcaseOrTestcaseReferencingReusableTestcaseDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseOrTestcaseReferencingReusableTestcaseDetails",
        "description": "This API endpoint fetches the details of a specific test case. It determines whether the test case is a\nstandard test case or a test case that references a reusable test case and returns the appropriate details\naccordingly. The 'frozen' parameter indicates whether to retrieve the frozen version of the testcase.",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.testcasesummary"
      }
    },
    "/api/getTestcaseParameters": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseParameters",
        "description": "This API endpoint retrieves the parameters defined for a given test case. It is used to fetch the input values\nand configurations required to execute the test case.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseProcedure": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseProcedure",
        "description": "This API retrieves the detailed steps and expected results (procedure) for a given test case. It allows\nfetching the procedure in a frozen state, potentially representing a historical version.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcaseprocedure"
      }
    },
    "/api/getTestcaseProcedureRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseProcedureRevision",
        "description": "This API endpoint retrieves a specific revision of a test case procedure based on the provided test case ID\nand revision number. It is used to access historical versions of test procedures.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcaseprocedurerevision"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseChanges": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseChanges",
        "description": "This API endpoint retrieves a list of test cases that reference a specific reusable test case and have\nundergone changes. It is used to track the impact of modifications to reusable test cases on dependent test\ncases.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcasechanges"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseDetails": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseDetails",
        "description": "This API endpoint retrieves information about test cases that include or reference a specific reusable test\ncase. It is useful for understanding dependencies and impacts when modifying reusable test cases.\n\n(also called by `getTestcaseReferencingReusableTestcaseDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.testcasesummary"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseDetailsRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseDetailsRevision",
        "description": "This API retrieves information about a test case which includes or references a reusable test case. The API\nrequires the ID of the referencing test case and the specific revision of the reusable test case to fetch the\ndetails.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcasedetailsrevision"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseForm": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseForm",
        "description": "This API retrieves the necessary form data to display a list of reusable test cases that are referenced by a\nspecific test case. This is used in the test case management UI to show dependencies and relationships between\ntest cases.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.testcasereferencingreusabletestcase"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseProcedure": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseProcedure",
        "description": "This API endpoint retrieves a list of test cases that reference a specific reusable test case procedure,\nidentified by the provided testcaseId. It is used to determine which test cases are dependent on a particular\nreusable procedure.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcaseprocedure"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseProcedureRevision": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseProcedureRevision",
        "description": "This API endpoint retrieves a list of test cases that reference a particular revision of a reusable test case\nprocedure. It is used to identify dependencies on specific procedure revisions within the test case\nrepository.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcaseprocedurerevision"
      }
    },
    "/api/getTestcaseReferencingReusableTestcaseRevisions": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReferencingReusableTestcaseRevisions",
        "description": "This API endpoint retrieves a list of test cases that reference specific revisions of a reusable test case. It\nis used to determine which test cases are impacted by changes to a reusable test case.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseResultsHistory": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseResultsHistory",
        "description": "This API endpoint retrieves the execution history of a given test case. It allows users to track the results\nof a test case over time, providing insights into its stability and performance.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseResultsSteps": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseResultsSteps",
        "description": "This API endpoint retrieves the detailed steps and their results for a given test case ID. It is used to\ninspect the execution details of a test case, providing information on each step's outcome.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseReusableTestcaseId": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseReusableTestcaseId",
        "description": "This API endpoint retrieves the ID of a reusable test case that is linked to a specified test case. It is used\nto determine the reusable component associated with a particular test case within the test management system.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.testcaserusabletestcaseid"
      }
    },
    "/api/getTestcaseRevisions": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseRevisions",
        "description": "This API endpoint retrieves a list of revisions for a given test case. It allows users to track changes made\nto a test case over time, providing an audit trail of modifications.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/getTestcaseTest": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcaseTest",
        "description": "This API endpoint retrieves the details of a specific test case based on its unique identifier. It is used to\nfetch test case information for viewing, editing, or execution purposes.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "search.gettestcasetest"
      }
    },
    "/api/getTestcasesReferencingAReusableTestcaseInTheirProcedure": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestcasesReferencingAReusableTestcaseInTheirProcedure",
        "description": "This API endpoint retrieves the test cases whose procedure references a given reusable test case (as a step,\nR_1685). It is used to warn the user before moving the reusable test case to the recycle bin (the reference\nwill be displayed as deleted) or hard-deleting it (the reference will be replaced with a copy of its steps).\nAnswer: { \"testcases\": [ { \"id\": 12, \"name\": \"...\" } ] } (always an array, empty when none).",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.testcasesreferencingareusabletestcaseintheirprocedure"
      }
    },
    "/api/getTestsChilds": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestsChilds",
        "description": "This API endpoint retrieves the child tests of one or more tests. It receives a list of test IDs and\nreturns, for each test, the tests that depend on it.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testchilds"
      }
    },
    "/api/getTestsParents": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestsParents",
        "description": "This API endpoint retrieves the parent tests of one or more tests. It receives a list of test IDs and\nreturns, for each test, the tests it depends on.",
        "parameters": [
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.testparents"
      }
    },
    "/api/getTestsTree": {
      "get": {
        "tags": [
          "Tests"
        ],
        "operationId": "getTestsTree",
        "description": "This API endpoint retrieves the test case tree structure, allowing clients to navigate and explore available\ntests. The tree structure can be filtered and cached to optimize performance.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeFilter",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.teststree"
      }
    },
    "/api/getTreeFilter": {
      "get": {
        "tags": [
          "Tree Filters"
        ],
        "operationId": "getTreeFilter",
        "description": "This API retrieves a specific tree filter configuration based on the provided treeFilterId. Tree filters are\nused to customize the display of hierarchical data structures within the application.",
        "parameters": [
          {
            "name": "treeFilterId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "treefilter.gettreefilter"
      }
    },
    "/api/getTreeFilterForm": {
      "get": {
        "tags": [
          "Tree Filters"
        ],
        "operationId": "getTreeFilterForm",
        "description": "This API endpoint retrieves the configuration required to render a tree filter form in the user interface. The\nform configuration is specific to the user's session.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "treefilter.treefilterform"
      }
    },
    "/api/getTreeFilters": {
      "get": {
        "tags": [
          "Tree Filters"
        ],
        "operationId": "getTreeFilters",
        "description": "This API endpoint retrieves filter configurations for a specific tree structure. The filter configurations are\nused to control the display and behavior of the tree in the user interface.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "treefilter.gettreefilters"
      }
    },
    "/api/getUserActionRights": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUserActionRights",
        "description": "This API endpoint retrieves the action rights associated with the user currently authenticated in the session.\nIt is used to determine what actions a user is permitted to perform within the application.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.actionrights"
      }
    },
    "/api/getUserDetails": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUserDetails",
        "description": "This API endpoint fetches and returns comprehensive details for a specific user. It requires a valid user ID\nto identify the target user account and is available from API version 11 onwards.\n\n(also called by `getUserDetails()`)",
        "parameters": [
          {
            "name": "frozen",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tooltip.usersummary"
      }
    },
    "/api/getUserForm": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUserForm",
        "description": "This API endpoint retrieves the user form data associated with the current session. It is used to display and\npotentially edit user profile information.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.userform"
      }
    },
    "/api/getUserPreferencesForm": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUserPreferencesForm",
        "description": "This API retrieves the user preferences form based on the user's session. It utilizes the user_id stored in\nthe session to fetch the appropriate preferences form data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.userpreferencesform"
      }
    },
    "/api/getUserRoles": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUserRoles",
        "description": "This API endpoint retrieves the roles assigned to a user, identified by their userId. It is used to determine\nthe user's permissions and access rights within the application.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.userroles"
      }
    },
    "/api/getUserTeams": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUserTeams",
        "description": "This API endpoint retrieves a list of teams or user groups that a given user is a member of. It is used to\ndetermine the user's roles and permissions within the system. The API requires a valid user ID to identify the\ntarget user.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.userusergroups"
      }
    },
    "/api/getUsersTree": {
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "getUsersTree",
        "description": "This API endpoint fetches a hierarchical tree view of users, potentially leveraging caching mechanisms to\nimprove performance. The tree structure provides a visual representation of user relationships or\norganizational structure within the application. Caching behavior can be influenced by parameters.",
        "parameters": [
          {
            "name": "cache",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.userstree"
      }
    },
    "/api/getWebClientAgent": {
      "get": {
        "tags": [
          "Agents"
        ],
        "operationId": "getWebClientAgent",
        "description": "This API endpoint retrieves details of a web client agent. It is used to fetch agent-specific configuration or\nstatus information, likely for campaign execution purposes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.webclientagent"
      }
    },
    "/api/getWebClientAgentId": {
      "get": {
        "tags": [
          "Agents"
        ],
        "operationId": "getWebClientAgentId",
        "description": "This API endpoint retrieves the ID of the Web Client Agent associated with the current user's session. This ID\nis likely used for identifying and managing web client agents within the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.webclientagentid"
      }
    },
    "/api/hardDeleteAgents": {
      "post": {
        "tags": [
          "Agents"
        ],
        "operationId": "hardDeleteAgents",
        "description": "This API permanently deletes test agents from the system. The agents are identified by their IDs, which are\npassed as a comma-separated string.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.harddeleteagents",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "agentIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteAssets": {
      "post": {
        "tags": [
          "Assets"
        ],
        "operationId": "hardDeleteAssets",
        "description": "This API endpoint allows for the hard deletion of assets. It receives a comma-separated list of asset IDs and\npermanently removes the corresponding assets from the system. This operation is irreversible.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.harddeleteassets",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "assetIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteBugs": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "hardDeleteBugs",
        "description": "This API endpoint allows for the permanent deletion of bugs. It requires a list of bug IDs to be deleted and\nremoves the specified bugs from the system, bypassing the recycle bin.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.harddeletedefects",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteCampaigns": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "hardDeleteCampaigns",
        "description": "This API endpoint allows for the permanent deletion of test campaigns from the system. It receives a\ncomma-separated list of campaign IDs to delete and removes the corresponding campaigns from the database.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.harddeletecampaigns",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "campaignIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteDocuments": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "hardDeleteDocuments",
        "description": "This API endpoint allows for the hard deletion of documents. It receives a list of document IDs and\npermanently removes the corresponding documents from the system. This action is irreversible.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.harddeletedocuments",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "documentIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteExploratorySessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "hardDeleteExploratorySessions",
        "description": "This API endpoint permanently deletes exploratory sessions from the system. The sessions are identified by\ntheir IDs provided in the request.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.harddeleteexploratorysessions",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "exploratorySessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteFolders": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "hardDeleteFolders",
        "description": "This API endpoint allows for the hard deletion of folders. It receives a list of folder IDs and a tree type,\nthen permanently removes the specified folders from the system. This operation is irreversible.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.harddeletefolders",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "hardDeleteRequirements",
        "description": "This API endpoint allows for the hard deletion of requirements. It receives a list of requirement IDs and\npermanently removes the corresponding requirements from the database. This operation is irreversible.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.harddeleterequirements",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteReusableTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "hardDeleteReusableTestcases",
        "description": "This API permanently deletes reusable test cases from the system. The deletion is irreversible and removes the\nspecified test cases and all associated data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.harddeletereusabletestcases",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "reusableTestcaseIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteSchedules": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "hardDeleteSchedules",
        "description": "This API endpoint allows for the hard deletion of schedules. It receives a list of schedule IDs and\npermanently removes the corresponding schedules from the database. This operation is irreversible.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.harddeleteschedules",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "scheduleIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteSessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "hardDeleteSessions",
        "description": "This API endpoint allows for the permanent deletion of test execution sessions from the system. It receives a\ncomma-separated list of session IDs to be deleted and removes the corresponding session data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.harddeletesessions",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteSpecifications": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "hardDeleteSpecifications",
        "description": "This API endpoint allows for the hard deletion of specifications. It receives a comma-separated list of\nspecification IDs to be deleted and removes them from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.harddeletespecifications",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteSqlReports": {
      "post": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "hardDeleteSqlReports",
        "description": "This API endpoint allows for the hard deletion of SQL reports. It receives a comma-separated list of SQL\nreport IDs and permanently removes the corresponding reports from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.harddeletesqlreports",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sqlReportIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteSuts": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "hardDeleteSuts",
        "description": "This API endpoint allows for the hard deletion of SUTs. The SUTs to be deleted are identified by their IDs,\nprovided as a comma-separated string. This operation is irreversible and permanently removes the specified\nSUTs from the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.harddeletesuts",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sutIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "hardDeleteTestcases",
        "description": "This API endpoint allows for the hard deletion of test cases. The test cases are identified by their IDs,\nprovided as a comma-separated string. This operation is irreversible and removes the test cases from the\ndatabase.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.harddeletetestcases",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardDeleteTests": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "hardDeleteTests",
        "description": "This API endpoint allows for the hard deletion of tests. It receives a list of test IDs and permanently\nremoves the corresponding tests from the database. This action is irreversible.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.harddeletetests",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hardEmptyFolders": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "hardEmptyFolders",
        "description": "This API endpoint allows for the hard deletion of empty folders within a specified tree structure. It is\nintended for administrative tasks to clean up empty folder hierarchies. The API requires proper authorization\nto prevent accidental data loss.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.hardemptyfolders",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hasDiscussionToBeNotified": {
      "get": {
        "tags": [
          "Chat"
        ],
        "operationId": "hasDiscussionToBeNotified",
        "description": "This API endpoint determines if a given user has any unread discussion notifications related to a specific\nnode (identified by node type and node ID). It returns a boolean value indicating whether a notification\nexists.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "notifications.button"
      }
    },
    "/api/healAttachments": {
      "post": {
        "tags": [
          "Attachments"
        ],
        "operationId": "healAttachments",
        "description": "This API endpoint identifies attached files that are no longer linked to any data and deletes them to\nfree up space. A dry-run mode can be enabled to only report the orphaned attachments without deleting\nthem.",
        "parameters": [
          {
            "name": "dryRun",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "toolbox.healattachments",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/healCoverage": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "healCoverage",
        "description": "This API endpoint detects potential inconsistencies related to the coverage (links between requirements,\nspecifications, tests and test cases) and automatically corrects them. It is part of the maintenance\ntoolbox.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "toolbox.healcoverage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/importData": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "importData",
        "description": "This API endpoint allows importing data into the system. It takes parameters specifying the filename, import\ntype, import format, and conflict resolution strategy to handle existing data.",
        "parameters": [
          {
            "name": "filename",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "importType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "importFormat",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "conflictResolution",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "menu.importprogress"
      }
    },
    "/api/importLDAPUsers": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "importLDAPUsers",
        "description": "This API endpoint imports user accounts from a configured LDAP directory. It allows specifying a parent\nfolder, profile, and team to associate with the imported users. This functionality is available from version\n11 onwards.",
        "parameters": [
          {
            "name": "parentFolderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.importldapusers",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/importPackage": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "importPackage",
        "description": "This API endpoint imports a package, potentially obtained from a marketplace, into the system. The package is\nidentified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "marketplace.importpackage",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "packageId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/importResults": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "importResults",
        "description": "This API endpoint allows importing test results from a file into a specific campaign session. The results are\nprocessed based on the specified import format. This is a POST operation.",
        "parameters": [
          {
            "name": "filename",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "importFormat",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.importresultsfromexcelprogress"
      }
    },
    "/api/insertExploratorySessionAttributeValue": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "insertExploratorySessionAttributeValue",
        "description": "This API endpoint allows inserting a new attribute value associated with a specific exploratory session. It\nrequires the exploratory session ID, attribute type, attribute ID, and the attribute value itself to create\nthe new association.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeValue",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.insertexploratorysessionattribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertScheduleAttributes": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "insertScheduleAttributes",
        "description": "This API endpoint allows inserting or updating attributes associated with a given schedule. It takes the\nschedule ID as a parameter and updates the schedule's attributes based on the request parameters.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.insertscheduleattributes",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertScheduleParams": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "insertScheduleParams",
        "description": "This API endpoint allows inserting or updating schedule parameters associated with a specific schedule. It\ntakes the schedule ID as input and processes the request to store the provided parameters. The API is used\nwithin the context of campaign scheduling.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.insertscheduleparameters",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertSessionAttributes": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "insertSessionAttributes",
        "description": "This API endpoint allows inserting attributes into a specified session. It is used to manage session-specific\ndata within the application, potentially for tracking campaign-related information or user activity during a\ntest campaign.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.insertsessionattributes",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertSessionParams": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "insertSessionParams",
        "description": "This API endpoint allows inserting or updating session-specific parameters. It is used to manage and persist\ndata associated with a particular test execution session, identified by its session ID. The parameters are\npassed via the request object.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.insertsessionparameters",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertTestAttributeValue": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "insertTestAttributeValue",
        "description": "This API endpoint allows inserting or updating the value of a test attribute. It requires the test ID,\nattribute type, attribute ID, and the attribute value to be provided as parameters. The API is used to manage\ntest attribute data.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeValue",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.insertTestAttribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertTestcaseParameterValue": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "insertTestcaseParameterValue",
        "description": "This API endpoint allows inserting or updating the value of a test case parameter. It requires the test case\nID, parameter type, parameter ID, and the new parameter value to be provided in the request.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterValue",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.inserttestcaseparam",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/insertUserRoles": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "insertUserRoles",
        "description": "This API endpoint allows associating one or more users with a specific profile and team. It takes a list of\nuser IDs, a profile ID, and a team ID as input and updates the user roles accordingly. This is used for\nassigning permissions and access rights to users within the system.",
        "parameters": [
          {
            "name": "userIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.createuserrole",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkExploratorySessionToBugs": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "linkExploratorySessionToBugs",
        "description": "This API endpoint allows associating an exploratory session with one or more bugs reported through a specific\ndefect connector. The association is made based on the exploratory session ID and the connector index.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.linkexploratorysessiontobugs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkRequirementToRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "linkRequirementToRequirements",
        "description": "This API endpoint allows linking an existing requirement to one or more other requirements. It uses connector\nindices to define the relationship between the requirements. The API updates the requirement links based on\nthe provided parameters.",
        "parameters": [
          {
            "name": "connectorIndex1",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectorIndex2",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.linkreqtoreqs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkRequirementToSpecifications": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "linkRequirementToSpecifications",
        "description": "This API endpoint establishes a link between a specified requirement and one or more specifications. The\nconnector index determines which connector is used to create the link. This API is used for requirement\ntraceability.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.linkreqtospecs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkRequirementToSuts": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "linkRequirementToSuts",
        "description": "This API endpoint establishes a link between a specific requirement and a System Under Test (SUT). It uses the\nconnector index to identify the SUT and the requirement ID to locate the requirement to be linked.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.linkreqtosuts",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkRequirementToTests": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "linkRequirementToTests",
        "description": "This API endpoint establishes a link between a specified requirement and one or more tests. The connection is\nmade using the provided connector index and requirement ID, creating a traceability link between requirements\nand tests.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.linkreqtotests",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkSpecificationToRequirements": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "linkSpecificationToRequirements",
        "description": "This API endpoint establishes a link between a specification and one or more requirements. The link is created\nusing the connector specified by the connectorIndex. The specification is identified by its specificationId.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.linkspectoreqs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkSpecificationToSpecifications": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "linkSpecificationToSpecifications",
        "description": "This API endpoint allows linking a source specification to one or more target specifications. It takes the ID\nof the source specification as input.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.linkspectospecss",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkSpecificationToTests": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "linkSpecificationToTests",
        "description": "This API endpoint allows associating a specific specification with a set of tests. The specification is\nidentified by its ID, and the association is established within the system.",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.linkspectotests",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkSutToRequirements": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "linkSutToRequirements",
        "description": "This API endpoint establishes a link between a specified SUT and one or more requirements, using a connector.\nThe connector index identifies the specific connector to use for linking.",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.linksuttoreqs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkTestExecutionsToBugs": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "linkTestExecutionsToBugs",
        "description": "This API endpoint allows associating one or more test executions with existing bug reports. It uses a defect\nconnector to create the links between the test executions and the bugs based on provided identifiers.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.sessionlinktestexecutionstobugs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkTestToRequirements": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "linkTestToRequirements",
        "description": "This API endpoint establishes a link between a test (identified by its ID) and one or more requirements\nthrough a specified connector. The connector index determines which requirement system to use for linking.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.linktesttoreqs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/linkTestToSpecifications": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "linkTestToSpecifications",
        "description": "This API endpoint establishes a link between a specified test and one or more specifications. The test is\nidentified by its unique ID, and the specifications to link to are expected to be provided in the request.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.linktesttospecs",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "list": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/lockAttachment": {
      "post": {
        "tags": [
          "Attachments"
        ],
        "operationId": "lockAttachment",
        "description": "This API endpoint locks a specific attachment, identified by its ID, within a given tree and node type.\nLocking an attachment prevents other users from modifying it until it is unlocked, ensuring data integrity\nduring updates.",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "attachments.lockattachment"
      }
    },
    "/api/lockDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "lockDocument",
        "description": "This API endpoint locks a specific document, identified by its ID, to prevent other users from making changes\nsimultaneously. This ensures data integrity and avoids conflicts during document editing or modification\nprocesses.",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.lockdocument"
      }
    },
    "/api/logout": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "logout",
        "description": "Invalidates the current user's session, effectively logging them out of the application. This endpoint handles\nboth standard session invalidation and Single Sign-On (SSO) logout scenarios.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout"
      }
    },
    "/api/mergeSessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "mergeSessions",
        "description": "This API merges multiple test execution sessions, identified by their IDs, into a destination session. The\nmerged session is placed under a specified parent folder. The type of merge can be specified to control how\nthe sessions are combined.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.mergesession",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  },
                  "mergeType": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveAgents": {
      "post": {
        "tags": [
          "Agents"
        ],
        "operationId": "moveAgents",
        "description": "This API endpoint allows moving one or more test agents to a different folder within the agent hierarchy. The\nagents are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.moveagent",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "agentIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveAssets": {
      "post": {
        "tags": [
          "Assets"
        ],
        "operationId": "moveAssets",
        "description": "This API endpoint moves one or more assets to a specified destination folder. The assets are identified by\ntheir IDs, and the destination folder is identified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.moveasset",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "assetIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveBugs": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "moveBugs",
        "description": "This API endpoint moves one or more bugs to a specified destination folder within the bug tracking system. The\nbug IDs and the destination folder ID are passed as parameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.movedefects",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  },
                  "bugNames": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveCampaigns": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "moveCampaigns",
        "description": "This API endpoint allows moving one or more campaigns to a different folder within the campaign hierarchy. The\ncampaigns are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.movecampaign",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "campaignIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveDocuments": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "moveDocuments",
        "description": "This API endpoint allows moving one or more documents to a different folder within the document management\nsystem. The documents are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.movedocument",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "documentIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveExploratorySessions": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "moveExploratorySessions",
        "description": "This API endpoint allows moving one or more exploratory sessions to a different folder within the system. The\nexploratory sessions are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.moveexploratorysession",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "exploratorySessionIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveFoldersToCategory": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "moveFoldersToCategory",
        "description": "This API endpoint moves one or more folders to a destination category. The folders are identified by their IDs\nand names, and the destination category is specified by its ID and name.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.movefolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  },
                  "folderNames": {
                    "type": "string"
                  },
                  "destParentCategoryId": {
                    "type": "string"
                  },
                  "destParentCategoryName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveFoldersToCompany": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "moveFoldersToCompany",
        "description": "This API endpoint allows moving folders from one company to another. It requires specifying the folder IDs,\nfolder names, tree type, destination company ID, and destination company name.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.movefolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  },
                  "folderNames": {
                    "type": "string"
                  },
                  "destParentCompanyId": {
                    "type": "string"
                  },
                  "destParentCompanyName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveFoldersToFolder": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "moveFoldersToFolder",
        "description": "This API endpoint allows moving one or more folders to a different parent folder within a specified tree\nstructure. It requires the tree type, IDs of the folders to be moved, their names, and the ID and name of the\ndestination parent folder.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.movefolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  },
                  "folderNames": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  },
                  "destParentFolderName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveFoldersToRoot": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "moveFoldersToRoot",
        "description": "This API endpoint moves one or more folders to the root directory of a specified tree structure. It accepts a\nlist of folder IDs and folder names, along with the tree type to which the folders belong. This operation is\ntypically used for reorganizing folder hierarchies.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.movefolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "folderIds": {
                    "type": "string"
                  },
                  "folderNames": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveGenericBugs": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "moveGenericBugs",
        "description": "This API endpoint allows moving multiple bugs, identified by their IDs, to a new parent folder within the bug\ntracking system. The operation requires appropriate permissions to modify the specified bugs and access the\ndestination folder.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.movedefects",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  },
                  "bugNames": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveGenericRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "moveGenericRequirements",
        "description": "This API endpoint moves a list of requirements to a specified destination folder. The requirements are\nidentified by their IDs, and the destination folder is also identified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.moverequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveRequirements": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "moveRequirements",
        "description": "This API endpoint allows moving existing requirements from their current location to a different parent folder\nwithin the requirement hierarchy. The API takes a comma-separated list of requirement IDs and the destination\nparent folder ID as input.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.moverequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveReusableTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "moveReusableTestcases",
        "description": "This API endpoint allows moving one or more reusable test cases to a different folder within the asset\nrepository. The test cases are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.movereusabletestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "reusableTestcaseIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveSpecifications": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "moveSpecifications",
        "description": "This API endpoint allows moving one or more specifications to a different parent folder within the\nspecification hierarchy. The specifications are identified by their IDs, and the destination folder is\nspecified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.movespecification",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveSqlReports": {
      "post": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "moveSqlReports",
        "description": "This API endpoint allows moving one or more SQL reports to a different folder within the system. It takes a\nlist of SQL report IDs and the ID of the destination parent folder as input.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.movesqlreport",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sqlReportIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveSuts": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "moveSuts",
        "description": "This API endpoint moves one or more SUTs from their current location to a new parent folder within the SUT\ntree. The SUTs are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.movesut",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sutIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveTeams": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "moveTeams",
        "description": "This API endpoint allows moving existing teams (user groups) to a different folder within the team hierarchy.\nIt is available from API version 11 onwards. The API takes a list of team IDs and a destination parent folder\nID as input.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.moveusergroup",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "teamIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "moveTestcases",
        "description": "This API endpoint allows moving one or more test cases from their current location to a specified destination\ntest suite. The test cases are identified by their IDs, and the destination is specified by the ID of the\ntarget test suite.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.movetestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseIds": {
                    "type": "string"
                  },
                  "testcaseNames": {
                    "type": "string"
                  },
                  "destTestId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveTests": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "moveTests",
        "description": "This API endpoint moves one or more tests from their current location to a new parent folder within the test\ntree. The tests are identified by their IDs, and the destination folder is specified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.movetest",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/moveUsers": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "moveUsers",
        "description": "This API endpoint allows moving one or more users to a different folder within the user management system. The\nuser IDs to be moved and the destination folder ID are provided as parameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.moveuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "userIds": {
                    "type": "string"
                  },
                  "destParentFolderId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/registerForPushNotification": {
      "get": {
        "tags": [
          "Miscellaneous"
        ],
        "operationId": "registerForPushNotification",
        "description": "This API endpoint checks if the user's session has timed out. If the session is timed out and the command is\nnot 'registerForPushNotification', it returns an unauthorized error. This ensures session validity for all API\ncalls except the push notification registration.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "globals.pushnotification"
      }
    },
    "/api/removeBugsFollower": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "removeBugsFollower",
        "description": "This API endpoint removes a specified follower from a list of bugs. It takes a comma-separated list of bug IDs\nand the ID of the follower to remove.",
        "parameters": [
          {
            "name": "followerId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatebugsfollower",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/removeExploratorySessionAttributeValue": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "removeExploratorySessionAttributeValue",
        "description": "This API endpoint removes a specific attribute value associated with a given exploratory session. It requires\nthe session ID, attribute type, and attribute ID to identify the attribute value to be removed.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.removerexploratorysessionattribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/removeSessionsFollower": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "removeSessionsFollower",
        "description": "This API endpoint allows removing a specific follower from one or more test execution sessions. It requires\nthe session IDs and the follower's ID to perform the removal.",
        "parameters": [
          {
            "name": "followerId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessionsfollower",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/removeTestAttributeValue": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "removeTestAttributeValue",
        "description": "This API endpoint removes a specified attribute value associated with a given test. It requires the test ID,\nattribute type, and attribute ID to identify the attribute value to be removed.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.removeTestAttribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/removeTestcaseParameterValue": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "removeTestcaseParameterValue",
        "description": "This API endpoint removes a value from a test case parameter. It requires the test case ID, the type of\nparameter, and the specific parameter ID to identify the value to be removed. This is used to modify test case\nparameter configurations.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "parameterId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.removetestcaseparam",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/renameDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "renameDocument",
        "description": "This API endpoint renames a given document. It receives the document ID and the new name, and updates the\ndocument accordingly.",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "documentName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.renamedocument"
      }
    },
    "/api/renameTimetag": {
      "post": {
        "tags": [
          "Versioning"
        ],
        "operationId": "renameTimetag",
        "description": "This API endpoint renames a timetag (LATEST cannot be renamed). Only the name changes, the associations set\nwhen the timetag was created are kept.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "timetags.renametimetag",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "timetagId": {
                    "type": "string"
                  },
                  "timetagName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/resetUserPassword": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "resetUserPassword",
        "description": "This API endpoint initiates a password reset process for a user identified by their username. It is typically\nused when a user has forgotten their password and requests a reset link to be sent to their registered email\naddress.",
        "parameters": [
          {
            "name": "username",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.resetpassword",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/restartserver": {
      "post": {
        "tags": [
          "Administration"
        ],
        "operationId": "restartserver",
        "description": "This API endpoint restarts the XStudio server so that configuration changes are taken into account. The\nrestart can be performed immediately or deferred to the night using the nightly flag.",
        "parameters": [
          {
            "name": "nightly",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.restartserver",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "tonight": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/revokeBearerToken": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "revokeBearerToken",
        "description": "This API endpoint revokes a bearer token of a given user. Once revoked, the personal API token can no\nlonger be used to authenticate REST API calls.",
        "parameters": [
          {
            "name": "bearerTokenId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.revokebearertoken"
      }
    },
    "/api/selectTimetag": {
      "post": {
        "tags": [
          "Versioning"
        ],
        "operationId": "selectTimetag",
        "description": "This API endpoint selects the timetag used by the current session: LATEST (id 10) shows the current state of the system,\nany other timetag shows the system as it was when that timetag was set (read-only \"time-travel\" mode).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "timetags.selecttimetag",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "timetagId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/setBugFixedIn": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "setBugFixedIn",
        "description": "This API endpoint allows associating one or more SUTs with a bug, indicating that the bug has been resolved\nwithin those specific SUT environments. It takes the bug ID and a list of SUT IDs as input.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.setdefectfixedin",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/setBugFoundIn": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "setBugFoundIn",
        "description": "This API endpoint allows associating one or more Systems Under Test (SUTs) with a specific bug. This is useful\nfor tracking the environments where a defect is reproducible or was initially discovered.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.linkdefecttosuts",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/setUserProfile": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "setUserProfile",
        "description": "This API endpoint assigns a profile to a given user. It receives the user ID and the profile ID, and\nupdates the permissions of the user accordingly.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.setuserprofileuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/signBug": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signBug",
        "description": "_command forwarded by the wrapper as `signBug&bugId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signCampaign": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signCampaign",
        "description": "_command forwarded by the wrapper as `signCampaign&campaignId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signDocument": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signDocument",
        "description": "_command forwarded by the wrapper as `signDocument&documentId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signRequirement": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signRequirement",
        "description": "_command forwarded by the wrapper as `signRequirement&requirementId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signSession": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signSession",
        "description": "_command forwarded by the wrapper as `signSession&sessionId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signSpecification": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signSpecification",
        "description": "_command forwarded by the wrapper as `signSpecification&specificationId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signSut": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signSut",
        "description": "_command forwarded by the wrapper as `signSut&sutId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signTest": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signTest",
        "description": "_command forwarded by the wrapper as `signTest&testId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/signTestcase": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "signTestcase",
        "description": "_command forwarded by the wrapper as `signTestcase&testcaseId=`_\n\n(also called by `verifyDigitalSignature()`)",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "textToken",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.signelement"
      }
    },
    "/api/unfreezeBug": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "unfreezeBug",
        "description": "This API endpoint allows a user to unfreeze a specific bug, making it editable again. Unfreezing a bug\ntypically reverses a previous action that locked the bug's state, potentially for auditing or historical\npurposes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.unfreezedefect",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeCampaign": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "unfreezeCampaign",
        "description": "This API endpoint unfreezes a specified test campaign. Unfreezing a campaign makes it editable and allows test\nexecution to proceed. The campaign is identified by its unique ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.unfreezecampaign",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "campaignId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "unfreezeDocument",
        "description": "This API endpoint unfreezes a document, removing any restrictions that prevent modifications. The document is\nidentified by its unique ID. This action is part of the document versioning and management system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.unfreezedocument",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeRequirement": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "unfreezeRequirement",
        "description": "This API endpoint unfreezes a specific requirement, enabling users to modify its attributes and associated\ndata. The requirement is identified by its unique ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.unfreezerequirement",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeSession": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "unfreezeSession",
        "description": "This API endpoint unfreezes a previously frozen test execution session. Unfreezing a session allows\nmodifications to be made or allows the session to be executed again. The sessionId parameter is required to\nidentify the session to unfreeze.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.unfreezesession",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeSpecification": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "unfreezeSpecification",
        "description": "This API endpoint unfreezes a specification, identified by its ID, enabling users to modify the\nspecification's content and properties.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.unfreezespecification",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeSut": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "unfreezeSut",
        "description": "This API endpoint unfreezes a System Under Test (SUT) identified by its ID. Unfreezing a SUT typically allows\nmodifications and updates to its configuration and associated data.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.unfreezesut",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sutId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeTest": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "unfreezeTest",
        "description": "This API endpoint unfreezes a test, identified by its ID, enabling users to modify the test details.\nUnfreezing a test reverses the effect of freezing, which prevents accidental changes to important test\nconfigurations.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.unfreezetest",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unfreezeTestcase": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "unfreezeTestcase",
        "description": "This API endpoint unfreezes a specific test case, identified by its ID. Unfreezing a test case allows users to\nmodify its content and properties after it has been frozen for versioning or archival purposes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.unfreezetestcase",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/unlockAttachment": {
      "post": {
        "tags": [
          "Attachments"
        ],
        "operationId": "unlockAttachment",
        "description": "This API unlocks a specific attachment, removing any locks that might be in place. This allows users to modify\nor delete the attachment. The API requires the tree type, node type, and attachment ID to identify the\nattachment to be unlocked.",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "attachments.unlockattachment"
      }
    },
    "/api/unlockDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "unlockDocument",
        "description": "This API endpoint unlocks a document, removing any locks that prevent other users from modifying it. The\ndocument is identified by its unique ID.",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.unlockdocument"
      }
    },
    "/api/updateAgentDetails": {
      "post": {
        "tags": [
          "Agents"
        ],
        "operationId": "updateAgentDetails",
        "description": "This API endpoint allows updating the configuration and properties of a registered test agent. It is typically\nused to modify agent settings such as its name, description, or connection parameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "agents.updateagent",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateAssetDetails": {
      "post": {
        "tags": [
          "Assets"
        ],
        "operationId": "updateAssetDetails",
        "description": "This API endpoint allows updating the details of an existing asset. It receives asset information via HTTP\nPOST parameters and persists the changes. The specific asset to be updated is identified by its ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "assets.updateassetdetails",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateAttachment": {
      "post": {
        "tags": [
          "Attachments"
        ],
        "operationId": "updateAttachment",
        "description": "This API endpoint allows updating the metadata (name) of an attachment. It requires specifying the\nattachment's ID, the new name, and context information about the attachment's location within the system (tree\ntype, node type, node ID).",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attachmentName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "attachments.addattachmentprogress"
      }
    },
    "/api/updateAttribute": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateAttribute",
        "description": "This API endpoint allows updating an attribute associated with a test entity (test case, test suite, or test\nexecution). The specific attribute to be updated is determined by the 'attributeType' parameter.",
        "parameters": [
          {
            "name": "attributeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestattribute",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateBugDetails": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "updateBugDetails",
        "description": "This API endpoint allows updating the details of an existing bug or defect within the system. It receives bug\nidentification and updated field values as input and persists the changes to the bug's record.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatedefectsdetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateBugsFollowers": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "updateBugsFollowers",
        "description": "This API allows updating the list of users who are following specific bugs. It takes a list of bug IDs and a\nlist of user IDs to update the followers for those bugs.",
        "parameters": [
          {
            "name": "bugIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.setdefectfollowers",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateBugsPriority": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "updateBugsPriority",
        "description": "This API updates the priority field for a list of specified bugs. It takes a comma-separated list of bug IDs\nand a new priority value as input, and updates the corresponding bug records in the database.",
        "parameters": [
          {
            "name": "priority",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatedefectspriority",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateBugsSeverity": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "updateBugsSeverity",
        "description": "This API endpoint allows updating the severity of specified bugs. It takes a comma-separated list of bug IDs\nand a severity value as input, and updates the corresponding bug records in the database.",
        "parameters": [
          {
            "name": "severity",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatedefectsseverity",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateBugsStatus": {
      "post": {
        "tags": [
          "Bugs"
        ],
        "operationId": "updateBugsStatus",
        "description": "This API updates the status of specified bugs. It accepts a comma-separated list of bug IDs and a new status\nvalue, then updates the corresponding bug records in the database.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatedefectsstatus",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "bugIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateCampaignDetails": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateCampaignDetails",
        "description": "This API endpoint allows updating the configuration and properties of an existing test campaign. It receives\ncampaign details as parameters and persists the changes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.updatecampaigndetails",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateCampaignTests": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateCampaignTests",
        "description": "This API endpoint allows updating the list of tests included in a test campaign. It receives the campaign ID\nand a list of test IDs to associate with the campaign, modifying the campaign's test suite.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateCampaignTestsOrder": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateCampaignTestsOrder",
        "description": "This API endpoint allows reordering the tests associated with a specific test campaign. The order is\ndetermined by the provided list of test IDs.",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.updatecampaigntestsorder",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateCategoryDetails": {
      "post": {
        "tags": [
          "Categories"
        ],
        "operationId": "updateCategoryDetails",
        "description": "This API endpoint allows updating the details of a category. It receives category information via HTTP\nparameters and persists the changes. The category is identified by its ID, and other attributes like name and\ndescription can be modified.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "categories.updatecategory",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateChannelDetails": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "updateChannelDetails",
        "description": "This API endpoint updates the details of an existing channel. It receives the channel form (identifier,\nname, description and other settings) and applies the changes to the channel.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.updatechannel",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateChannelPages": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "updateChannelPages",
        "description": "This API endpoint allows updating the list of page IDs associated with a given dashboard channel. It receives\nthe channel ID and a comma-separated list of page IDs as input, and updates the channel's page configuration\naccordingly.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.updatechannelpages",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateCompanyDetails": {
      "post": {
        "tags": [
          "Companies"
        ],
        "operationId": "updateCompanyDetails",
        "description": "This API endpoint allows updating the details of a company. It receives company information via HTTP POST\nparameters and persists the changes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "companies.updatecompany",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateContentDetails": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "updateContentDetails",
        "description": "This API endpoint updates the details of an existing content. It receives the content form (identifier,\nname, description and other attributes) and applies the changes to the content.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.updatecontentdetails",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateContentSource": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "updateContentSource",
        "description": "This API endpoint updates the data source configuration of a given content. It receives the content ID\nand the new source configuration, and applies it to the content.",
        "parameters": [
          {
            "name": "contentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.updatecontentsource",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "configuration": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateCustomField": {
      "post": {
        "tags": [
          "Custom Fields"
        ],
        "operationId": "updateCustomField",
        "description": "This API endpoint allows updating a custom field associated with a particular node type. It receives the node\ntype and custom field type as parameters and updates the custom field accordingly. This is a common utility\nAPI for managing custom fields.",
        "parameters": [
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customFieldType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateDefectHistory": {
      "get": {
        "tags": [
          "Bugs"
        ],
        "operationId": "updateDefectHistory",
        "description": "This API endpoint retrieves and updates the history of defects, allowing users to track changes and activities\nrelated to defects. The specific history retrieved depends on whether a connector, folder, or the root folder\nis selected.",
        "parameters": [
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "defects.updatedefecthistory"
      }
    },
    "/api/updateDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "updateDocument",
        "description": "This API endpoint allows updating the name of an existing document. It requires the document's ID and the new\nname as parameters. The API is part of the document management system.",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "documentName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.uploaddocumentprogress"
      }
    },
    "/api/updateExploratorySessionAssignedTo": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionAssignedTo",
        "description": "This API endpoint allows updating the user assigned to a specific exploratory test session. It is used to\nreassign or assign a user to an exploratory session for testing purposes.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.updateexploratorysessionassignedto",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateExploratorySessionDetails": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionDetails",
        "description": "This API endpoint allows updating the details of an exploratory test session. It receives session and request\nobjects, processes the update, and returns a JSON string result indicating success or failure. The specific\ndetails that can be updated are determined by the parameters passed in the request.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.updateexploratorysessiondetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateExploratorySessionStartDateTime": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionStartDateTime",
        "description": "This API endpoint allows updating the start date and time of an exploratory session. It receives the\nexploratory session ID as a parameter and modifies the session's start time accordingly. This is useful for\ncorrecting or adjusting session timings.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateExploratorySessionStopDateTime": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionStopDateTime",
        "description": "This API endpoint allows updating the stop date and time for a given exploratory session. It is typically used\nto mark the completion of an exploratory testing session. The API takes the exploratorySessionId to identify\nthe session to be updated.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateExploratorySessionSut": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionSut",
        "description": "This API endpoint allows updating the System Under Test (SUT) linked to a specific exploratory test session.\nIt takes the exploratory session ID and the new SUT ID as input and updates the association in the system.",
        "parameters": [
          {
            "name": "exploratorySessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.updateexploratorysessionsut",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateExploratorySessionsAssignedTo": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionsAssignedTo",
        "description": "This API endpoint allows updating the user assigned to one or more exploratory test sessions. It takes a\ncomma-separated list of session IDs and a user ID to reassign the sessions.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.updateexploratorysessionsassignedto",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "exploratorySessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateExploratorySessionsPriority": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateExploratorySessionsPriority",
        "description": "This API allows updating the priority of specified exploratory sessions. It takes a comma-separated list of\nexploratory session IDs and a priority value as input, then updates the 'priority' field for each of the\nspecified sessions in the database.",
        "parameters": [
          {
            "name": "priority",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "exploratorysessions.updateexploratorysessionspriority",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "nodeIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateFilteredTeams": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateFilteredTeams",
        "description": "This API endpoint updates the user's filtered teams based on the provided team IDs. It allows administrators\nto control which teams are visible or accessible to a specific user.",
        "parameters": [
          {
            "name": "teamIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.updateselectedteam"
      }
    },
    "/api/updateFolderDetails": {
      "post": {
        "tags": [
          "Folders"
        ],
        "operationId": "updateFolderDetails",
        "description": "This API endpoint allows updating the details of a folder. The specific folder to update and the new details\nare passed via request parameters. The 'treeType' parameter specifies the type of tree the folder belongs to,\nwhich is essential for locating the folder within the system.",
        "parameters": [
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "datasource.updatefolder",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updatePageContents": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "updatePageContents",
        "description": "This API endpoint updates the layout of a given dashboard page. It receives the page ID and the new\nlayout describing the position and the size of each content widget, and saves the page composition.",
        "parameters": [
          {
            "name": "pageId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.updatepagecontents",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updatePageDetails": {
      "post": {
        "tags": [
          "Dashboard"
        ],
        "operationId": "updatePageDetails",
        "description": "This API endpoint updates the details of an existing dashboard page. It receives the page form\n(identifier, name and other attributes) and applies the changes to the page.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "channels.updatepage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateParameter": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateParameter",
        "description": "This API endpoint allows updating an existing test case parameter. The parameter type is specified in the\nrequest.",
        "parameters": [
          {
            "name": "parameterType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestparam",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateProfile": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateProfile",
        "description": "This API endpoint allows updating an existing user profile. It takes the profile ID and the new profile name\nas parameters to modify the profile information.",
        "parameters": [
          {
            "name": "profileId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "profileName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.updateprofileuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateRequirementDetails": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "updateRequirementDetails",
        "description": "This API endpoint allows updating the attributes and properties of a requirement. It receives the\nrequirement's identifier and the new values for its fields, then persists the changes in the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.updaterequirementdetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateRequirementsPriority": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "updateRequirementsPriority",
        "description": "This API endpoint allows updating the priority field of one or more requirements. It receives a list of\nrequirement IDs and a new priority value, then updates the corresponding records in the database.",
        "parameters": [
          {
            "name": "priority",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.updaterequirementspriority",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateRequirementsRisk": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "updateRequirementsRisk",
        "description": "This API updates the risk level associated with one or more requirements. It takes a comma-separated list of\nrequirement IDs and a risk value as input, then updates the corresponding records in the database.",
        "parameters": [
          {
            "name": "risk",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.updaterequirementsrisk",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateRequirementsStatus": {
      "post": {
        "tags": [
          "Requirements"
        ],
        "operationId": "updateRequirementsStatus",
        "description": "This API updates the status field of specified requirements. It accepts a comma-separated list of requirement\nIDs and a new status value, then updates the database accordingly.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "requirements.updaterequirementsstatus",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "requirementIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateReusableTestcaseDetails": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateReusableTestcaseDetails",
        "description": "This API endpoint allows updating the attributes and properties of an existing reusable test case. It's used\nto modify the definition of a reusable test case within the asset management system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.updatereusabletestcasedetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateReusableTestcaseProcedure": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateReusableTestcaseProcedure",
        "description": "This API endpoint allows updating the procedure associated with a specified reusable test case. It takes the\nID of the reusable test case to be updated.",
        "parameters": [
          {
            "name": "reusableTestcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "reusabletestcases.updatereusabletestcaseprocedure",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateScheduleAgents": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateScheduleAgents",
        "description": "This API updates the agents associated with a given schedule. It allows modification of the agent list, number\nof instances, synchronization settings, and pick strategy for the schedule's agent assignments.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pick",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updatescheduleagents",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateScheduleConfigurations": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateScheduleConfigurations",
        "description": "This API endpoint allows updating the configurations associated with a specific schedule. It takes schedule,\ncategory, and configuration IDs as parameters to modify the schedule's settings.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updatescheduleconfigurations",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateScheduleDetails": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateScheduleDetails",
        "description": "This API endpoint allows updating the configuration details of an existing schedule. It receives schedule\ninformation via HTTP POST parameters and persists the changes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updatescheduledetails",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateScheduleOperator": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateScheduleOperator",
        "description": "This API endpoint allows modification of the operator associated with a given schedule. It takes the schedule\nID and the new operator ID as input and updates the schedule accordingly.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "operatorId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updatescheduleoperator",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateScheduleScheduling": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateScheduleScheduling",
        "description": "This API endpoint allows modification of the scheduling parameters for an existing test campaign schedule. It\nrequires a schedule ID to identify the target schedule for the update.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updateschedulescheduling",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateScheduleSut": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateScheduleSut",
        "description": "This API endpoint allows updating the System Under Test (SUT) linked to a particular schedule. It modifies the\nschedule to use the specified SUT for test execution. The API requires proper authorization to modify schedule\nconfigurations.",
        "parameters": [
          {
            "name": "scheduleId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updateschedulesut",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSchedulesFollowers": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSchedulesFollowers",
        "description": "This API allows updating the list of users following a set of schedules. It takes schedule IDs and follower\nIDs as input and updates the association between them.",
        "parameters": [
          {
            "name": "scheduleIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "followerIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "schedules.updateschedulefollowers",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateServerSettings": {
      "post": {
        "tags": [
          "Settings"
        ],
        "operationId": "updateServerSettings",
        "description": "This API endpoint allows administrators to modify various server settings. It receives settings data via HTTP\nPOST and persists the changes to the server configuration.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.updateserversettings",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionAgents": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionAgents",
        "description": "This API updates the agents associated with a test execution session. It allows modification of agent\nassignments, number of instances, synchronization settings, and pick strategy for the session.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pick",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.updatesessionagents",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionConfigurations": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionConfigurations",
        "description": "This API updates the configurations associated with a specific session, filtering by category. It allows\nassociating specific configurations to a test session based on provided category and configuration IDs.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessionconfigurations",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionDetails": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionDetails",
        "description": "This API endpoint allows updating the details of an existing test execution session. It is typically used to\nmodify session properties such as name, description, or custom fields. The specific session to update is\nidentified by its session ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessiondetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionOperator": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionOperator",
        "description": "This API allows updating the operator (user) currently assigned to a test execution session. It is typically\nused to reassign sessions to different operators during exploratory testing or session management.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "operatorId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.updatesessionoperator",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionStartDateTime": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionStartDateTime",
        "description": "This API endpoint allows updating the start date and time of a test execution session. It receives the session\nID as a parameter and modifies the session's start time accordingly. This is useful for correcting or\nadjusting session timings in campaign management.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionState": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionState",
        "description": "This API updates the state of a test execution session based on the provided session ID and state. It is used\nto manage the lifecycle of test sessions, allowing transitions between states such as INITIALIZED, ARMED,\nRUNNING, PAUSED, TERMINATE_REQUEST, TERMINATING, and TERMINATED.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "state",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessionstate",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionStopDateTime": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionStopDateTime",
        "description": "This API endpoint allows updating the stop date and time for a specific test execution session. It is\ntypically used to mark the completion of a session and record its final timestamp. The sessionId parameter is\nused to identify the session to be updated.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.signout",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionSut": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionSut",
        "description": "This API endpoint allows updating the System Under Test (SUT) linked to a particular test execution session.\nIt is used to modify the SUT configuration during a test session, potentially to reflect changes in the\ntesting environment or target system.",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.updatesessionsut",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionTestcaseResult": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionTestcaseResult",
        "description": "This API endpoint allows updating the result of a particular test case instance within a test execution\nsession. It is used to report the outcome of a test case run during a campaign or exploratory session.\n\n(also called by `updateSessionTestcaseResult()`)",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "instanceId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessiontestcasecomments",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionsFollowers": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionsFollowers",
        "description": "This API updates the list of followers associated with one or more test execution sessions. It allows users to\nmodify who is following the progress and results of specific sessions.",
        "parameters": [
          {
            "name": "sessionIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "followerIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "campaigns.updatesessionfollowers",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSessionsStatus": {
      "post": {
        "tags": [
          "Campaigns"
        ],
        "operationId": "updateSessionsStatus",
        "description": "This API updates the status of one or more test execution sessions (Campaign Sessions). It takes a\ncomma-separated list of session IDs and a status value to update the sessions accordingly.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sessions.updatesessionsstatus",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "sessionIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateSpecificationDetails": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "updateSpecificationDetails",
        "description": "This API endpoint allows updating the details of a specification. It receives specification data via HTTP POST\nparameters and persists the changes. The API requires proper authorization to modify specification details.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.updatespecificationdetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSpecificationsPriority": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "updateSpecificationsPriority",
        "description": "This API updates the priority field for a list of specifications. It takes a comma-separated list of\nspecification IDs and a new priority value as input, then updates the corresponding records in the database.",
        "parameters": [
          {
            "name": "priority",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.updatespecificationspriority",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateSpecificationsStatus": {
      "post": {
        "tags": [
          "Specifications"
        ],
        "operationId": "updateSpecificationsStatus",
        "description": "This API updates the status of the specified specifications. It receives a comma-separated list of\nspecification IDs and a status value, then updates the status field in the database for each specified\nspecification.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "specifications.updatespecificationsstatus",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "specificationIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateSqlReportDetails": {
      "post": {
        "tags": [
          "SQL Reports"
        ],
        "operationId": "updateSqlReportDetails",
        "description": "This API endpoint allows updating the configuration and metadata of a SQL report. It expects the report's\nidentifier and the new details to be provided in the request parameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "sqlreports.updatesqlreport",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateStatement": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateStatement",
        "description": "This API endpoint allows updating the details of an existing Gherkin statement, such as its description and\nhelp text. The statement is identified by its unique ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "gherkin.updatestatement",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateSutDetails": {
      "post": {
        "tags": [
          "SUTs"
        ],
        "operationId": "updateSutDetails",
        "description": "This API endpoint allows updating the configuration and properties of an existing System Under Test (SUT). It\nreceives SUT details via HTTP POST parameters and persists the changes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "suts.updatesut",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTeamAccessRights": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateTeamAccessRights",
        "description": "This API endpoint allows administrators to modify the access permissions associated with a team. It is\navailable from API version 11 onwards. The team's ID is used to identify the team whose access rights are to\nbe updated.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.updateteamaccessrights",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTeamAccessRightsBugConnector": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateTeamAccessRightsBugConnector",
        "description": "This API endpoint allows updating the access rights of a user group (team) for a particular bug connector. It\nis used to manage which teams have access to which bug tracking systems.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.updateteamaccessrightsbugconnector",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTeamAccessRightsRequirementConnector": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateTeamAccessRightsRequirementConnector",
        "description": "This API endpoint allows modification of the access rights granted to a team (user group) concerning a\nparticular requirement connector. It is used to control which teams have access to specific requirement\nconnectors and what level of access they possess. This API is available from version 11 onwards.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectorIndex",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.updateteamaccessrightsreqconnector",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTeamDetails": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateTeamDetails",
        "description": "This API endpoint allows modification of team information such as name, description, and associated\npermissions. It delegates the actual update operation to the `updateUserGroup` method, which handles the data\nprocessing and persistence.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "usergroups.updateusergroup",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTeamUsers": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateTeamUsers",
        "description": "This API endpoint updates the members of a given team. It receives the team ID and the list of user IDs,\nreplacing the current members of the team.",
        "parameters": [
          {
            "name": "teamId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.updateusergroupusers",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestAuthor": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestAuthor",
        "description": "This API endpoint allows updating the author (user) associated with a specific test case. It requires the\ntestId of the test case to be updated and the userId of the new author.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestauthor",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestChilds": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestChilds",
        "description": "This API endpoint updates the child tests of a given test. It receives the test ID and the list of child\ntest IDs to link, replacing the existing child dependencies.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestchilds",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestDetails": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestDetails",
        "description": "This API endpoint allows updating the details of an existing test. It receives test details as parameters and\npersists the changes. The specific test to be updated is identified by a test ID.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestdetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestParents": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestParents",
        "description": "This API endpoint updates the parent tests of a given test. It receives the test ID and the list of\nparent test IDs to link, replacing the existing parent dependencies.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestparents",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestTestcases": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestTestcases",
        "description": "This API endpoint allows updating the list of test cases linked to a particular test. It receives the test ID\nand a list of test case IDs as input, and modifies the test's testcase associations accordingly.",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetesttestcasesindexes",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestcaseDetails": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestcaseDetails",
        "description": "This API endpoint allows for modifying the properties and attributes of a test case. It receives test case\ndetails as parameters and persists the changes in the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.updatetestcasedetailssingleformitem",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestcaseProcedure": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestcaseProcedure",
        "description": "This API endpoint allows updating the procedure or steps associated with a specific test case. It receives the\ntestcaseId as a parameter to identify the test case to be updated and modifies its procedure based on the data\nprovided in the request body.",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.updatetestcaseprocedure",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateTestcasesReadyForAutomatedExecution": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestcasesReadyForAutomatedExecution",
        "description": "This API updates the 'readyForAutomatedExecution' standard field (boolean) for multiple test cases specified\nby their IDs. It allows marking test cases as ready or not ready for automated execution.",
        "parameters": [
          {
            "name": "readyForAutomatedExecution",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.updatetestcasesreadyforautomated",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateTestcasesReadyForManualExecution": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestcasesReadyForManualExecution",
        "description": "This API endpoint allows updating the 'Ready for Manual Execution' field (a boolean flag) for one or more test\ncases. The test cases are identified by their IDs, and the new status is provided as a parameter.",
        "parameters": [
          {
            "name": "readyForManualExecution",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.updatetestcasesreadyformanual",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testcaseIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateTestsPriority": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestsPriority",
        "description": "This API endpoint allows updating the priority of one or more tests. It receives a list of test IDs and a new\npriority value, then updates the corresponding records in the database.",
        "parameters": [
          {
            "name": "priority",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestspriority",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateTestsStatus": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestsStatus",
        "description": "This API updates the status of multiple tests specified by their IDs. It uses the `updateStandardField` method\nto modify the status, which is represented by an integer value.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updatetestsstatus",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateTestsType": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "updateTestsType",
        "description": "This API updates the 'type' attribute of multiple tests specified by their IDs. The 'type' parameter\nrepresents a localized string that categorizes the tests.",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "tests.updateteststype",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "testIds": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/updateUserDetails": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateUserDetails",
        "description": "This API endpoint allows updating user information such as name, email, or other profile details. It requires\nproper authorization to modify user accounts. The specific user to be updated is identified through request\nparameters.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.updateuser",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "form": {}
                },
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateUserPassword": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "operationId": "updateUserPassword",
        "description": "This API endpoint allows a user to update their password using a password and a token. Upon successful\npassword update, the user's session is invalidated, requiring them to log in again with the new password.",
        "parameters": [
          {
            "name": "password",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "initialization.changepassword",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateUserPhoto": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateUserPhoto",
        "description": "This API endpoint allows updating the profile photo of a user. It requires a valid user ID to identify the\nuser whose photo needs to be updated. The actual photo data is expected to be part of the request body\n(handled within the updateUserPhoto method).",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.updateavatar"
      }
    },
    "/api/updateUserPreferences": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateUserPreferences",
        "description": "This API endpoint allows a user to update their personal preferences, such as UI settings, notification\npreferences, or other customizable options. The preferences are stored server-side and applied to the user's\naccount across different sessions and devices.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "settings.updateuserpreferences",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/updateUserTeams": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "updateUserTeams",
        "description": "This API endpoint updates the teams a given user belongs to. It receives the user ID and the list of team\nIDs, replacing the current team memberships of the user.",
        "parameters": [
          {
            "name": "userId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "teamIds",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "users.updateuserusergroups",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "/api/uploadAttachment": {
      "post": {
        "tags": [
          "Attachments"
        ],
        "operationId": "uploadAttachment",
        "description": "This API endpoint allows uploading a file attachment and associating it with a specific node within a\ndesignated tree structure. The attachment is linked based on the provided tree type, node type, and node ID.",
        "parameters": [
          {
            "name": "attachmentName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "attachments.addattachmentprogress"
      }
    },
    "/api/uploadCsvDataset": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "uploadCsvDataset",
        "description": "This API endpoint uploads a CSV file to be used as a dataset. The file is sent as multipart form data\nalong with the target filename.",
        "parameters": [
          {
            "name": "filename",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.uploadcsvprogress"
      }
    },
    "/api/uploadDocument": {
      "post": {
        "tags": [
          "Document"
        ],
        "operationId": "uploadDocument",
        "description": "This API endpoint allows users to upload a document to the system. The document is stored within a specified\nfolder.",
        "parameters": [
          {
            "name": "documentName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "folderId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "documents.uploaddocumentprogress"
      }
    },
    "/api/uploadEmbeddedImage": {
      "post": {
        "tags": [
          "Embedded Images"
        ],
        "operationId": "uploadEmbeddedImage",
        "description": "This API endpoint allows uploading an image that will be embedded within a rich-text field. The image is\nuploaded and stored on the server, and a reference to it can be used in the rich-text content.",
        "parameters": [
          {
            "name": "embeddedImageName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "window.addimageprogress"
      }
    },
    "/api/uploadTestcaseExecutionAttachment": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "uploadTestcaseExecutionAttachment",
        "description": "This API endpoint allows uploading a file attachment and linking it to a specific test case execution. It\nrequires parameters to identify the test case, execution session, and agent involved in the execution. The\nattachment is associated with the specified test case execution instance.",
        "parameters": [
          {
            "name": "attachmentName",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "treeType",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "attachments.addattachmentprogress"
      }
    },
    "/api/uploadXlsDataset": {
      "post": {
        "tags": [
          "Tests"
        ],
        "operationId": "uploadXlsDataset",
        "description": "This API endpoint uploads an Excel (XLS) file to be used as a dataset. The file is sent as multipart form\ndata along with the target filename.",
        "parameters": [
          {
            "name": "filename",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "testcases.uploadxlsprogress"
      }
    },
    "/api/verifyBugSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifyBugSignature",
        "description": "_command forwarded by the wrapper as `verifyBugSignature&bugId=`_",
        "parameters": [
          {
            "name": "bugId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifyCampaignSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifyCampaignSignature",
        "description": "_command forwarded by the wrapper as `verifyCampaignSignature&campaignId=`_",
        "parameters": [
          {
            "name": "campaignId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifyDocumentSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifyDocumentSignature",
        "description": "_command forwarded by the wrapper as `verifyDocumentSignature&documentId=`_",
        "parameters": [
          {
            "name": "documentId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifyRequirementSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifyRequirementSignature",
        "description": "_command forwarded by the wrapper as `verifyRequirementSignature&requirementId=`_",
        "parameters": [
          {
            "name": "requirementId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifySessionSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifySessionSignature",
        "description": "_command forwarded by the wrapper as `verifySessionSignature&sessionId=`_",
        "parameters": [
          {
            "name": "sessionId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifySpecificationSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifySpecificationSignature",
        "description": "_command forwarded by the wrapper as `verifySpecificationSignature&specificationId=`_",
        "parameters": [
          {
            "name": "specificationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifySutSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifySutSignature",
        "description": "_command forwarded by the wrapper as `verifySutSignature&sutId=`_",
        "parameters": [
          {
            "name": "sutId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifyTestSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifyTestSignature",
        "description": "_command forwarded by the wrapper as `verifyTestSignature&testId=`_",
        "parameters": [
          {
            "name": "testId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    },
    "/api/verifyTestcaseSignature": {
      "post": {
        "tags": [
          "E-Signature"
        ],
        "operationId": "verifyTestcaseSignature",
        "description": "_command forwarded by the wrapper as `verifyTestcaseSignature&testcaseId=`_",
        "parameters": [
          {
            "name": "testcaseId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "XStudio API envelope (`result: success/failure` + payload)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated — the frontend signs out on this status"
          }
        },
        "x-broadcast": "digital-signature.verifysignature_"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    },
    {
      "basicAuth": []
    }
  ]
}