openapi.json

{
  "openapi": "3.0.0",
  "paths": {
    "/webapps/octra-api/v1/app/roles": {
      "get": {
        "operationId": "listRoles",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RoleDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createRole",
        "summary": "",
        "description": "create a new role.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RoleCreateDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoleDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/roles/{role_id}": {
      "get": {
        "operationId": "getRole",
        "parameters": [
          {
            "name": "role_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoleDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeRole",
        "summary": "",
        "description": "changes a specific role.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "role_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RoleCreateDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoleDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeRole",
        "summary": "",
        "description": "removes a specific role.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "role_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/tokens": {
      "get": {
        "operationId": "listAppTokens",
        "summary": "",
        "description": "returns a list of app tokens.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "order_by",
            "required": false,
            "in": "query",
            "description": "direction for ordering entries",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "representation",
            "required": false,
            "in": "query",
            "description": "type of the representation",
            "schema": {
              "enum": [
                "page",
                "interval"
              ],
              "type": "string"
            }
          },
          {
            "name": "label",
            "required": false,
            "in": "query",
            "description": "label of the current page",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "description": "start of the interval",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "description": "end of the interval",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTokenListDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tokens"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createAppToken",
        "summary": "",
        "description": "creates a new app token.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppTokenCreateDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTokenDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tokens"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/tokens/{id}": {
      "get": {
        "operationId": "getAppToken",
        "summary": "",
        "description": "returns one specific app token.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTokenDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tokens"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeAppToken",
        "summary": "",
        "description": "changes an app token.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppTokenChangeDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tokens"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeAppToken",
        "summary": "",
        "description": "deletes an existing app token.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tokens"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/tokens/{id}/refresh": {
      "put": {
        "operationId": "refreshAppToken",
        "summary": "",
        "description": "overwrites an existing app token with a new auto-generated token.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTokenDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tokens"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/files/shared/{hash}/{filename}": {
      "get": {
        "operationId": "getSharedFile",
        "summary": "",
        "description": "returns a file from a given, encrypted path.\n\nAllowed user roles: <code>administrator, user</code>",
        "parameters": [
          {
            "name": "hash",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "tags": [
          "Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/files/{encryptedPath}/{encryptedContext}/{fileName}": {
      "get": {
        "operationId": "getFile",
        "summary": "",
        "description": "returns a file from a given, encrypted path.\n\nAllowed user roles: <code>administrator, user</code>",
        "parameters": [
          {
            "name": "encryptedPath",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "encryptedContext",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fileName",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "tags": [
          "Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/download": {
      "post": {
        "operationId": "downloadDataPackage",
        "summary": "",
        "description": "requests a download package for the selected options. As soon as requested a link entry is generated with status \"WAITING\".<br/><br/>\n\n\n - urls can not be exported to task_outputs\n - First the output is converted to AnnotJSON and then to other formats\n - some converters need audio information.\n - if a converter can't export data it's skipped.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DownloadPackageOptionsDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects": {
      "get": {
        "operationId": "listProjects",
        "summary": "",
        "description": "returns a list of projects. Administrators get a more detailed and unfiltered list of projects. If an application uses an app token linked to a specific tool only tasks supported by this tool are used for the statistics.\n\nAllowed user roles: <code>all</code>",
        "parameters": [
          {
            "name": "order_by",
            "required": false,
            "in": "query",
            "description": "direction for ordering entries",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "representation",
            "required": false,
            "in": "query",
            "description": "type of the representation",
            "schema": {
              "enum": [
                "page",
                "interval"
              ],
              "type": "string"
            }
          },
          {
            "name": "label",
            "required": false,
            "in": "query",
            "description": "label of the current page",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "description": "start of the interval",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "description": "end of the interval",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "manageable",
            "required": false,
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectListDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createProject",
        "summary": "",
        "description": "creates a new project.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}": {
      "get": {
        "operationId": "getProject",
        "summary": "",
        "description": "returns a project. Administrator and project administrator see all information, others limited information.\n\nAllowed user roles: <code>all</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeProject",
        "summary": "",
        "description": "changes a specific project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeProject",
        "summary": "",
        "description": "removes a specific project.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectRemoveRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/statistics": {
      "get": {
        "operationId": "getProjectStatistics",
        "summary": "",
        "description": "returns statistics about a project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectStatisticsDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/tools": {
      "get": {
        "operationId": "listTools",
        "summary": "",
        "description": "lists tools.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "order",
            "required": false,
            "in": "query",
            "description": "direction for ordering entries",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order_by",
            "required": false,
            "in": "query",
            "description": "direction for ordering entries",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "representation",
            "required": false,
            "in": "query",
            "description": "type of the representation",
            "schema": {
              "enum": [
                "page",
                "interval"
              ],
              "type": "string"
            }
          },
          {
            "name": "label",
            "required": false,
            "in": "query",
            "description": "label of the current page",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "description": "start of the interval",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "description": "end of the interval",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolListDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tools"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/tools/{id}": {
      "get": {
        "operationId": "getTool",
        "summary": "",
        "description": "returns a tool by id.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tools"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeTool",
        "summary": "",
        "description": "changes a registered tool.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ToolChangeRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tools"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeTool",
        "summary": "",
        "description": "removes a registered tool.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tools"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/tools/folders/{folder}": {
      "get": {
        "operationId": "getToolByFolder",
        "summary": "",
        "description": "returns a tool by folder name (for unregistered tools only).\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "folder",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tools"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "installTool",
        "summary": "",
        "description": "changes a registered tool.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "folder",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Tools"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/statistics/all": {
      "get": {
        "operationId": "getAllStatistics",
        "summary": "",
        "description": "returns statistics about number of accounts, roles, projects, tasks and app tokens. The response is cached every 15 minutes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AllStatisticsDto"
                }
              }
            }
          }
        },
        "tags": [
          "Statistics"
        ]
      }
    },
    "/webapps/octra-api/v1/auth/login": {
      "post": {
        "operationId": "login",
        "summary": "",
        "description": "authenticates a given account. Two authentication methods are supported: <code>local</code> and <code>shibboleth</code>:\n\n<ul>\n  <li>local: the account authenticates using a local account (via credentials). You can choose if session_token and app_token are saved as cookies.</li>\n  <li>shibboleth: the account authenticates via Shibboleth (the shibboleth authentication must be supported by the server). session_token and app_token are saved as cookies.</li>\n</ul>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "oneOf": [
                  {
                    "required": [
                      "type",
                      "usernameOrEmail",
                      "password"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "local"
                        ]
                      },
                      "usernameOrEmail": {
                        "type": "string",
                        "description": "You can set this value with either a username or an email address."
                      },
                      "password": {
                        "type": "string"
                      },
                      "useCookies": {
                        "type": "boolean",
                        "description": "Defines if app token and session token should be saved as cookies."
                      }
                    }
                  },
                  {
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "enum": [
                          "shibboleth"
                        ]
                      }
                    }
                  }
                ]
              },
              "examples": {
                "Local Login": {
                  "description": "Authenticate using credentials",
                  "value": {
                    "type": "local",
                    "usernameOrEmail": "myUserName",
                    "password": "Test123"
                  }
                },
                "Shibboleth": {
                  "description": "Authenticate via shibboleth",
                  "value": {
                    "type": "shibboleth"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid username or password.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid username or password."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Authentication"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/auth/logout": {
      "post": {
        "operationId": "logout",
        "parameters": [],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Authentication"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/me": {
      "get": {
        "operationId": "getMyAccountInformation",
        "summary": "",
        "description": "returns information about the own account.\n\nAllowed user roles: <code>administrator, user</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrentAccountDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/me/personal-information": {
      "get": {
        "operationId": "getMyAccountPersonalInformation",
        "summary": "",
        "description": "returns personal information about the own account.\n\nAllowed user roles: <code>administrator, user</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeMyAccountPersonalInformation",
        "summary": "",
        "description": "sets personal information about the own account.\n\nAllowed user roles: <code>administrator, user</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeAccountInformationDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/me/password": {
      "put": {
        "operationId": "changeMyPassword",
        "summary": "",
        "description": "changes the password of the current account.",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangePasswordDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "400": {
            "description": "Incorrect old password.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Incorrect old password."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find the account with the specified ID."
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/me/settings": {
      "put": {
        "operationId": "saveAccountSettings",
        "summary": "",
        "description": "saves account settings.\n\nAllowed user roles: <code>all</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountSettingsDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountSettingsDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/fields": {
      "post": {
        "operationId": "createAccountFieldDefinition",
        "summary": "",
        "description": "saves a new account field definition.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountFieldDefinitionCreateDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountFieldDefinitionDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Fields"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "get": {
        "operationId": "listAccountFieldDefinitions",
        "summary": "",
        "description": "list field definitions.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "order",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccountFieldDefinitionDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Fields"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/fields/{field_id}": {
      "put": {
        "operationId": "saveAccountFieldDefinition",
        "summary": "",
        "description": "saves a new account field definition.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "field_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountFieldDefinitionCreateDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountFieldDefinitionDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Fields"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeAccountFieldDefinition",
        "summary": "",
        "description": "removes an existing field definition.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "field_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Fields"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "get": {
        "operationId": "getAccountFieldDefinition",
        "summary": "",
        "description": "returns a field definition.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "field_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountFieldDefinitionDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Fields"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/me/fields": {
      "get": {
        "operationId": "listAccountFields",
        "summary": "",
        "description": "returns a list of existing account fields.\n\nAllowed user roles: <code>all</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccountFieldValueDefinitionDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "saveAccountFieldValues",
        "summary": "",
        "description": "saves values of account fields.\n\nAllowed user roles: <code>all</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts / Me"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts": {
      "get": {
        "operationId": "listAccounts",
        "summary": "",
        "description": "returns a list of existing accounts.\n\nAllowed user roles: <code>administrator</code>\n@version 1",
        "parameters": [
          {
            "name": "order_by",
            "required": false,
            "in": "query",
            "description": "direction for ordering entries",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "representation",
            "required": false,
            "in": "query",
            "description": "type of the representation",
            "schema": {
              "enum": [
                "page",
                "interval"
              ],
              "type": "string"
            }
          },
          {
            "name": "label",
            "required": false,
            "in": "query",
            "description": "label of the current page",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "description": "start of the interval",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "description": "end of the interval",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountMinimalListDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createAccount",
        "summary": "",
        "description": "creates a new account.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountCreateRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/hash/{hash}": {
      "get": {
        "operationId": "existsWithHash",
        "summary": "",
        "description": "changes the roles of a user with a specific ID.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "hash",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/register": {
      "post": {
        "operationId": "registerAccount",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountRegisterRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountRegisterResponseDto"
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/search": {
      "get": {
        "operationId": "searchForAccounts",
        "summary": "",
        "description": "searches for list of accounts by keyword.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "keyword",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccountSearchResultDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/{id}": {
      "put": {
        "operationId": "saveAccountInformation",
        "summary": "",
        "description": "saves information about a specific account.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountChangeDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any account with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any account with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeAccount",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any account with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any account with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "get": {
        "operationId": "getAccountInformation",
        "summary": "",
        "description": "returns information about a specific account.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any account with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any account with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/request-password-reset": {
      "post": {
        "operationId": "requestPasswordReset",
        "summary": "",
        "description": "sends an E-Mail with a request to reset the password. It always returns 200 even if account was not found.",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResetPasswordRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/accounts/batch/runAction": {
      "post": {
        "operationId": "runBatchAction",
        "summary": "",
        "description": "runs an action on given accounts. This functions doesn't wait for emails to be sent.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountBatchActionDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "400": {
            "description": "Can't run action on account. Account doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't run action on account. Account doesn't exist."
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any account with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any account with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Accounts"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies": {
      "get": {
        "operationId": "listPolicies",
        "summary": "",
        "description": "returns a list of policies\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PolicyMinimalDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createPolicy",
        "summary": "",
        "description": "adds a new policy with undefined publish date (draft). Only one draft per policy type may exist.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyCreateRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies/preview": {
      "post": {
        "operationId": "renderPolicyPreview",
        "summary": "",
        "description": "renders a preview of an unsaved policy\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyTranslationViewDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies/publish": {
      "put": {
        "operationId": "publishPolicies",
        "summary": "",
        "description": "publishes selected policies with given dates.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyPublishRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies/{id}": {
      "get": {
        "operationId": "getPolicy",
        "summary": "",
        "description": "get specific policy\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "updatePolicy",
        "summary": "",
        "description": "updates a policy.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyChangeRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removePolicy",
        "summary": "",
        "description": "removes a policy (only if there is no active user consent connected to it).\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies/{policy_id}/translations": {
      "get": {
        "operationId": "listPolicyTranslations",
        "summary": "",
        "description": "returns a list of policy translations\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "policy_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PolicyTranslationDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createPolicyTranslation",
        "summary": "",
        "description": "adds a new policy translation.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "policy_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/PolicyCreateTranslationDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyTranslationDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies/{policy_id}/translations/{translation_id}": {
      "put": {
        "operationId": "changePolicyTranslation",
        "summary": "",
        "description": "updates a policy translation.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "policy_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "translation_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/PolicyCreateTranslationDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyTranslationDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removePolicyTranslation",
        "summary": "",
        "description": "removes a policy translation.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "policy_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "translation_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/policies/list/latest": {
      "get": {
        "operationId": "listLatest",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PolicyListItemDto"
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Policies"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/settings/general": {
      "get": {
        "operationId": "getGeneralSettings",
        "summary": "",
        "description": "lists all general settings;\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GeneralSettingsDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Settings"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "saveGeneralSettings",
        "summary": "",
        "description": "saves the general settings.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GeneralSettingsDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Settings"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/properties": {
      "get": {
        "operationId": "getAppProperties",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppPropertiesDto"
                }
              }
            }
          }
        },
        "tags": [
          "App / Settings"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/fields/{field_id}": {
      "get": {
        "operationId": "getProjectAccountFieldDefinition",
        "summary": "",
        "description": "returns a field definition.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectFieldDefinitionDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/administration/commands/shutdown": {
      "post": {
        "operationId": "shutdown",
        "summary": "",
        "description": "shutdowns the system asap. \"shutdown\" option for app token must be enabled. Linux and MacOS only.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [],
        "responses": {
          "201": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Administration"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/administration/commands/restart": {
      "post": {
        "operationId": "restart",
        "summary": "",
        "description": "saves the general settings. \"shutdown\" option for app token must be enabled. Linux and MacOS only.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "responses": {
          "201": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Administration"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/administration/backups/running": {
      "get": {
        "operationId": "getRunningBackup",
        "summary": "",
        "description": "returns the backup that is currently running.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RunningBackupDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Administration"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/administration/backups": {
      "get": {
        "operationId": "listBackups",
        "summary": "",
        "description": "lists backups.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "order",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/BackupDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Administration"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/app/administration/backups/run": {
      "post": {
        "operationId": "runBackup",
        "summary": "",
        "description": "runs a manual command\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [],
        "responses": {
          "201": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "App / Administration"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/feedback/send": {
      "post": {
        "operationId": "postFeedback",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/FeedbackRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "Feedback"
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/configurations": {
      "get": {
        "operationId": "listToolConfigurations",
        "summary": "",
        "description": "list task configurations of a specific project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ToolConfigurationDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Configurations"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "createToolConfiguration",
        "summary": "",
        "description": "creates a new configuration of a specific project and a specific type of task.\n\nAllowed user roles: <code>administrator</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ToolConfigurationCreateDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolConfigurationDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Configurations"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/configurations/{config_id}": {
      "get": {
        "operationId": "getToolConfiguration",
        "summary": "",
        "description": "returns a specific configuration of a specific project.\n\nAllowed user roles: <code>all</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "config_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolConfigurationDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Configurations"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeToolConfiguration",
        "summary": "",
        "description": "changes a configuration of a specific project by a specific id.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "config_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ToolConfigurationChangeDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolConfigurationDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Configurations"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeToolConfiguration",
        "summary": "",
        "description": "removes a configuration of a specific project by a specific id.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "config_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Configurations"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/configurations/{config_id}/duplicate": {
      "post": {
        "operationId": "duplicateToolConfiguration",
        "summary": "",
        "description": "duplicates a existing configuration of a specific project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "config_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ToolConfigurationDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Configurations"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks": {
      "post": {
        "operationId": "uploadTaskData",
        "summary": "",
        "description": "creates a new task with the uploaded data.\n\nNotice: If you want to add urls you need to create a file that contains <a href=\"#section/Introduction/About-OCBJSONFileReference\">OCBJSONFileReference</a>.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/TaskUploadDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "get": {
        "operationId": "listTasks",
        "summary": "",
        "description": "lists tasks grouped by chains as arrays of arrays.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "length",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/TaskListItemDto"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/batch/start": {
      "post": {
        "operationId": "startBatchSession",
        "summary": "",
        "description": "starts a new session for batch upload.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskBatchSessionDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/batch/cancel": {
      "delete": {
        "operationId": "cancelBatchSession",
        "summary": "",
        "description": "cancels an existing session and removes all its temporary data. Recommended to save disk space on server.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaskBatchSessionDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/batch/submit": {
      "post": {
        "operationId": "submitBatchSession",
        "summary": "",
        "description": "submits a batch session and runs all its transactions. If one of the transaction fails, all previous transactions are reverted and an error is returned\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaskBatchSessionDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/batch/upload": {
      "post": {
        "operationId": "addBatchUploadTaskData",
        "summary": "",
        "description": "adds a new batch upload operation\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/TaskBatchUploadDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskBatchTransactionDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/start": {
      "put": {
        "operationId": "startTask",
        "summary": "",
        "description": "looks for a free task of type <code>task_type</code> (e.g. \"annotation\"), changes its status to 'BUSY' and returns it.\n\nAllowed user roles: <code>all with access to this project</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaskStartActionDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/{task_id}": {
      "put": {
        "operationId": "changeTaskData",
        "summary": "",
        "description": "changes a task and it's data. If `properties.files_destination` is set it is going to be applied only on a new\nmedia file. If you want to move a already uploaded file, use moveProjectFile() method.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/TaskChangeDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Project id or task id not found.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Project id or task id not found."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "removeTask",
        "summary": "",
        "description": "removes a task.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "get": {
        "operationId": "getTask",
        "summary": "",
        "description": "returns a task.\n\nAllowed user roles: <code>all</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/{task_id}/free": {
      "put": {
        "operationId": "freeTask",
        "summary": "",
        "description": "sets the status from 'BUSY' to 'FREE' of a task.\n\nAllowed user roles: <code>all with access</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/{task_id}/continue": {
      "put": {
        "operationId": "continueTask",
        "summary": "",
        "description": "continues a task (only if status is 'BUSY' or 'PAUSED' and worker_id is the same as id by current user).\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/{task_id}/resume": {
      "put": {
        "operationId": "resumeTask",
        "summary": "",
        "description": "resumes a task (only if status is 'FINISHED' and worker_id is the same as id by current user).\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/tasks/{task_id}/save": {
      "put": {
        "operationId": "saveTask",
        "summary": "",
        "description": "saves the current task by specific type. It doesn't automatically start a new task, it rather responds with the saved annotation.\n\nAllowed user roles: <code>all with access to this project</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "task_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/TaskSaveDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Tasks"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/links": {
      "get": {
        "operationId": "listProjectLinks",
        "summary": "",
        "description": "lists all links from specific project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/LinkDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Links"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/links/{link_id}": {
      "delete": {
        "operationId": "removeLink",
        "summary": "",
        "description": "removes given link from project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "link_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Links"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "operationId": "changeLink",
        "summary": "",
        "description": "changes given link from project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "link_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LinkOptionsDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LinkDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Links"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/files/upload": {
      "post": {
        "operationId": "uploadProjectFiles",
        "summary": "",
        "description": "uploads a list of project files to a target path.\n\nAllowed user roles: <code>administrator, project_admin, data_delivery</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/ProjectFileUploadDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/FileProjectDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/files": {
      "get": {
        "operationId": "listProjectFiles",
        "summary": "",
        "description": "lists all files and folders from a selected path\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "path",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "showOutputs",
            "required": true,
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProjectFileDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteProjectFiles",
        "summary": "",
        "description": "deletes a list of given project files represented by path or file_project_id\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "file_project_id": {
                        "type": "string",
                        "pattern": "[0-9]+"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "path": {
                        "type": "string"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/files/create/folder": {
      "post": {
        "operationId": "createProjectFileFolder",
        "summary": "",
        "description": "create a folder in a project directory\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectFileCreateFolderRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/files/rename": {
      "put": {
        "operationId": "renameProjectFile",
        "summary": "",
        "description": "renames a file or directory\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectFileRenameRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/files/move": {
      "put": {
        "operationId": "moveProjectFile",
        "summary": "",
        "description": "moves files and/or folder to a new destination. This does not replace/rename the destination folder, it includes the new files/folders within the destination.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectFileMoveRequestDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/files/exist": {
      "post": {
        "operationId": "checkIfProjectFilesExist",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectFileExistRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectFileExistResponseDto"
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Files"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/roles": {
      "get": {
        "operationId": "listProjectRoles",
        "summary": "",
        "description": "returns all roles associated to the project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProjectRoleDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "post": {
        "operationId": "assignProjectRoles",
        "summary": "",
        "description": "assigns roles for an account to a specific project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ProjectAssignRoleDto"
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProjectRoleResultDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/accounts": {
      "get": {
        "operationId": "listProjectAccounts",
        "summary": "",
        "description": "returns all accounts associated to the project.\n\nAllowed user roles: <code>administrator, project_admin</code>",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProjectAccountDto"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/webapps/octra-api/v1/projects/{project_id}/roles/{account_id}": {
      "delete": {
        "operationId": "removeProjectRoles",
        "parameters": [
          {
            "name": "project_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "account_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          },
          "401": {
            "description": "Invalid JWT Token",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Invalid JWT Token"
                  }
                }
              }
            }
          },
          "403": {
            "description": "You are not authorized to access this resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "You are not authorized to access this resource."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Can't find any project with this id.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "message that contains an error."
                    }
                  },
                  "example": {
                    "message": "Can't find any project with this id."
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Projects / Roles"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "OCTRA API",
    "description": "# Introduction\nThe OCTRA-API is a REST-API that allows apps to interact with the OCTRA Database (OCTRA-DB) and its project files.\n\n<img src=\"./assets/octra-backend-diagram.png\" alt=\"octra diagram\" />\n\nIn order to use this API you should meet the following requirements:\n\n1. You have a valid app token. You can request an app token from the administrator (contact <a href=\"mailto:octra@phonetik.uni-muenchen.de\">octra@phonetik.uni-muenchen.de</a>).<br/>\n    The app token should be sent...\n\n    a. ... with each HTTP-Request in a HTTP-header called \"X-App-Token\". For example:<br/>\n    <code>X-App-Token: 7328z4093u4ß92u4902u348</code><br/><br/>\n    App tokens are bound to specific domains (aka \"origins\").<br/>\n\n    b. ... or with each HTTP-Request as cookie \"ocb_app_token\" (added by the server automatically). This method is recommended for web applications.\n\n    c. ... or with each HTTP-Request as query parameter \"app_token\" (only recommended for HTML embedded files if cookies can't be used).\n\n2. All HTTP-requests but the authentication methods need the user to be authenticated. The OCTRA-API uses JWT (Jason Web Token) for authentication and authorization.\n    A successful <a href=\"#tag/Authentication/operation/login\">login request</a> returns the JWT which is valid for 24h. This JWT must be appended ...\n\n    a. ... to the \"Authorization\" HTTP-Header. For example: <code>Authorization: Bearer 7328z40293i84ß034293ß02934</code>\n\n    b. ... or as cookie called \"ocb_sessiontoken\". You need this e.g. if you want the user to access embedded files in HTML.\n\n    c. ... or with each HTTP-Request as query parameter \"session_token\" (only recommended for HTML embedded files if cookies can't be used).\n\n**Notice:** If you call API methods via terminal you can't use cookies and have to add the tokens to the headers or query parameters. If you have to retrieve files from a project programmatically you can add the app and session tokens as query parameters.\n\n## Role model\n\nThis API makes use of a role model. Each user has exactly one global role and project-specific roles.\n\n### Global roles\n\n<table>\n<tbody>\n<tr>\n<td><code>administrator</code></td>\n<td>System administrator with full access to all API functions.</td>\n</tr>\n<tr>\n<td><code>user</code></td>\n<td>Default role for users with normal access rights.</td>\n</tr>\n<tr>\n<td><code>app</code></td>\n<td>Role for Desktop-applications. See notice below. </td>\n</tr>\n</tbody>\n</table>\n\n#### Notice about app roles\n\n<div style=\"background-color:rgba(255,165,0,0.36);padding:20px;\">\nApplications need to be authenticated like normal users but without the need of accepting the data policy and terms & conditions.\nThe owner of the app has to make sure that our policies are accepted by users whose data is shared with octra-backend.\n</div>\n\n### Project-specific roles\n<table>\n<tbody>\n<tr>\n<td><code>project_admin</code></td>\n<td>Project administrator with administrative access rights for the project he or she is assigned with.</td>\n</tr>\n<tr>\n<td><code>data_delivery</code></td>\n<td>Data deliverer with limited access rights.</td>\n</tr>\n<tr>\n<td colspan=\"2\">There are custom roles that are created by the administrator. As long as an API method allow role \"user\" a user with a custom role is allows to call this method.</td>\n</tr>\n</tbody>\n</table>\n\n## About OCBJSONFileReference\n\nOCB uses the IO pattern, that means that each task processes inputs to outputs. Both, inputs and outputs are uploaded as files, even when changing tasks. To represent existing IO as file we developed a JSON structure:\n\n````json\n  type!: 'ocb-file';\n  version!: string;\n\n  // task_input_output_id. If set it means that a given task_input_output should be changed\n  id?: string;\n  // either file.id, file.url or file.hash must exist\n  file?: {\n    // project_file_id. If id and file.id set it means that project_file of a given task_io with id should be changed to file.id\n    id?: string; // <- project_file_id\n\n    // if no ids set, create new project_file with given data if it doesn exist\n    url?: string;\n    filename?: string;\n    hash?: string;\n    path?: string;\n    metaData?: OCBAudioFileMetaData;\n    content?: string;\n    file_type?: string;\n    content_type?: string;\n    size?: number;\n  };\n````\n\nThat allows developers to control the changing mechanism of IOs: If `id` is set to id x it tells OCB to use IO with id x. Further more, if `file.id` is set to y, it tells OCB to use file_project with id y. If you add more attributes to `file` OCB checks if file_project needs to be updated.\n\nIf you don't set `id` it tells OCB to create a new IO with the other data applied in this JSON. If you don't set `file.id` it tells OCB to (additionally) create a new file_project with given data. As you can see, you can manipulate this JSON as you wish.\n",
    "version": "0.9.3",
    "contact": {}
  },
  "tags": [],
  "servers": [],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      },
      "roles": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "RoleBadgeSettings": {
        "type": "object",
        "properties": {}
      },
      "RoleDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "scope": {
            "enum": [
              "system",
              "project"
            ],
            "type": "string"
          },
          "readonly": {
            "type": "boolean"
          },
          "i18n": {
            "type": "object"
          },
          "badge": {
            "$ref": "#/components/schemas/RoleBadgeSettings"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "label",
          "scope",
          "readonly",
          "i18n",
          "badge",
          "id"
        ]
      },
      "RoleCreateDto": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "i18n": {
            "type": "object"
          },
          "badge": {
            "$ref": "#/components/schemas/RoleBadgeSettings"
          }
        },
        "required": [
          "label",
          "i18n",
          "badge"
        ]
      },
      "AppTokenOptionsDto": {
        "type": "object",
        "properties": {
          "registrations": {
            "type": "boolean",
            "description": "defines that this app may use registerAccount() function",
            "default": false
          },
          "reset_password": {
            "type": "boolean",
            "description": "defines that this app may use resetPassword() function",
            "default": false
          },
          "authentications": {
            "type": "array",
            "description": "defines the valid authentication methods for this app. Default: all supported methods",
            "default": [
              "local",
              "shibboleth"
            ],
            "items": {
              "type": "string",
              "enum": [
                "local",
                "shibboleth"
              ]
            }
          },
          "shutdown": {
            "type": "boolean",
            "description": "defines that this app may use shutdownSystem() function",
            "default": false
          },
          "send_feedback": {
            "type": "boolean",
            "description": "defines that this app may use the sendFeedback() function",
            "default": false
          }
        }
      },
      "AppTokenDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "name": {
            "type": "string",
            "description": "identifier for the app token",
            "example": "test token"
          },
          "key": {
            "type": "string",
            "description": "app token for client requests",
            "example": "27t9VVR&/)Fv68gh8e()ZN=&b"
          },
          "domain": {
            "type": "string",
            "description": "domains separated by comma, without 'www'",
            "example": "exampledomain.com, exampledomain.de"
          },
          "description": {
            "type": "string",
            "description": "description of the app token",
            "example": "This token is just a test token"
          },
          "options": {
            "description": "options related to this apptoken.",
            "allOf": [
              {
                "$ref": "#/components/schemas/AppTokenOptionsDto"
              }
            ]
          },
          "tool_id": {
            "type": "number",
            "description": "tool that uses this apptoken."
          },
          "readonly": {
            "type": "boolean",
            "description": "boolean that describes if apptoken may be changed"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "name",
          "key",
          "id"
        ]
      },
      "StandardPageDto": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "label used e.g. for"
          },
          "start": {
            "type": "number",
            "description": "start indicator for interval or page"
          },
          "length": {
            "type": "number",
            "description": "end indicator for interval"
          }
        }
      },
      "AppTokenListDto": {
        "type": "object",
        "properties": {
          "list": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppTokenDto"
            }
          },
          "type": {
            "description": "representation type",
            "enum": [
              "page",
              "interval"
            ],
            "type": "string"
          },
          "current": {
            "$ref": "#/components/schemas/StandardPageDto"
          },
          "maxCount": {
            "type": "number"
          }
        },
        "required": [
          "list",
          "type",
          "current"
        ]
      },
      "AppTokenCreateDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "identifier for the app token",
            "example": "test token"
          },
          "domain": {
            "type": "string",
            "description": "domains separated by comma, without 'www'",
            "example": "exampledomain.com, exampledomain.de"
          },
          "description": {
            "type": "string",
            "description": "description of the app token",
            "example": "This token is just a test token"
          },
          "options": {
            "description": "options related to this apptoken.",
            "allOf": [
              {
                "$ref": "#/components/schemas/AppTokenOptionsDto"
              }
            ]
          },
          "tool_id": {
            "type": "number",
            "description": "tool that uses this apptoken."
          }
        }
      },
      "AppTokenChangeDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "identifier for the app token",
            "example": "test token"
          },
          "domain": {
            "type": "string",
            "description": "domains separated by comma, without 'www'",
            "example": "exampledomain.com, exampledomain.de"
          },
          "description": {
            "type": "string",
            "description": "description of the app token",
            "example": "This token is just a test token"
          },
          "options": {
            "description": "options related to this apptoken.",
            "allOf": [
              {
                "$ref": "#/components/schemas/AppTokenOptionsDto"
              }
            ]
          },
          "tool_id": {
            "type": "number",
            "description": "tool that uses this apptoken."
          }
        }
      },
      "DataPackageOptionConverter": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "formats": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "levelIndex": {
            "type": "number"
          }
        },
        "required": [
          "name",
          "formats"
        ]
      },
      "DownloadPackageOptionsDto": {
        "type": "object",
        "properties": {
          "active_until": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "tool_configurations": {
            "type": "object",
            "properties": {
              "assets": {
                "required": true,
                "type": "boolean"
              },
              "properties": {
                "required": true,
                "type": "boolean"
              }
            }
          },
          "tasks": {
            "type": "object",
            "properties": {
              "all_tasks": {
                "required": false,
                "type": "array",
                "items": {
                  "type": "object"
                }
              },
              "files": {
                "required": false,
                "type": "array",
                "items": {
                  "type": "object"
                }
              },
              "converters": {
                "required": false,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/DataPackageOptionConverter"
                }
              }
            }
          },
          "workers": {
            "type": "object",
            "properties": {
              "all_workers": {
                "required": false,
                "type": "array",
                "items": {
                  "type": "object"
                }
              }
            }
          },
          "package_log": {
            "type": "boolean"
          }
        },
        "required": [
          "tool_configurations",
          "tasks",
          "workers"
        ]
      },
      "AccountProjectRoleDto2": {
        "type": "object",
        "properties": {
          "valid_startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "valid_enddate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "i18n": {
            "type": "object"
          },
          "badge": {
            "$ref": "#/components/schemas/RoleBadgeSettings"
          }
        },
        "required": [
          "id",
          "label"
        ]
      },
      "ProjectRoleDto": {
        "type": "object",
        "properties": {
          "account_id": {
            "type": "string",
            "description": "account id",
            "example": "12312"
          },
          "roles": {
            "default": [],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountProjectRoleDto2"
            }
          },
          "first_name": {
            "type": "string",
            "description": "first name",
            "example": "Max"
          },
          "last_name": {
            "type": "string",
            "description": "last name",
            "example": "Mustermann"
          },
          "username": {
            "type": "string",
            "description": "username",
            "example": "muster1267"
          }
        },
        "required": [
          "account_id",
          "roles"
        ]
      },
      "ProjectDtoStatusStatistics": {
        "type": "object",
        "properties": {
          "free": {
            "type": "number"
          },
          "paused": {
            "type": "number"
          },
          "busy": {
            "type": "number"
          },
          "finished": {
            "type": "number"
          },
          "postponed": {
            "type": "number"
          },
          "failed": {
            "type": "number"
          }
        },
        "required": [
          "free",
          "paused",
          "busy",
          "finished",
          "postponed",
          "failed"
        ]
      },
      "ProjectDtoTasksStatistics": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/ProjectDtoStatusStatistics"
          }
        },
        "required": [
          "type",
          "status"
        ]
      },
      "ProjectDtoStatistics": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/ProjectDtoStatusStatistics"
          },
          "tasks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectDtoTasksStatistics"
            }
          }
        },
        "required": [
          "status",
          "tasks"
        ]
      },
      "OCBProjectAccountsPersonalAccessRights": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "email": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "gender": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "firstname": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "lastname": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "organization": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "age": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "address": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "address details": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "phone": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "town": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "postcode": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "country": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "locale": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          },
          "timezone": {
            "type": "string",
            "enum": [
              "r",
              "w",
              "rw"
            ]
          }
        }
      },
      "OCBProjectAccountsAccessRights": {
        "type": "object",
        "properties": {
          "personal": {
            "$ref": "#/components/schemas/OCBProjectAccountsPersonalAccessRights"
          }
        }
      },
      "OCBProjectAccessRights": {
        "type": "object",
        "properties": {
          "accounts": {
            "$ref": "#/components/schemas/OCBProjectAccountsAccessRights"
          }
        }
      },
      "ProjectAccessRights": {
        "type": "object",
        "properties": {
          "ocb": {
            "$ref": "#/components/schemas/OCBProjectAccessRights"
          },
          "acf": {
            "type": "object"
          }
        }
      },
      "ProjectDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "enddate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "name": {
            "type": "string",
            "description": "name of the project.",
            "example": "TestProject"
          },
          "active": {
            "type": "boolean",
            "description": "describes if the project is active",
            "example": true
          },
          "visibility": {
            "description": "visibility of the project.",
            "example": "public",
            "enum": [
              "public",
              "private"
            ],
            "type": "string"
          },
          "shortname": {
            "type": "string",
            "description": "short identifier of the project.",
            "example": "testproj"
          },
          "description": {
            "type": "string",
            "description": "short description of the project",
            "example": "This project is for the orthographic transcription of speech recordings."
          },
          "roles": {
            "default": [],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectRoleDto"
            }
          },
          "statistics": {
            "$ref": "#/components/schemas/ProjectDtoStatistics"
          },
          "access_rights": {
            "$ref": "#/components/schemas/ProjectAccessRights"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "id",
          "name",
          "active",
          "visibility",
          "roles"
        ]
      },
      "ProjectListDto": {
        "type": "object",
        "properties": {
          "list": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectDto"
            }
          },
          "type": {
            "description": "representation type",
            "enum": [
              "page",
              "interval"
            ],
            "type": "string"
          },
          "current": {
            "$ref": "#/components/schemas/StandardPageDto"
          },
          "maxCount": {
            "type": "number"
          }
        },
        "required": [
          "list",
          "type",
          "current"
        ]
      },
      "AccountStatisticItemDto": {
        "type": "object",
        "properties": {
          "role_name": {
            "type": "object"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "role_name",
          "count"
        ]
      },
      "ProjectStatisticsDto": {
        "type": "object",
        "properties": {
          "tasks": {
            "type": "object",
            "properties": {
              "drafts": {
                "required": true,
                "type": "number"
              },
              "free": {
                "required": true,
                "type": "number"
              },
              "paused": {
                "required": true,
                "type": "number"
              },
              "busy": {
                "required": true,
                "type": "number"
              },
              "finished": {
                "required": true,
                "type": "number"
              },
              "failed": {
                "required": true,
                "type": "number"
              },
              "postponed": {
                "required": true,
                "type": "number"
              },
              "all": {
                "required": true,
                "type": "number"
              }
            }
          },
          "accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountStatisticItemDto"
            }
          }
        },
        "required": [
          "tasks",
          "accounts"
        ]
      },
      "ProjectRequestDto": {
        "type": "object",
        "properties": {
          "startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "enddate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "name": {
            "type": "string",
            "description": "name of the project.",
            "example": "TestProject"
          },
          "shortname": {
            "type": "string",
            "description": "short identifier of the project.",
            "example": "testproj"
          },
          "visibility": {
            "description": "visibility of the project.",
            "example": "public",
            "enum": [
              "public",
              "private"
            ],
            "type": "string"
          },
          "description": {
            "type": "string",
            "description": "short description of the project",
            "example": "This project is for the orthographic transcription of speech recordings."
          },
          "active": {
            "type": "boolean",
            "description": "describes if the project is active",
            "example": true
          },
          "access_rights": {
            "$ref": "#/components/schemas/ProjectAccessRights"
          }
        },
        "required": [
          "name",
          "shortname",
          "visibility"
        ]
      },
      "ProjectRemoveRequestDto": {
        "type": "object",
        "properties": {
          "removeProjectFiles": {
            "type": "boolean",
            "description": "describes if all files related to the project shall be deleted.",
            "example": false
          }
        },
        "required": [
          "removeProjectFiles"
        ]
      },
      "JSONSetFileAssetsConstraints": {
        "type": "object",
        "properties": {
          "defaultName": {
            "type": "string"
          },
          "defaultFile": {
            "type": "object"
          },
          "schemaFile": {
            "type": "object"
          },
          "extension": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "content": {
            "type": "string"
          },
          "mimeType": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "size": {
            "type": "string"
          },
          "namePattern": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "JSONFileSetAssetStatement": {
        "type": "object",
        "properties": {
          "with": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JSONSetFileAssetsConstraints"
            }
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "select": {
            "type": "string"
          }
        },
        "required": [
          "with",
          "select"
        ]
      },
      "JSONFileSetAssetCombination": {
        "type": "object",
        "properties": {
          "type": {
            "type": "object"
          },
          "expressions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JSONFileSetAssetStatement"
            }
          }
        },
        "required": [
          "type",
          "expressions"
        ]
      },
      "JSONFileSetAssetsDefinition": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "combine": {
            "$ref": "#/components/schemas/JSONFileSetAssetCombination"
          }
        },
        "required": [
          "combine"
        ]
      },
      "SupportedTaskTypeDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "neededAssets": {
            "$ref": "#/components/schemas/JSONFileSetAssetsDefinition"
          },
          "style": {
            "type": "object",
            "properties": {
              "color": {
                "required": false,
                "type": "string"
              },
              "backgroundColor": {
                "required": false,
                "type": "string"
              }
            }
          }
        },
        "required": [
          "name",
          "style"
        ]
      },
      "JSONSETFileConstraints": {
        "type": "object",
        "properties": {
          "extension": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "content": {
            "type": "string"
          },
          "mimeType": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "size": {
            "type": "string"
          },
          "namePattern": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "JSONFileSetStatement": {
        "type": "object",
        "properties": {
          "with": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JSONSETFileConstraints"
            }
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "select": {
            "type": "string"
          }
        },
        "required": [
          "with",
          "select"
        ]
      },
      "JSONFileSetDefinition": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "combine": {
            "type": "object"
          },
          "expressions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JSONFileSetStatement"
            }
          }
        },
        "required": [
          "combine",
          "expressions"
        ]
      },
      "IOValidation": {
        "type": "object",
        "properties": {
          "supportedTasks": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "inputs": {
            "$ref": "#/components/schemas/JSONFileSetDefinition"
          },
          "outputs": {
            "$ref": "#/components/schemas/JSONFileSetDefinition"
          }
        },
        "required": [
          "supportedTasks",
          "inputs",
          "outputs"
        ]
      },
      "ToolDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "supportedTaskTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SupportedTaskTypeDto"
            }
          },
          "id": {
            "type": "number",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "name": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "authors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "homepage": {
            "type": "string"
          },
          "icon": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "enum": [
              "web-application",
              "console-application",
              "desktop-application"
            ],
            "type": "string"
          },
          "processingType": {
            "enum": [
              "manual",
              "automatic"
            ],
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "pid": {
            "type": "string"
          },
          "defaultPreferences": {
            "type": "object"
          },
          "preferencesSchema": {
            "type": "object"
          },
          "ioValidation": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOValidation"
            }
          },
          "active": {
            "type": "boolean"
          },
          "installed": {
            "type": "boolean"
          },
          "folder_name": {
            "type": "string"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "supportedTaskTypes",
          "id",
          "name",
          "version",
          "authors",
          "defaultPreferences",
          "active",
          "installed",
          "folder_name"
        ]
      },
      "ToolListDto": {
        "type": "object",
        "properties": {
          "list": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ToolDto"
            }
          },
          "type": {
            "description": "representation type",
            "enum": [
              "page",
              "interval"
            ],
            "type": "string"
          },
          "current": {
            "$ref": "#/components/schemas/StandardPageDto"
          },
          "maxCount": {
            "type": "number"
          }
        },
        "required": [
          "list",
          "type",
          "current"
        ]
      },
      "ToolChangeRequestDto": {
        "type": "object",
        "properties": {
          "active": {
            "type": "boolean"
          }
        }
      },
      "AllAccountsGenderStatistics": {
        "type": "object",
        "properties": {
          "male": {
            "type": "number"
          },
          "female": {
            "type": "number"
          },
          "divers": {
            "type": "number"
          }
        },
        "required": [
          "male",
          "female",
          "divers"
        ]
      },
      "AllAccountsSystemRolesStatistics": {
        "type": "object",
        "properties": {
          "administrator": {
            "type": "number"
          },
          "user": {
            "type": "number"
          },
          "app": {
            "type": "number"
          }
        },
        "required": [
          "administrator",
          "user",
          "app"
        ]
      },
      "StatisticsProjectRoleDto": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "i18n": {
            "type": "object"
          },
          "value": {
            "type": "number"
          }
        },
        "required": [
          "label",
          "i18n",
          "value"
        ]
      },
      "AllAccountStatistics": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number"
          },
          "online": {
            "type": "number"
          },
          "activeLast30Days": {
            "type": "number"
          },
          "registrationsLast30Days": {
            "type": "number"
          },
          "activated": {
            "type": "number"
          },
          "deleted": {
            "type": "number"
          },
          "gender": {
            "$ref": "#/components/schemas/AllAccountsGenderStatistics"
          },
          "roles": {
            "type": "object",
            "properties": {
              "system": {
                "required": true,
                "$ref": "#/components/schemas/AllAccountsSystemRolesStatistics"
              },
              "project": {
                "required": true,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StatisticsProjectRoleDto"
                }
              }
            }
          }
        },
        "required": [
          "total",
          "online",
          "activeLast30Days",
          "registrationsLast30Days",
          "activated",
          "deleted",
          "gender",
          "roles"
        ]
      },
      "AllProjectsStatistics": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number"
          },
          "active": {
            "type": "number"
          },
          "inactive": {
            "type": "number"
          },
          "private": {
            "type": "number"
          },
          "public": {
            "type": "number"
          },
          "running": {
            "type": "number"
          },
          "scheduled": {
            "type": "number"
          }
        },
        "required": [
          "total",
          "active",
          "inactive",
          "private",
          "public",
          "running",
          "scheduled"
        ]
      },
      "AllStatisticsTasksDto": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number"
          },
          "free": {
            "type": "number"
          },
          "busy": {
            "type": "number"
          },
          "postponed": {
            "type": "number"
          },
          "paused": {
            "type": "number"
          },
          "finished": {
            "type": "number"
          },
          "failed": {
            "type": "number"
          },
          "draft": {
            "type": "number"
          },
          "averageDuration": {
            "type": "number",
            "description": "average duration of finished tasks in seconds"
          },
          "medianDuration": {
            "type": "number",
            "description": "median duration of finished tasks in seconds"
          }
        },
        "required": [
          "total",
          "free",
          "busy",
          "postponed",
          "paused",
          "finished",
          "failed",
          "draft",
          "averageDuration",
          "medianDuration"
        ]
      },
      "AllStatisticsDto": {
        "type": "object",
        "properties": {
          "last_updated": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "accounts": {
            "$ref": "#/components/schemas/AllAccountStatistics"
          },
          "projects": {
            "$ref": "#/components/schemas/AllProjectsStatistics"
          },
          "tasks": {
            "$ref": "#/components/schemas/AllStatisticsTasksDto"
          }
        },
        "required": [
          "last_updated",
          "accounts",
          "projects",
          "tasks"
        ]
      },
      "SystemRoleDto": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "i18n": {
            "type": "object"
          },
          "badge": {
            "$ref": "#/components/schemas/RoleBadgeSettings"
          }
        },
        "required": [
          "label",
          "i18n",
          "badge"
        ]
      },
      "AccountProjectRoleDto": {
        "type": "object",
        "properties": {
          "valid_startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "valid_enddate": {
            "type": "string",
            "description": "end date (ISO 8601)",
            "example": "2022-09-12T12:00.000Z"
          },
          "role": {
            "type": "string"
          },
          "scope": {
            "type": "string",
            "enum": [
              "system",
              "project"
            ]
          },
          "project_id": {
            "type": "string"
          },
          "project_name": {
            "type": "string"
          },
          "i18n": {
            "type": "object"
          },
          "badge": {
            "$ref": "#/components/schemas/RoleBadgeSettings"
          }
        },
        "required": [
          "role",
          "scope"
        ]
      },
      "CurrentAccountDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "email": {
            "type": "string",
            "description": "email address of the account",
            "example": "email@test.com"
          },
          "email_verified": {
            "type": "boolean",
            "description": "email address of the account",
            "example": "email@test.com"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "username": {
            "type": "string",
            "description": "username of the account",
            "example": "testuser"
          },
          "locale": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "systemRole": {
            "description": "the system user role.",
            "example": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SystemRoleDto"
              }
            ]
          },
          "projectRoles": {
            "description": "user roles of this account associated to specific projects.",
            "example": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountProjectRoleDto"
            }
          },
          "last_login": {
            "type": "string",
            "description": "date on that this account logged in.\n@example: 2022-09-12T12:00.000Z"
          }
        },
        "required": [
          "id",
          "email",
          "email_verified",
          "first_name",
          "last_name",
          "username",
          "locale",
          "timezone",
          "systemRole",
          "projectRoles"
        ]
      },
      "AuthDto": {
        "type": "object",
        "properties": {
          "openURL": {
            "type": "string",
            "description": "if the authentication method is shibboleth, this URL directs to the confirmShibboleth page. If there are pending agreements, this URL directs to the agreement page. Undefined otherwise."
          },
          "accessToken": {
            "type": "string",
            "description": "this token exists if the authentication was successful (correct credentials & no pending agreements)."
          },
          "agreementToken": {
            "type": "string",
            "description": "this token exists if there are any policies the user has to agree with. `openURL` will direct to an agreement page. The duration of this token is set to 1 hour. This token can only be used on the agreement page."
          },
          "me": {
            "description": "this property only exists if the authentication was successful.",
            "allOf": [
              {
                "$ref": "#/components/schemas/CurrentAccountDto"
              }
            ]
          }
        }
      },
      "AccountDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "birthday": {
            "type": "string",
            "description": "yyyy-MM-DD"
          },
          "username": {
            "type": "string",
            "description": "username of the account",
            "example": "testuser"
          },
          "email": {
            "type": "string",
            "description": "email address of the account",
            "example": "email@test.com"
          },
          "email_verified": {
            "type": "boolean",
            "description": "email address of the account",
            "example": "email@test.com"
          },
          "loginmethod": {
            "description": "login method",
            "example": "local",
            "enum": [
              "local",
              "shibboleth"
            ],
            "type": "string"
          },
          "gender": {
            "enum": [
              "male",
              "female",
              "divers"
            ],
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "address_details": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "town": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "active": {
            "type": "boolean",
            "description": "describes if the account is active.",
            "example": true
          },
          "comment": {
            "type": "string",
            "description": "some comment about this account."
          },
          "organization": {
            "type": "string"
          },
          "systemRole": {
            "description": "the system user role.",
            "example": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SystemRoleDto"
              }
            ]
          },
          "projectRoles": {
            "description": "user roles of this account associated to specific projects.",
            "example": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountProjectRoleDto"
            }
          },
          "last_login": {
            "type": "string",
            "description": "date on that this account logged in.\n@example: 2022-09-12T12:00.000Z"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "birthday",
          "username",
          "email",
          "email_verified",
          "loginmethod",
          "gender",
          "first_name",
          "last_name",
          "address",
          "address_details",
          "phone",
          "timezone",
          "town",
          "postcode",
          "state",
          "country",
          "locale",
          "active",
          "systemRole",
          "projectRoles",
          "id"
        ]
      },
      "ChangeAccountInformationDto": {
        "type": "object",
        "properties": {
          "birthday": {
            "type": "string",
            "description": "yyyy-MM-DD"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female",
              "divers"
            ]
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "organization": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "address_details": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "town": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        },
        "required": [
          "first_name",
          "last_name",
          "gender",
          "state",
          "country"
        ]
      },
      "ChangePasswordDto": {
        "type": "object",
        "properties": {
          "oldPassword": {
            "type": "string",
            "description": "the previous password.",
            "example": "278z42374z2834z72"
          },
          "newPassword": {
            "type": "string",
            "description": "the new password.",
            "example": "the new password."
          }
        },
        "required": [
          "oldPassword",
          "newPassword"
        ]
      },
      "AccountSettingsDto": {
        "type": "object",
        "properties": {
          "timezone": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          }
        }
      },
      "AccountFieldDefinition2": {
        "type": "object",
        "properties": {}
      },
      "AccountFieldDefinition": {
        "type": "object",
        "properties": {
          "schema": {
            "type": "object"
          },
          "isRequired": {
            "type": "boolean"
          },
          "multipleResults": {
            "type": "boolean"
          }
        },
        "required": [
          "schema"
        ]
      },
      "AccountFieldDefinitionCreateDto": {
        "type": "object",
        "properties": {
          "context": {
            "description": "Context where this field is going to be visible",
            "enum": [
              "project",
              "account"
            ],
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "Unique name of the definition"
          },
          "type": {
            "description": "Type of the control which is used for this definition",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition2"
              }
            ]
          },
          "definition": {
            "description": "Schema that is used to generate the control",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition"
              }
            ]
          },
          "active": {
            "type": "boolean",
            "description": "Describes if the control is visible or not"
          },
          "sort_order": {
            "type": "number",
            "description": "Sort order of the definition"
          }
        },
        "required": [
          "context",
          "name",
          "type",
          "definition",
          "active",
          "sort_order"
        ]
      },
      "AccountFieldDefinitionDto": {
        "type": "object",
        "properties": {
          "context": {
            "description": "Context where this field is going to be visible",
            "enum": [
              "project",
              "account"
            ],
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "Unique name of the definition"
          },
          "type": {
            "description": "Type of the control which is used for this definition",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition2"
              }
            ]
          },
          "definition": {
            "description": "Schema that is used to generate the control",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition"
              }
            ]
          },
          "removable": {
            "type": "boolean",
            "description": "Describes if administrators or project administrators may delete this definition"
          },
          "active": {
            "type": "boolean",
            "description": "Describes if the control is visible or not"
          },
          "sort_order": {
            "type": "number",
            "description": "Sort order of the definition"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "context",
          "name",
          "type",
          "definition",
          "removable",
          "active",
          "sort_order",
          "id"
        ]
      },
      "AccountFieldValueDefinitionDto": {
        "type": "object",
        "properties": {
          "context": {
            "description": "Context where this field is going to be visible",
            "enum": [
              "project",
              "account"
            ],
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "Unique name of the definition"
          },
          "type": {
            "description": "Type of the control which is used for this definition",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition2"
              }
            ]
          },
          "definition": {
            "description": "Schema that is used to generate the control",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition"
              }
            ]
          },
          "removable": {
            "type": "boolean",
            "description": "Describes if administrators or project administrators may delete this definition"
          },
          "active": {
            "type": "boolean",
            "description": "Describes if the control is visible or not"
          },
          "sort_order": {
            "type": "number",
            "description": "Sort order of the definition"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "value": {
            "type": "object"
          }
        },
        "required": [
          "context",
          "name",
          "type",
          "definition",
          "removable",
          "active",
          "sort_order",
          "id",
          "value"
        ]
      },
      "AccountMinimalDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "birthday": {
            "type": "string",
            "description": "yyyy-MM-DD"
          },
          "last_activity": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "username": {
            "type": "string",
            "description": "username of the account",
            "example": "testuser"
          },
          "email": {
            "type": "string",
            "description": "email address of the account",
            "example": "email@test.com"
          },
          "email_verified": {
            "type": "boolean",
            "description": "email address of the account",
            "example": "email@test.com"
          },
          "loginmethod": {
            "type": "string",
            "description": "login method",
            "example": "local",
            "enum": [
              "local",
              "shibboleth"
            ]
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female",
              "divers"
            ]
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "town": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "active": {
            "type": "boolean",
            "description": "describes if the account is active.",
            "example": true
          },
          "comment": {
            "type": "string",
            "description": "some comment about this account."
          },
          "organization": {
            "type": "string"
          },
          "systemRole": {
            "description": "the system user role.",
            "example": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SystemRoleDto"
              }
            ]
          },
          "projectRoles": {
            "description": "user roles of this account associated to specific projects.",
            "example": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountProjectRoleDto"
            }
          },
          "last_login": {
            "type": "string",
            "description": "date on that this account logged in.\n@example: 2022-09-12T12:00.000Z"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "birthday",
          "id",
          "username",
          "email",
          "email_verified",
          "loginmethod",
          "gender",
          "first_name",
          "last_name",
          "phone",
          "timezone",
          "town",
          "postcode",
          "state",
          "country",
          "locale",
          "active",
          "systemRole",
          "projectRoles"
        ]
      },
      "AccountMinimalListDto": {
        "type": "object",
        "properties": {
          "list": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountMinimalDto"
            }
          },
          "type": {
            "type": "string",
            "description": "representation type",
            "enum": [
              "page",
              "interval"
            ]
          },
          "current": {
            "$ref": "#/components/schemas/StandardPageDto"
          },
          "maxCount": {
            "type": "number"
          }
        },
        "required": [
          "list",
          "type",
          "current"
        ]
      },
      "AccountCreateRequestDto": {
        "type": "object",
        "properties": {
          "birthday": {
            "type": "string",
            "description": "yyyy-MM-DD"
          },
          "username": {
            "type": "string",
            "description": "account name",
            "example": "testuser"
          },
          "password": {
            "type": "string",
            "description": "password of the account",
            "example": "asdasda2345345243"
          },
          "email": {
            "type": "string",
            "description": "account email",
            "example": "test@test.com"
          },
          "role": {
            "type": "string",
            "description": "general account role",
            "example": "test@test.com",
            "enum": [
              "administrator",
              "user",
              "app"
            ]
          },
          "organization": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female",
              "divers"
            ]
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "address_details": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "town": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "acceptedPolicyTranslationIDs": {
            "type": "array",
            "items": {
              "type": "number"
            }
          }
        },
        "required": [
          "username",
          "password",
          "email",
          "role"
        ]
      },
      "AccountRegisterRequestDto": {
        "type": "object",
        "properties": {
          "birthday": {
            "type": "string",
            "description": "yyyy-MM-DD"
          },
          "username": {
            "type": "string",
            "description": "account name",
            "example": "testuser"
          },
          "password": {
            "type": "string",
            "description": "password of the account",
            "example": "asdasda2345345243"
          },
          "email": {
            "type": "string",
            "description": "account email",
            "example": "test@test.com"
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female",
              "divers"
            ]
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "organization": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "address_details": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "town": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "redirectTo": {
            "type": "string",
            "description": "defines the URL to that the user is redirected to after he/she confirms his/her e-mail address."
          },
          "acceptedPolicyTranslationIDs": {
            "type": "array",
            "items": {
              "type": "number"
            }
          }
        },
        "required": [
          "username",
          "password",
          "email",
          "first_name",
          "last_name",
          "locale",
          "timezone",
          "acceptedPolicyTranslationIDs"
        ]
      },
      "AccountRegisterResponseDto": {
        "type": "object",
        "properties": {
          "nextAction": {
            "type": "object"
          }
        },
        "required": [
          "nextAction"
        ]
      },
      "AccountSearchResultDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "username": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "first_name",
          "last_name",
          "email",
          "username"
        ]
      },
      "AccountChangeDto": {
        "type": "object",
        "properties": {
          "birthday": {
            "type": "string",
            "description": "yyyy-MM-DD"
          },
          "username": {
            "type": "string",
            "description": "account name",
            "example": "testuser"
          },
          "email": {
            "type": "string",
            "description": "account email",
            "example": "test@test.com"
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female",
              "divers"
            ]
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "organization": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "address_details": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "town": {
            "type": "string"
          },
          "postcode": {
            "type": "string"
          },
          "acceptedPolicyTranslationIDs": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "role": {
            "type": "string",
            "description": "general account role",
            "example": "test@test.com",
            "enum": [
              "administrator",
              "user",
              "app"
            ]
          },
          "comment": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          }
        },
        "required": [
          "username",
          "email",
          "role"
        ]
      },
      "ResetPasswordRequestDto": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "redirectTo": {
            "type": "string"
          }
        },
        "required": [
          "email"
        ]
      },
      "AccountBatchActionDto": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "enum": [
              "set_active",
              "set_inactive",
              "send_email_verification",
              "send_password_reset"
            ]
          },
          "accountIDs": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "redirectTo": {
            "type": "string"
          }
        },
        "required": [
          "action",
          "accountIDs"
        ]
      },
      "PolicyMinimalDto": {
        "type": "object",
        "properties": {
          "publishdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "translations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "id": {
            "type": "number"
          },
          "type": {
            "type": "string",
            "enum": [
              "privacy",
              "terms_and_conditions"
            ]
          },
          "version": {
            "type": "number"
          },
          "numberOfConsents": {
            "type": "number"
          }
        },
        "required": [
          "creationdate",
          "translations",
          "id",
          "type",
          "version",
          "numberOfConsents"
        ]
      },
      "PolicyTranslationViewDto": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "privacy",
              "terms_and_conditions"
            ]
          }
        },
        "required": [
          "type"
        ]
      },
      "PolicyPublishRequestItemDto": {
        "type": "object",
        "properties": {
          "publishdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "number"
          }
        },
        "required": [
          "publishdate",
          "id"
        ]
      },
      "PolicyPublishRequestDto": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PolicyPublishRequestItemDto"
            }
          }
        },
        "required": [
          "items"
        ]
      },
      "PolicyTranslationDto": {
        "type": "object",
        "properties": {
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "number"
          },
          "locale": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "author": {
            "type": "string",
            "description": "author's username"
          },
          "numberOfConsents": {
            "type": "number"
          }
        },
        "required": [
          "updatedate",
          "creationdate",
          "id",
          "locale",
          "author",
          "numberOfConsents"
        ]
      },
      "PolicyDto": {
        "type": "object",
        "properties": {
          "publishdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "number"
          },
          "type": {
            "enum": [
              "privacy",
              "terms_and_conditions"
            ],
            "type": "string"
          },
          "version": {
            "type": "number"
          },
          "translations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PolicyTranslationDto"
            }
          },
          "numberOfConsents": {
            "type": "number"
          }
        },
        "required": [
          "creationdate",
          "id",
          "type",
          "version",
          "translations",
          "numberOfConsents"
        ]
      },
      "PolicyCreateRequestDto": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "privacy",
              "terms_and_conditions"
            ],
            "type": "string"
          }
        },
        "required": [
          "type"
        ]
      },
      "FileHashStorage": {
        "type": "object",
        "properties": {}
      },
      "PolicyCreateTranslationDto": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string"
          },
          "files": {
            "description": "the input files",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "url": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "locale"
        ]
      },
      "PolicyChangeRequestDto": {
        "type": "object",
        "properties": {
          "publishdate": {
            "type": "string",
            "nullable": true,
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "type": {
            "enum": [
              "privacy",
              "terms_and_conditions"
            ],
            "type": "string"
          }
        },
        "required": [
          "type"
        ]
      },
      "PolicyListItemTranslationDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "locale": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "locale"
        ]
      },
      "PolicyListItemDto": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "privacy",
              "terms_and_conditions"
            ]
          },
          "required": {
            "type": "boolean"
          },
          "version": {
            "type": "number"
          },
          "translations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PolicyListItemTranslationDto"
            }
          }
        },
        "required": [
          "type",
          "required",
          "version",
          "translations"
        ]
      },
      "GeneralSettingsDto": {
        "type": "object",
        "properties": {
          "mail_support_address": {
            "type": "string"
          }
        }
      },
      "AppPropertiesBackupScheduleDto": {
        "type": "object",
        "properties": {
          "cron": {
            "type": "string"
          },
          "remind": {
            "type": "string"
          }
        },
        "required": [
          "cron",
          "remind"
        ]
      },
      "AppPropertiesBackupsDto": {
        "type": "object",
        "properties": {
          "lastBackup": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "status": {
            "type": "object"
          },
          "backupRecommended": {
            "type": "boolean"
          },
          "schedule": {
            "$ref": "#/components/schemas/AppPropertiesBackupScheduleDto"
          }
        },
        "required": [
          "status",
          "backupRecommended"
        ]
      },
      "AppPropertiesMaintenanceDto": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "backup": {
            "$ref": "#/components/schemas/AppPropertiesBackupsDto"
          }
        },
        "required": [
          "enabled"
        ]
      },
      "AppPropertiesSupportDto": {
        "type": "object",
        "properties": {
          "admin_email": {
            "type": "string"
          },
          "manual_url": {
            "type": "string"
          }
        }
      },
      "AppPropertiesDto": {
        "type": "object",
        "properties": {
          "registrations": {
            "type": "boolean",
            "description": "defines that this app may use registerAccount() function",
            "default": false
          },
          "reset_password": {
            "type": "boolean",
            "description": "defines that this app may use resetPassword() function",
            "default": false
          },
          "authentications": {
            "description": "defines the valid authentication methods for this app. Default: all supported methods",
            "default": [
              "local",
              "shibboleth"
            ],
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "local",
                "shibboleth"
              ]
            }
          },
          "shutdown": {
            "type": "boolean",
            "description": "defines that this app may use shutdownSystem() function",
            "default": false
          },
          "send_feedback": {
            "type": "boolean",
            "description": "defines that this app may use the sendFeedback() function",
            "default": false
          },
          "email_notification": {
            "type": "boolean"
          },
          "maintenance": {
            "$ref": "#/components/schemas/AppPropertiesMaintenanceDto"
          },
          "support": {
            "$ref": "#/components/schemas/AppPropertiesSupportDto"
          },
          "defaults": {
            "type": "object",
            "properties": {
              "batch_session": {
                "required": true,
                "type": "string"
              },
              "download_package_expiration": {
                "required": true,
                "type": "string"
              }
            }
          }
        },
        "required": [
          "email_notification",
          "defaults"
        ]
      },
      "ProjectFieldDefinitionDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "context": {
            "type": "string",
            "description": "Context where this field is going to be visible",
            "enum": [
              "project",
              "account"
            ]
          },
          "name": {
            "type": "string",
            "description": "Unique name of the definition"
          },
          "type": {
            "description": "Type of the control which is used for this definition",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition2"
              }
            ]
          },
          "definition": {
            "description": "Schema that is used to generate the control",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountFieldDefinition"
              }
            ]
          },
          "active": {
            "type": "boolean",
            "description": "Describes if the control is visible or not"
          },
          "sort_order": {
            "type": "number",
            "description": "Sort order of the definition"
          }
        },
        "required": [
          "id",
          "context",
          "name",
          "type",
          "definition",
          "active",
          "sort_order"
        ]
      },
      "RunningBackupDto": {
        "type": "object",
        "properties": {
          "destination": {
            "type": "string"
          },
          "backup_data": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "progress": {
            "type": "number"
          },
          "remaining_time": {
            "type": "number"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "destination",
          "backup_data",
          "status",
          "progress",
          "id"
        ]
      },
      "BackupDto": {
        "type": "object",
        "properties": {
          "stopped_on": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "started_on": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "eta_on": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "destination": {
            "type": "string"
          },
          "backup_data": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "progress": {
            "type": "number"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "destination",
          "backup_data",
          "status",
          "progress",
          "id"
        ]
      },
      "FeedbackRequester": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "email"
        ]
      },
      "FeedbackReportTechnicalInformation": {
        "type": "object",
        "properties": {
          "os": {
            "type": "object",
            "properties": {
              "name": {
                "required": false,
                "type": "string"
              },
              "version": {
                "required": false,
                "type": "string"
              }
            }
          },
          "browser": {
            "type": "object",
            "properties": {
              "name": {
                "required": false,
                "type": "string"
              },
              "version": {
                "required": false,
                "type": "string"
              }
            }
          }
        },
        "required": [
          "os",
          "browser"
        ]
      },
      "FeedbackRequestPropertiesDto": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "bug"
            ]
          },
          "requester": {
            "$ref": "#/components/schemas/FeedbackRequester"
          },
          "technicalInformation": {
            "$ref": "#/components/schemas/FeedbackReportTechnicalInformation"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ]
      },
      "FeedbackRequestDto": {
        "type": "object",
        "properties": {
          "properties": {
            "$ref": "#/components/schemas/FeedbackRequestPropertiesDto"
          },
          "protocol": {
            "$ref": "#/components/schemas/FileHashStorage"
          },
          "appending": {
            "description": "appending files",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          }
        },
        "required": [
          "properties"
        ]
      },
      "ToolConfigurationAssetDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "filename": {
            "type": "string"
          },
          "mime_type": {
            "type": "string"
          },
          "content": {
            "type": "object",
            "description": "*\nif JSON it's parsed to an object. Otherwise it's just a string."
          },
          "schema": {
            "type": "object",
            "description": "*\nif JSON it's parsed to an object. Otherwise it's just a string."
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "ToolConfigurationDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "uniqueItems": true
          },
          "id": {
            "type": "string"
          },
          "tool": {
            "$ref": "#/components/schemas/ToolDto"
          },
          "task_type": {
            "$ref": "#/components/schemas/SupportedTaskTypeDto"
          },
          "assets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ToolConfigurationAssetDto"
            }
          },
          "standard": {
            "type": "boolean"
          },
          "tool_id": {
            "type": "number"
          },
          "value": {
            "type": "object"
          }
        },
        "required": [
          "name",
          "id",
          "task_type",
          "tool_id"
        ]
      },
      "ToolConfigurationCreateDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "uniqueItems": true
          },
          "task_type": {
            "type": "string"
          },
          "standard": {
            "type": "boolean"
          },
          "tool_id": {
            "type": "number"
          },
          "value": {
            "type": "object"
          }
        },
        "required": [
          "name",
          "task_type",
          "tool_id"
        ]
      },
      "ToolConfigurationAssetChangeDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "filename": {
            "type": "string"
          },
          "mime_type": {
            "type": "string"
          },
          "content": {
            "type": "object",
            "description": "*\nif JSON it's parsed to an object. Otherwise it's just a string."
          },
          "schema": {
            "type": "object",
            "description": "*\nif JSON it's parsed to an object. Otherwise it's just a string."
          }
        },
        "required": [
          "name"
        ]
      },
      "ToolConfigurationChangeDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "uniqueItems": true
          },
          "assets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ToolConfigurationAssetChangeDto"
            }
          },
          "standard": {
            "type": "boolean"
          },
          "value": {
            "type": "object"
          }
        },
        "required": [
          "name"
        ]
      },
      "TaskProperties": {
        "type": "object",
        "properties": {
          "startdate": {
            "type": "string",
            "nullable": true,
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "enddate": {
            "type": "string",
            "nullable": true,
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "pid": {
            "type": "string",
            "nullable": true
          },
          "orgtext": {
            "type": "string",
            "nullable": true
          },
          "tag": {
            "type": "string",
            "nullable": true
          },
          "assessment": {
            "type": "string",
            "nullable": true
          },
          "priority": {
            "type": "number",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "comment": {
            "type": "string",
            "nullable": true
          },
          "tool_configuration_id": {
            "type": "string",
            "nullable": true
          },
          "admin_comment": {
            "type": "string",
            "nullable": true
          },
          "worker_id": {
            "type": "string",
            "nullable": true
          },
          "nexttask_id": {
            "type": "string",
            "nullable": true
          },
          "use_outputs_from_task_id": {
            "type": "string",
            "nullable": true
          },
          "previoustask_id": {
            "type": "string",
            "nullable": true
          },
          "files_destination": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true,
            "enum": [
              "DRAFT",
              "FREE",
              "PAUSED",
              "BUSY",
              "FINISHED",
              "FAILED",
              "POSTPONED"
            ]
          }
        }
      },
      "IOMetaData": {
        "type": "object",
        "properties": {
          "index": {
            "type": "number",
            "description": "*\nindex where the io can be found from its inputs/outputs array"
          },
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "content_type": {
            "type": "string",
            "description": "defines the type of content e.g. AnnotJSON."
          }
        },
        "required": [
          "index"
        ]
      },
      "TaskUploadDto": {
        "type": "object",
        "properties": {
          "properties": {
            "description": "properties applied to the task",
            "title": "properties",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaskProperties"
              }
            ]
          },
          "inputsMetaData": {
            "default": [],
            "title": "inputsMetaData",
            "description": "label, description for inputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "outputsMetaData": {
            "default": [],
            "title": "outputsMetaData",
            "description": "label, description for outputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "inputs": {
            "description": "the input files",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "log": {
            "description": "the log file",
            "allOf": [
              {
                "$ref": "#/components/schemas/FileHashStorage"
              }
            ]
          },
          "outputs": {
            "description": "the output files",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          }
        },
        "required": [
          "properties"
        ]
      },
      "OCBAudioFileMetaDataDuration": {
        "type": "object",
        "properties": {
          "samples": {
            "type": "number"
          },
          "seconds": {
            "type": "number"
          }
        }
      },
      "OCBAudioFileMetaData": {
        "type": "object",
        "properties": {
          "bitRate": {
            "type": "number"
          },
          "numberOfChannels": {
            "type": "number"
          },
          "duration": {
            "$ref": "#/components/schemas/OCBAudioFileMetaDataDuration"
          },
          "sampleRate": {
            "type": "number"
          },
          "container": {
            "type": "string"
          },
          "codec": {
            "type": "string"
          },
          "lossless": {
            "type": "boolean"
          }
        }
      },
      "TaskInputOutputDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "object"
          },
          "creator_type": {
            "type": "string",
            "enum": [
              "user",
              "app"
            ]
          },
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "filename": {
            "type": "string"
          },
          "directory": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "description": "URL is set if the files content is not retrieved from database."
          },
          "content_type": {
            "type": "string"
          },
          "content": {
            "type": "object"
          },
          "fileType": {
            "type": "string"
          },
          "file_project_id": {
            "type": "string"
          },
          "size": {
            "type": "number"
          },
          "metadata": {
            "$ref": "#/components/schemas/OCBAudioFileMetaData"
          },
          "uploader_username": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "type",
          "creator_type",
          "filename",
          "content_type",
          "content"
        ]
      },
      "TaskDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "enddate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "pid": {
            "type": "string"
          },
          "orgtext": {
            "type": "string"
          },
          "assessment": {
            "type": "string"
          },
          "priority": {
            "type": "number"
          },
          "status": {
            "enum": [
              "DRAFT",
              "FREE",
              "PAUSED",
              "BUSY",
              "FINISHED",
              "FAILED",
              "POSTPONED"
            ],
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          },
          "log": {
            "type": "object"
          },
          "comment": {
            "type": "string"
          },
          "tool_configuration": {
            "$ref": "#/components/schemas/ToolConfigurationDto"
          },
          "admin_comment": {
            "type": "string"
          },
          "progress": {
            "type": "number"
          },
          "worker_id": {
            "type": "string"
          },
          "worker_username": {
            "type": "string"
          },
          "worker_type": {
            "type": "object"
          },
          "previoustask_id": {
            "type": "string"
          },
          "nexttask_id": {
            "type": "string"
          },
          "nexttask": {
            "$ref": "#/components/schemas/TaskDto"
          },
          "use_outputs_from_task_id": {
            "type": "string"
          },
          "use_outputs_from_task": {
            "$ref": "#/components/schemas/TaskDto"
          },
          "inputs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaskInputOutputDto"
            }
          },
          "outputs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaskInputOutputDto"
            }
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "status",
          "inputs",
          "outputs",
          "id"
        ]
      },
      "TaskBatchSessionDto": {
        "type": "object",
        "properties": {
          "session_id": {
            "type": "string"
          },
          "session_timestamp": {
            "type": "number"
          }
        },
        "required": [
          "session_id",
          "session_timestamp"
        ]
      },
      "TaskBatchUploadDto": {
        "type": "object",
        "properties": {
          "properties": {
            "description": "properties applied to the task",
            "title": "properties",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaskProperties"
              }
            ]
          },
          "inputsMetaData": {
            "default": [],
            "title": "inputsMetaData",
            "description": "label, description for inputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "outputsMetaData": {
            "default": [],
            "title": "outputsMetaData",
            "description": "label, description for outputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "inputs": {
            "description": "the input files",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "log": {
            "description": "the log file",
            "allOf": [
              {
                "$ref": "#/components/schemas/FileHashStorage"
              }
            ]
          },
          "outputs": {
            "description": "the output files",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "session_id": {
            "type": "string"
          },
          "session_timestamp": {
            "type": "number"
          }
        },
        "required": [
          "properties",
          "session_id",
          "session_timestamp"
        ]
      },
      "TaskBatchTransactionDto": {
        "type": "object",
        "properties": {
          "transaction_timestamp": {
            "type": "number"
          }
        },
        "required": [
          "transaction_timestamp"
        ]
      },
      "TaskStartActionDto": {
        "type": "object",
        "properties": {
          "task_type": {
            "type": "string"
          }
        },
        "required": [
          "task_type"
        ]
      },
      "TaskChangeDto": {
        "type": "object",
        "properties": {
          "inputsMetaData": {
            "default": [],
            "title": "inputsMetaData",
            "description": "label, description for inputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "outputsMetaData": {
            "default": [],
            "title": "outputsMetaData",
            "description": "label, description for outputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "properties": {
            "description": "properties of the task",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaskProperties"
              }
            ]
          },
          "inputs": {
            "description": "the input files.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "log": {
            "description": "the log file",
            "allOf": [
              {
                "$ref": "#/components/schemas/FileHashStorage"
              }
            ]
          },
          "outputs": {
            "description": "the output files.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          }
        },
        "required": [
          "properties"
        ]
      },
      "TaskSaveProperties": {
        "type": "object",
        "properties": {
          "tag": {
            "type": "string",
            "nullable": true
          },
          "assessment": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "comment": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true,
            "enum": [
              "DRAFT",
              "FREE",
              "PAUSED",
              "BUSY",
              "FINISHED",
              "FAILED",
              "POSTPONED"
            ]
          }
        }
      },
      "TaskSaveDto": {
        "type": "object",
        "properties": {
          "outputsMetaData": {
            "default": [],
            "title": "outputsMetaData",
            "description": "label, description for outputs",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IOMetaData"
            }
          },
          "properties": {
            "description": "properties of the task",
            "allOf": [
              {
                "$ref": "#/components/schemas/TaskSaveProperties"
              }
            ]
          },
          "outputs": {
            "description": "the output files.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "log": {
            "description": "the log file",
            "allOf": [
              {
                "$ref": "#/components/schemas/FileHashStorage"
              }
            ]
          }
        },
        "required": [
          "properties"
        ]
      },
      "LinkOptionsDto": {
        "type": "object",
        "properties": {
          "active_until": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "data": {
            "type": "object"
          }
        }
      },
      "LinkDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "id": {
            "type": "string"
          },
          "creator_id": {
            "type": "string"
          },
          "creator_username": {
            "type": "string"
          },
          "project_id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "hash": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "link": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "access": {
            "type": "string"
          },
          "progress": {
            "type": "number"
          },
          "log": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "options": {
            "$ref": "#/components/schemas/LinkOptionsDto"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "id",
          "creator_id",
          "project_id",
          "type",
          "hash",
          "status",
          "access"
        ]
      },
      "ProjectFileUploadDto": {
        "type": "object",
        "properties": {
          "files": {
            "description": "files to upload.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileHashStorage"
            }
          },
          "target_path": {
            "type": "string",
            "description": "target path (relative to the project folder).",
            "default": ""
          },
          "force_overwrite": {
            "type": "boolean",
            "description": "defines if old files in the same target folder should be overwritten."
          }
        },
        "required": [
          "files"
        ]
      },
      "FileMetaData": {
        "type": "object",
        "properties": {}
      },
      "FileProjectDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "uploader_id": {
            "type": "string"
          },
          "real_name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "size": {
            "type": "number"
          },
          "url": {
            "type": "string"
          },
          "content_type": {
            "type": "string"
          },
          "content": {
            "type": "object"
          },
          "hash": {
            "type": "string"
          },
          "metadata": {
            "$ref": "#/components/schemas/FileMetaData"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          }
        },
        "required": [
          "creationdate",
          "updatedate",
          "url",
          "id"
        ]
      },
      "AccountNameIDDto": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "username",
          "id"
        ]
      },
      "ProjectFileReferenceDto": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ]
      },
      "ProjectFileDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "file_project_id": {
            "type": "string"
          },
          "storage_type": {
            "type": "string",
            "enum": [
              "fs",
              "db"
            ]
          },
          "path": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "hash": {
            "type": "string"
          },
          "uploader": {
            "$ref": "#/components/schemas/AccountNameIDDto"
          },
          "isDirectory": {
            "type": "boolean"
          },
          "references": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectFileReferenceDto"
            }
          },
          "mimeType": {
            "type": "string"
          },
          "size": {
            "type": "number"
          },
          "creationdate": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "storage_type",
          "path",
          "url"
        ]
      },
      "ProjectFileCreateFolderRequestDto": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "folderName": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "folderName"
        ]
      },
      "ProjectFileRenameRequestDto": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "file_project_id": {
            "type": "string"
          },
          "oldName": {
            "type": "string"
          },
          "newName": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "newName"
        ]
      },
      "ProjectFileMoveEntryDto": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "file_project_id": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ]
      },
      "ProjectFileMoveRequestDto": {
        "type": "object",
        "properties": {
          "destinationPath": {
            "type": "string"
          },
          "entries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectFileMoveEntryDto"
            }
          }
        },
        "required": [
          "destinationPath",
          "entries"
        ]
      },
      "ProjectFileExistItemDto": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "fileName": {
            "type": "string"
          },
          "hash": {
            "type": "string"
          }
        },
        "required": [
          "fileName",
          "hash"
        ]
      },
      "ProjectFileExistRequestDto": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectFileExistItemDto"
            }
          },
          "session_id": {
            "type": "string"
          },
          "session_timestamp": {
            "type": "number"
          }
        },
        "required": [
          "items"
        ]
      },
      "ProjectFileExistItemResultDto": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "fileName": {
            "type": "string"
          },
          "hash": {
            "type": "string"
          },
          "exists": {
            "type": "boolean"
          }
        },
        "required": [
          "fileName",
          "exists"
        ]
      },
      "ProjectFileExistResponseDto": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectFileExistItemResultDto"
            }
          }
        },
        "required": [
          "items"
        ]
      },
      "ProjectAccountDto": {
        "type": "object",
        "properties": {
          "comment": {
            "type": "string"
          }
        },
        "required": [
          "comment"
        ]
      },
      "ProjectAssignRoleDto": {
        "type": "object",
        "properties": {
          "valid_startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "valid_enddate": {
            "type": "string",
            "description": "end date (ISO 8601)",
            "example": "2022-09-12T12:00.000Z"
          },
          "account_id": {
            "type": "string",
            "description": "account id,",
            "example": "2344"
          },
          "roles": {
            "description": "list of roles that should be assigned to the selected account. Strings must match role labels.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "overwrite": {
            "description": "defines the attributes that are used for overwrite",
            "example": [
              "role",
              "valid_startdate"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "account_id",
          "overwrite"
        ]
      },
      "ProjectRoleResultDto": {
        "type": "object",
        "properties": {
          "valid_startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "valid_enddate": {
            "type": "string",
            "description": "end date (ISO 8601)",
            "example": "2022-09-12T12:00.000Z"
          },
          "account_id": {
            "type": "string",
            "description": "account id,",
            "example": "2344"
          },
          "roles": {
            "description": "list of roles that should be assigned to the selected account. Strings must match role labels.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "overwrite": {
            "description": "defines the attributes that are used for overwrite",
            "example": [
              "role",
              "valid_startdate"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "account_id",
          "overwrite",
          "id"
        ]
      },
      "TaskListInputOutputDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "creator_type": {
            "type": "string",
            "enum": [
              "user",
              "app"
            ]
          },
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "filename": {
            "type": "string"
          },
          "directory": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "description": "URL is set if the files content is not retrieved from database."
          },
          "fileType": {
            "type": "string"
          },
          "file_project_id": {
            "type": "string"
          },
          "uploader_username": {
            "type": "string"
          }
        }
      },
      "ToolMinimalDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "name": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "version",
          "active"
        ]
      },
      "ToolConfigurationMinimalDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "uniqueItems": true
          },
          "id": {
            "type": "string"
          },
          "tool": {
            "$ref": "#/components/schemas/ToolMinimalDto"
          },
          "task_type": {
            "$ref": "#/components/schemas/SupportedTaskTypeDto"
          },
          "assets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ToolConfigurationAssetDto"
            }
          }
        },
        "required": [
          "name",
          "id",
          "task_type"
        ]
      },
      "TaskListItemDto": {
        "type": "object",
        "properties": {
          "creationdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "updatedate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "startdate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "enddate": {
            "type": "string",
            "description": "date string (Zulu, ISO 8601)",
            "example": "2022-09-21T12:00.000Z"
          },
          "inputs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaskListInputOutputDto"
            }
          },
          "outputs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaskListInputOutputDto"
            }
          },
          "tool_configuration": {
            "$ref": "#/components/schemas/ToolConfigurationMinimalDto"
          },
          "id": {
            "type": "string",
            "description": "Primary, unique identifier for this entry",
            "example": "12345"
          },
          "pid": {
            "type": "string"
          },
          "orgtext": {
            "type": "string"
          },
          "assessment": {
            "type": "string"
          },
          "priority": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "DRAFT",
              "FREE",
              "PAUSED",
              "BUSY",
              "FINISHED",
              "FAILED",
              "POSTPONED"
            ]
          },
          "code": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          },
          "log": {
            "type": "object"
          },
          "comment": {
            "type": "string"
          },
          "admin_comment": {
            "type": "string"
          },
          "progress": {
            "type": "number"
          },
          "worker_id": {
            "type": "string"
          },
          "worker_username": {
            "type": "string"
          },
          "worker_type": {
            "type": "object"
          },
          "previoustask_id": {
            "type": "string"
          },
          "nexttask_id": {
            "type": "string"
          },
          "use_outputs_from_task_id": {
            "type": "string"
          },
          "use_outputs_from_task": {
            "$ref": "#/components/schemas/TaskDto"
          }
        },
        "required": [
          "inputs"
        ]
      },
      "ProjectListQueryParamsDto": {
        "type": "object",
        "properties": {
          "order": {
            "type": "object",
            "description": "direction for ordering entries"
          },
          "order_by": {
            "type": "string",
            "description": "direction for ordering entries"
          },
          "representation": {
            "description": "type of the representation",
            "enum": [
              "page",
              "interval"
            ],
            "type": "string"
          },
          "label": {
            "type": "string",
            "description": "label of the current page"
          },
          "start": {
            "type": "number",
            "description": "start of the interval"
          },
          "length": {
            "type": "number",
            "description": "end of the interval"
          },
          "manageable": {
            "type": "boolean"
          }
        }
      },
      "StandardPageQueryParamsDto": {
        "type": "object",
        "properties": {
          "order": {
            "type": "object",
            "description": "direction for ordering entries"
          },
          "order_by": {
            "type": "string",
            "description": "direction for ordering entries"
          },
          "representation": {
            "description": "type of the representation",
            "enum": [
              "page",
              "interval"
            ],
            "type": "string"
          },
          "label": {
            "type": "string",
            "description": "label of the current page"
          },
          "start": {
            "type": "number",
            "description": "start of the interval"
          },
          "length": {
            "type": "number",
            "description": "end of the interval"
          }
        }
      }
    }
  }
}