openapi: 3.1.2
info:
  description: "You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current\ndevelopment version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3).\n\n## Introduction\n\nThe documentation for the APIv3 is written according to the [OpenAPI 3.1 Specification](https://swagger.io/specification/).\nYou can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/)\nor the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md),\nin your OpenProject installation under `/api/docs`.\nIn the latter you can try out the various API endpoints directly interacting with our OpenProject data.\nMoreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml`\n(e.g. [here](https://community.openproject.org/api/v3/spec.yml)).\n\nThe APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS).\nThis means that each endpoint of this API will have links to other resources or actions defined in the resulting body.\n\nThese related resources and actions for any given resource will be context sensitive. For example, only actions that the\nauthenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any\ngiven response.\n\nAs an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only\nbe present when the user you authenticated has been granted a permission to update the work package in the assigned project.\n\n## HAL+JSON\n\nHAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.\nRead more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08)\n\n**OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties:\n\n- `_type` - specifies the type of the resource (e.g.: WorkPackage, Project)\n- `_links` - contains all related resource and action links available for the resource\n- `_embedded` - contains all embedded objects\n\nHAL does not guarantee that embedded resources are embedded in their full representation, they might as well be\npartially represented (e.g. some properties can be left out).\nHowever in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**.\n\n## API response structure\n\nAll API responses contain a single HAL+JSON object, even collections of objects are technically represented by\na single HAL+JSON object that itself contains its members. More details on collections can be found\nin the [Collections Section](https://www.openproject.org/docs/api/collections/).\n\n## Authentication\n\nThe API supports the following authentication schemes:\n\n* Session-based authentication\n* API tokens\n    * passed as Bearer token\n    * passed via Basic auth\n* OAuth 2.0\n    * using built-in authorization server\n    * using an external authorization server (RFC 9068)\n\nDepending on the settings of the OpenProject instance many resources can be accessed without being authenticated.\nIn case the instance requires authentication on all requests the client will receive an **HTTP 401** status code\nin response to any request.\n\nOtherwise unauthenticated clients have all the permissions of the anonymous user.\n\n### Session-based authentication\n\nThis means you have to login to OpenProject via the Web-Interface to be authenticated in the API.\nThis method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.\n\nIn this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication.\n\n### API token as bearer token\n\nUsers can authenticate towards the API v3 using an API token as a bearer token.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -H \"Authorization: Bearer $API_KEY\" https://community.openproject.org/api/v3/users/42\n```\n\nUsers can generate API tokens on their account page.\n\n### API token through Basic Auth\n\nAPI tokens can also be used with basic auth, using the user name `apikey` (NOT your login) and the API token as the password.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42\n```\n\n### OAuth 2.0 authentication\n\nOpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes.\n\nTo get started, you first need to register an application in the OpenProject OAuth administration section of your installation.\nThis will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`).\n\nYou can then use one the following guides to perform the supported OAuth 2.0 flows:\n\n- [Authorization code flow](https://oauth.net/2/grant-types/authorization-code)\n\n- [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential\n\n- [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access\n\n### OAuth 2.0 using an external authorization server\n\nThere is a possibility to use JSON Web Tokens (JWT) generated by an OIDC provider configured in OpenProject as a bearer token to do authenticated requests against the API.\nThe following requirements must be met:\n\n- OIDC provider must be configured in OpenProject with **jwks_uri**\n- JWT must be signed using RSA algorithm\n- JWT **iss** claim must be equal to OIDC provider **issuer**\n- JWT **aud** claim must contain the OpenProject **client ID** used at the OIDC provider\n- JWT **scope** claim must include a valid scope to access the desired API (e.g. `api_v3` for APIv3)\n- JWT must be actual (neither expired or too early to be used)\n- JWT must be passed in Authorization header like: `Authorization: Bearer {jwt}`\n- User from **sub** claim must be linked to OpenProject before (e.g. by logging in), otherwise it will be not authenticated\n\nIn more general terms, OpenProject should be compliant to [RFC 9068](https://www.rfc-editor.org/rfc/rfc9068) when validating access tokens.\n\n### Why not username and password?\n\nThe simplest way to do basic auth would be to use a user's username and password naturally.\nHowever, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.\n\nUsing **username and password** directly would have some advantages:\n\n* It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.\n\n* No extra logic for token management necessary.\n\nOn the other hand using **API keys** has some advantages too, which is why we went for that:\n\n* If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.\n\n* They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.\n\nMost importantly users may not actually have a password to begin with. Specifically when they have registered\nthrough an OpenID Connect provider.\n\n## Cross-Origin Resource Sharing (CORS)\n\nBy default, the OpenProject API is _not_ responding with any CORS headers.\nIf you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.\n\nPlease see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on\nhow to selectively enable CORS.\n\n## Allowed HTTP methods\n\n- `GET` - Get a single resource or collection of resources\n\n- `POST` - Create a new resource or perform\n\n- `PATCH` - Update a resource\n\n- `DELETE` - Delete a resource\n\n## Compression\n\nResponses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951)\nare supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).\nIf no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed."
  title: OpenProject API V3 (Stable) Actions & Capabilities Queries API
  version: '3'
servers:
- url: https://qa.openproject-edge.com
  description: Edge QA instance
- url: https://qa.openproject-stage.com
  description: Staging instance
- url: https://community.openproject.org
  description: Community instance
security:
- BasicAuth: []
tags:
- description: "A query defines how work packages can be filtered and displayed.\nClients can define a query once, store it, and use it later on to load the same set of filters and display options.\n\n## Actions\n\n| Link                | Description                                                          | Condition                                                                                                                        |\n|:-------------------:|----------------------------------------------------------------------| ---------------------------------------                                                                                          |\n| star                | Elevates the query to the status of 'starred'                        | **Permission**: save queries for own queries, manage public queries for public queries; Only present if query is not yet starred |\n| unstar              | Removes the 'starred' status                                         | **Permission**: save queries for own queries, manage public queries for public queries; Only present if query is starred         |\n| update              | Use the Form based process to verify the query before persisting     | **Permission**: view work packages                                                                                               |\n| updateImmediately   | Persist the query without using a Form based process for guidance    | **Permission**: save queries for own queries, manage public queries for public queries;                                          |\n\n## Linked Properties\n\n| Property               | Description                                                                                                                                    | Type                  | Constraints                                 | Supported operations |\n| :--------------------: | ------------------------------------------------------                                                                                         | --------------------- | ------------------------------------------- | -------------------- |\n| self                   | This query                                                                                                                                     | Query                 | not null                                    | READ                 |\n| user                   | The user that owns this query                                                                                                                  | User                  | not null                                    | READ                 |\n| project                | The project on which this query operates                                                                                                       | Project               |                                             | READ                 |\n| columns                | Ordered list of QueryColumns. The columns, when mapped to WorkPackage properties determine which WorkPackage properties to display             | []QueryColumn         |                                             | READ                 |\n| highlightedAttributes  | **Only with valid Enterprise Token available:** List of QueryColumns that should get highlighted when `highlightingMode` is set to `inline`.   | []QueryColumn         |                                             | READ                 |\n| sortBy                 | Ordered list of QuerySortBys. Indicates the WorkPackage property the results will be ordered by as well as the direction                       | []QuerySortBy         |                                             | READ                 |\n| groupBy                | The WorkPackage property results of this query are grouped by                                                                                  | String                |                                             | READ                 |\n| results                | The list of work packages returned by applying the filters, sorting and grouping defined in the query                                          | WorkPackageCollection |                                             | READ                 |\n| schema                 | This query's schema                                                                                                                            | Schema                |                                             | READ                 |\n\nPlease note, that all the properties listed above will also be embedded when individual queries are returned but will not be embedded when a list of queries is returned. Whether the properties are embedded or not may be subject to change in the future.\n\nThe `columns` and `highlightedAttributes` properties will be moved into `Views::WorkPackagesTable` so it is deprecated to have it listed within the Query directly.\n\n## Local Properties\n\n| Property         | Description                                                                                              | Type                  | Constraints                                                                         | Supported operations |\n| :--------------: | -------------------------------------------------------------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------- | -------------------- |\n| id               | Query id                                                                                                 | Integer               | x > 0                                                                               | READ                 |\n| name             | Query name                                                                                               | String                |                                                                                     | READ/WRITE           |\n| filters          | A set of QueryFilters which will be applied to the work packages to determine the resulting work packages| []QueryFilterInstance |                                                                                     | READ/WRITE           |\n| sums             | Should sums (of supported properties) be shown?                                                          | Boolean               |                                                                                     | READ/WRITE           |\n| timelineVisible  | Should the timeline mode be shown?                                                                       | Boolean               |                                                                                     | READ/WRITE           |\n| timelineLabels   | Which labels are shown in the timeline, empty when default                                               | QueryTimelineLabels   |                                                                                     | READ/WRITE           |\n| timelineZoomLevel| Which zoom level should the timeline be rendered in?                                                     | String                | days, weeks, months, quarters, years                                                | READ/WRITE           |\n| timestamps       | The timestamps to filter by when showing changed attributes on work packages.| []Timestamp               |                       | **Values older than 1 day are accepted only with valid Enterprise Token available.**| READ/WRITE           |\n| highlightingMode | Which highlighting mode should the table have?                                                           | String                | none, inline, status, priority, type                                                | READ/WRITE           |\n| showHierarchies  | Should the hierarchy mode be enabled?                                                                    | Boolean               |                                                                                     | READ/WRITE           |\n| hidden           | Should the query be hidden from the query list?                                                          | Boolean               |                                                                                     | READ/WRITE           |\n| public           | Can users besides the owner see the query?                                                               | Boolean               |                                                                                     | READ/WRITE           |\n| starred          | Should the query be highlighted to the user?                                                             | Boolean               |                                                                                     | READ                 |\n| createdAt        | Time of creation                                                                                         | DateTime              | not null                                                                            | READ                 |\n| updatedAt        | Time of the most recent change to the query                                                              | DateTime              | not null                                                                            | READ                 |\n\nA query that is not assigned to a project (`\"project\": null`) is called a global query. Global queries filter work packages regardless of the project they are assigned to. As such, a different set of filters exists for those queries.\n\nThe `hidden` property is deprecated as it is replaced by the `Views` concept. A query that isn't hidden will have a `View` while a query that is hidden won't.\n\nThe `timelineVisible`, `timelineLabels`, `timelineZoomLevel`, `highlightingMode` and `showHierarchies` properties will be moved into the more appropriate Views (probably `Views::WorkPackagesTable`) so it is deprecated to have them within the Query directly.\n\n## Query Filter Instance\n\nA QueryFilterInstance defines a filtering applied to the list of work packages. As such it contains:\n\n* the filter type (`QueryFilter`) used\n\n* the operator (`QueryOperator`) used\n\n* the list of values\n\nThe list of values can either consist of a list of links or of a list of strings. If the values are primitive (e.g. Integer, Boolean, Date) they will be displayed as strings and the QueryFilterInstance will have a `values` property.\n\n```json\n  {\n    \"_type\": \"DueDateQueryFilter\",\n    \"name\": \"Finish date\",\n    \"values\": [\n      \"1\"\n    ],\n    \"_links\": {\n      \"filter\": {\n        \"href\": \"/api/v3/queries/filters/dueDate\",\n        \"title\": \"Finish date\"\n      },\n      \"operator\": {\n        \"href\": \"/api/v3/queries/operators/<t+\",\n        \"title\": \"in less than\"\n      }\n      \"schema\": {\n        \"href\": \"/api/v3/queries/filter_instance_schemas/dueDate\"\n      }\n    }\n  }\n```\n\nIf the values are nonprimitive (e.g. User, Project), they will be listed as objects and the QueryFilterInstance will have a `values` link.\n\n```json\n  {\n    \"_type\": \"AssigneeQueryFilter\",\n    \"name\": \"Assignee\",\n    \"_links\": {\n      \"filter\": {\n        \"href\": \"/api/v3/queries/filters/assignee\",\n        \"title\": \"Assignee\"\n      },\n      \"operator\": {\n        \"href\": \"/api/v3/queries/operators/=\",\n        \"title\": \"is\"\n      },\n      \"schema\": {\n        \"href\": \"/api/v3/queries/filter_instance_schemas/assignee\"\n      },\n      \"values\": [\n        {\n          \"href\": \"/api/v3/users/1\",\n          \"title\": \"OpenProject Admin\"\n        }\n      ]\n    }\n  }\n\n```\n"
  name: Queries
paths:
  /api/v3/projects/{id}/queries/default:
    get:
      summary: View default query for project
      operationId: View_default_query_for_project
      tags:
      - Queries
      description: 'Same as [viewing an existing, persisted Query](https://www.openproject.org/docs/api/endpoints/queries/#list-queries)

        in its response, this resource returns an unpersisted query and by that allows

        to get the default query configuration. The client may also provide additional

        parameters which will modify the default query. The query will already be scoped

        to the project.


        This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/queries/default`](https://www.openproject.org/docs/api/endpoints/queries/#view-default-query-for-workspace)'
      parameters:
      - description: Id of the project the default query is requested for
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      - name: filters
        description: 'JSON specifying filter conditions.

          The filters provided as parameters are not applied to the query but are instead used to override the query''s persisted filters.

          All filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`).'
        example: '[{ "assignee": { "operator": "=", "values": ["1", "5"] }" }]'
        in: query
        required: false
        schema:
          default: '[{ "status_id": { "operator": "o", "values": null }}]'
          type: string
      - name: offset
        description: Page number inside the queries' result collection of work packages.
        example: 25
        in: query
        required: false
        schema:
          default: 1
          type: integer
      - name: pageSize
        description: Number of elements to display per page for the queries' result collection of work packages.
        example: 25
        in: query
        required: false
        schema:
          type: integer
      - name: sortBy
        description: JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria.
        example: '[["status", "asc"]]'
        in: query
        required: false
        schema:
          default: '[["id", "asc"]]'
          type: string
      - name: groupBy
        description: The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria.
        example: status
        in: query
        required: false
        schema:
          type: string
      - name: showSums
        description: Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: timestamps
        description: 'Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: "oneDayAgo@HH:MM+HH:MM", "lastWorkingDay@HH:MM+HH:MM", "oneWeekAgo@HH:MM+HH:MM", "oneMonthAgo@HH:MM+HH:MM". The first "HH:MM" part represents the zero paded hours and minutes. The last "+HH:MM" part represents the timezone offset from UTC associated with the time. Values older than 1 day are accepted only with valid Enterprise Token available.

          '
        example: 2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00
        in: query
        required: false
        schema:
          default: PT0S
          type: string
      - name: timelineVisible
        description: Indicates whether the timeline should be shown.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: showHierarchies
        description: Indicates whether the hierarchy mode should be enabled.
        example: true
        in: query
        required: false
        schema:
          default: true
          type: boolean
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      results:
                        _embedded:
                          elements:
                          - <--- shortened for brevity --->
                        _links:
                          changeSize:
                            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          createWorkPackage:
                            href: /api/v3/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/work_packages
                            method: post
                          jumpTo:
                            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          self:
                            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                        _type: WorkPackageCollection
                        count: 30
                        offset: 1
                        pageSize: 2
                        total: 234
                    _links:
                      columns:
                      - href: /api/v3/queries/columns/id
                        title: ID
                      - href: /api/v3/queries/columns/subject
                        title: Subject
                      - href: /api/v3/queries/columns/type
                        title: Type
                      - href: /api/v3/queries/columns/status
                        title: Status
                      - href: /api/v3/queries/columns/priority
                        title: Priority
                      - href: /api/v3/queries/columns/assignee
                        title: Assignee
                      - href: /api/v3/queries/columns/updated_at
                        title: Updated on
                      groupBy:
                        href: null
                        title: null
                      project:
                        href: /api/v3/projects/42
                        title: Lorem ipsum project
                      results:
                        href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                      self:
                        href: /api/v3/workspaces/42/queries/default
                        title: Default
                      sortBy:
                      - href: /api/v3/queries/sort_bys/parent-desc
                        title: Parent (Descending)
                      user:
                        href: /api/v3/users/1
                        title: OpenProject Admin
                    _type: Query
                    filters:
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/status
                          title: Status
                        operator:
                          href: /api/v3/queries/operators/o
                          title: open
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/status
                        values: []
                      _type: StatusQueryFilter
                      name: Status
                    name: default
                    public: false
                    showHierarchies: true
                    starred: false
                    sums: false
                    timelineVisible: false
                    timelineZoomLevel: days
              schema:
                $ref: '#/components/schemas/Default_Query_for_WorkspaceModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see the default query.


            **Required permission:** view work packages in the project'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The requested resource could not be found.
          description: 'Returned if the client does not have sufficient permissions to see the project.


            **Required permission:** any permission in the project'
          headers: {}
  /api/v3/projects/{id}/queries/schema:
    get:
      parameters:
      - description: Project id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                QuerySchema:
                  $ref: '#/components/examples/QuerySchemaModel'
              schema:
                $ref: '#/components/schemas/Schema_For_Workspace_QueriesModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: '**Required permission:** view work package in the project'
          headers: {}
      tags:
      - Queries
      description: 'Retrieve the schema for project queries.


        This endpoint is deprecated and replaced by [''/api/v3/workspaces/{id}/queries/schema`](https://www.openproject.org/docs/api/endpoints/queries/#view-schema-for-workspace-queries)'
      operationId: View_schema_for_project_queries
      summary: View schema for project queries
  /api/v3/queries:
    get:
      summary: List queries
      operationId: List_queries
      tags:
      - Queries
      description: Returns a collection of queries. The collection can be filtered via query parameters similar to how work packages are filtered. Please note however, that the filters are applied to the queries and not to the work packages the queries in turn might return.
      parameters:
      - description: 'JSON specifying filter conditions.

          Currently supported filters are:


          + project: filters queries by the project they are assigned to. If the project filter is passed with the `!*` (not any) operator, global queries are returned.


          + id: filters queries based on their id


          + updated_at: filters queries based on the last time they where updated'
        example: '[{ "project_id": { "operator": "!*", "values": null }" }]'
        in: query
        name: filters
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                Queries:
                  $ref: '#/components/examples/QueriesModel'
              schema:
                $ref: '#/components/schemas/QueriesModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not allowed to see the queries.
          description: 'Returned if the client does not have sufficient permissions to see queries.


            **Required permission:** view work packages or manage public queries in any project'
          headers: {}
    post:
      summary: Create query
      operationId: Create_query
      tags:
      - Queries
      description: 'When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.

        The required fields of a Query can be found in its schema, which is embedded in the respective form.

        Note that it is only allowed to provide properties or links supporting the write operation.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Query_Create_Form'
      responses:
        '201':
          content:
            application/hal+json:
              examples:
                Query:
                  $ref: '#/components/examples/QueryModel'
              schema:
                $ref: '#/components/schemas/QueryModel'
          description: Created
          headers: {}
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _embedded:
                      details:
                        attribute: project
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                    message: Project not found
          description: "Returned if:\n\n* the client tries to modify a read-only property (`PropertyIsReadOnly`)\n\n* a constraint for a property was violated (`PropertyConstraintViolation`)\n\n* the client provides a link to an invalid resource (`ResourceTypeMismatch`),\n  e.g. a user, project or operator not found"
          headers: {}
  /api/v3/queries/available_projects:
    get:
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      elements:
                      - _links:
                          categories:
                            href: /api/v3/projects/6/categories
                          createWorkPackage:
                            href: /api/v3/projects/6/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/projects/6/work_packages
                            method: post
                          self:
                            href: /api/v3/projects/6
                            title: A project
                          versions:
                            href: /api/v3/projects/6/versions
                        _type: Project
                        createdAt: '2015-07-06T13:28:14+00:00'
                        description: Eveniet molestias omnis quis aut qui eum adipisci.
                        id: 6
                        identifier: a_project
                        name: A project
                        type: Customer Project
                        updatedAt: '2015-10-01T09:55:02+00:00'
                      - _links:
                          categories:
                            href: /api/v3/projects/14/categories
                          createWorkPackage:
                            href: /api/v3/projects/14/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/projects/14/work_packages
                            method: post
                          self:
                            href: /api/v3/projects/14
                            title: Another project
                          versions:
                            href: /api/v3/projects/14/versions
                        _type: Project
                        createdAt: '2016-02-29T12:50:20+00:00'
                        description: ''
                        id: 14
                        identifier: another_project
                        name: Another project
                        type: null
                        updatedAt: '2016-02-29T12:50:20+00:00'
                    _links:
                      self:
                        href: /api/v3/queries/available_projects
                    _type: Collection
                    count: 2
                    total: 2
              schema:
                $ref: '#/components/schemas/Available_projects_for_queryModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** view work packages'
          headers: {}
      tags:
      - Queries
      description: Gets a list of projects that are available as projects a query can be assigned to.
      operationId: Available_projects_for_query
      summary: Available projects for query
  /api/v3/queries/default:
    get:
      summary: View default query
      operationId: View_default_query
      tags:
      - Queries
      description: Same as [viewing an existing, persisted Query](https://www.openproject.org/docs/api/endpoints/queries/#list-queries) in its response, this resource returns an unpersisted query and by that allows to get the default query configuration. The client may also provide additional parameters which will modify the default query.
      parameters:
      - name: filters
        description: 'JSON specifying filter conditions.

          The filters provided as parameters are not applied to the query but are instead used to override the query''s persisted filters.

          All filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`).'
        example: '[{ "assignee": { "operator": "=", "values": ["1", "5"] }" }]'
        in: query
        required: false
        schema:
          default: '[{ "status_id": { "operator": "o", "values": null }}]'
          type: string
      - name: offset
        description: Page number inside the queries' result collection of work packages.
        example: 25
        in: query
        required: false
        schema:
          default: 1
          type: integer
      - name: pageSize
        description: Number of elements to display per page for the queries' result collection of work packages.
        example: 25
        in: query
        required: false
        schema:
          type: integer
      - name: sortBy
        description: JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria.
        example: '[["status", "asc"]]'
        in: query
        required: false
        schema:
          default: '[["id", "asc"]]'
          type: string
      - name: groupBy
        description: The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria.
        example: status
        in: query
        required: false
        schema:
          type: string
      - name: showSums
        description: Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: timestamps
        description: 'Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: "oneDayAgo@HH:MM+HH:MM", "lastWorkingDay@HH:MM+HH:MM", "oneWeekAgo@HH:MM+HH:MM", "oneMonthAgo@HH:MM+HH:MM". The first "HH:MM" part represents the zero paded hours and minutes. The last "+HH:MM" part represents the timezone offset from UTC associated with the time, the offset can be positive or negative e.g."oneDayAgo@01:00+01:00", "oneDayAgo@01:00-01:00". Values older than 1 day are accepted only with valid Enterprise Token available.

          '
        example: 2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00
        in: query
        required: false
        schema:
          default: PT0S
          type: string
      - name: timelineVisible
        description: Indicates whether the timeline should be shown.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: timelineZoomLevel
        description: Indicates in what zoom level the timeline should be shown. Valid values are  `days`, `weeks`, `months`, `quarters`, and `years`.
        example: days
        in: query
        required: false
        schema:
          default: days
          type: string
      - name: showHierarchies
        description: Indicates whether the hierarchy mode should be enabled.
        example: true
        in: query
        required: false
        schema:
          default: true
          type: boolean
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      results:
                        _embedded:
                          elements:
                          - <--- shortened for brevity --->
                        _links:
                          changeSize:
                            href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          createWorkPackage:
                            href: /api/v3/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/work_packages
                            method: post
                          jumpTo:
                            href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          self:
                            href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                        _type: WorkPackageCollection
                        count: 30
                        offset: 1
                        pageSize: 2
                        total: 234
                    _links:
                      columns:
                      - href: /api/v3/queries/columns/id
                        title: ID
                      - href: /api/v3/queries/columns/subject
                        title: Subject
                      - href: /api/v3/queries/columns/type
                        title: Type
                      - href: /api/v3/queries/columns/status
                        title: Status
                      - href: /api/v3/queries/columns/priority
                        title: Priority
                      - href: /api/v3/queries/columns/assignee
                        title: Assignee
                      - href: /api/v3/queries/columns/updated_at
                        title: Updated on
                      groupBy:
                        href: null
                        title: null
                      highlightedAttributes: []
                      project:
                        href: null
                      results:
                        href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                      self:
                        href: /api/v3/queries/default
                        title: Default
                      sortBy:
                      - href: /api/v3/queries/sort_bys/parent-desc
                        title: Parent (Descending)
                      user:
                        href: /api/v3/users/1
                        title: OpenProject Admin
                    _type: Query
                    filters:
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/status
                          title: Status
                        operator:
                          href: /api/v3/queries/operators/o
                          title: open
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/status
                        values: []
                      _type: StatusQueryFilter
                      name: Status
                    highlightingMode: inline
                    name: default
                    public: false
                    showHierarchies: true
                    starred: false
                    sums: false
                    timelineLabels: {}
                    timelineVisible: false
                    timelineZoomLevel: days
              schema:
                $ref: '#/components/schemas/Default_QueryModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see the default query.


            **Required permission:** view work packages in any project'
          headers: {}
  /api/v3/queries/form:
    post:
      summary: Query Create Form
      operationId: Query_Create_Form
      tags:
      - Queries
      description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Query_Create_Form'
      responses:
        '200':
          description: OK
          headers: {}
  /api/v3/queries/schema:
    get:
      summary: View schema for global queries
      operationId: View_schema_for_global_queries
      tags:
      - Queries
      description: Retrieve the schema for global queries, those, that are not assigned to a project.
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                QuerySchema:
                  $ref: '#/components/examples/QuerySchemaModel'
              schema:
                $ref: '#/components/schemas/Schema_For_Global_QueriesModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: '**Required permission:** view work package in any project'
          headers: {}
  /api/v3/queries/{id}:
    delete:
      summary: Delete query
      operationId: Delete_query
      tags:
      - Queries
      description: Delete the query identified by the id parameter
      parameters:
      - description: Query id
        example: '1'
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: No Content
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** for own queries none; for public queries: manage public queries


            *Note that you will only receive this error, if you are at least allowed to see the corresponding query.*'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The requested resource could not be found.
          description: 'Returned if the query does not exist or the client does not have sufficient permissions to see it.


            **Required condition:** query belongs to user or query is public


            **Required permission:** view work package in queries project'
          headers: {}
    get:
      summary: View query
      operationId: View_query
      tags:
      - Queries
      description: Retrieve an individual query as identified by the id parameter. Then endpoint accepts a number of parameters that can be used to override the resources' persisted parameters.
      parameters:
      - name: id
        description: Query id
        example: '1'
        in: path
        required: true
        schema:
          type: integer
      - name: filters
        description: 'JSON specifying filter conditions.

          The filters provided as parameters are not applied to the query but are instead used to override the query''s persisted filters.

          All filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`).'
        example: '[{ "assignee": { "operator": "=", "values": ["1", "5"] }" }]'
        in: query
        required: false
        schema:
          default: '[{ "status_id": { "operator": "o", "values": null }}]'
          type: string
      - name: offset
        description: Page number inside the queries' result collection of work packages.
        example: '25'
        in: query
        required: false
        schema:
          default: 1
          type: integer
      - name: pageSize
        description: Number of elements to display per page for the queries' result collection of work packages.
        example: '25'
        in: query
        required: false
        schema:
          type: integer
      - name: columns
        description: Selected columns for the table view.
        example: '[]'
        in: query
        required: false
        schema:
          default: '[''type'', ''priority'']'
          type: string
      - name: sortBy
        description: JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria.
        example: '[["status", "asc"]]'
        in: query
        required: false
        schema:
          default: '[["id", "asc"]]'
          type: string
      - name: groupBy
        description: The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria.
        example: status
        in: query
        required: false
        schema:
          type: string
      - name: showSums
        description: Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: timestamps
        description: 'Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: "oneDayAgo@HH:MM+HH:MM", "lastWorkingDay@HH:MM+HH:MM", "oneWeekAgo@HH:MM+HH:MM", "oneMonthAgo@HH:MM+HH:MM". The first "HH:MM" part represents the zero paded hours and minutes. The last "+HH:MM" part represents the timezone offset from UTC associated with the time, the offset can be positive or negative e.g."oneDayAgo@01:00+01:00", "oneDayAgo@01:00-01:00". Values older than 1 day are accepted only with valid Enterprise Token available.

          '
        example: 2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00
        in: query
        required: false
        schema:
          default: PT0S
          type: string
      - name: timelineVisible
        description: Indicates whether the timeline should be shown.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: timelineLabels
        description: Overridden labels in the timeline view
        example: '{}'
        in: query
        required: false
        schema:
          default: '{}'
          type: string
      - name: highlightingMode
        description: Highlighting mode for the table view.
        example: inline
        in: query
        required: false
        schema:
          default: inline
          type: string
      - name: highlightedAttributes
        description: Highlighted attributes mode for the table view when `highlightingMode` is `inline`. When set to `[]` all highlightable attributes will be returned as `highlightedAttributes`.
        example: '[]'
        in: query
        required: false
        schema:
          default: '[''type'', ''priority'']'
          type: string
      - name: showHierarchies
        description: Indicates whether the hierarchy mode should be enabled.
        example: true
        in: query
        required: false
        schema:
          default: true
          type: boolean
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                Query:
                  $ref: '#/components/examples/QueryModel'
              schema:
                $ref: '#/components/schemas/QueryModel'
          description: OK
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The specified query does not exist.
          description: 'Returned if the query does not exist or the client does not have sufficient permissions to see it.


            **Required condition:** query belongs to user or query is public


            **Required permission:** view work package in queries project'
          headers: {}
    patch:
      summary: Edit Query
      operationId: Edit_Query
      tags:
      - Queries
      description: 'When calling this endpoint the client provides a single object, containing the properties and links that it wants to change, in the body.

        Note that it is only allowed to provide properties or links supporting the **write** operation.'
      parameters:
      - description: Query id
        example: '1'
        in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Query_Update_Form'
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      highlightedAttributes: []
                      results:
                        _embedded:
                          elements:
                          - <--- shortened for brevity --->
                        _links:
                          changeSize:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          createWorkPackage:
                            href: /api/v3/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/work_packages
                            method: post
                          jumpTo:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          self:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                        _type: WorkPackageCollection
                        count: 30
                        offset: 1
                        pageSize: 2
                        total: 234
                    _links:
                      columns:
                      - href: /api/v3/queries/columns/id
                        title: ID
                      - href: /api/v3/queries/columns/subject
                        title: Subject
                      - href: /api/v3/queries/columns/type
                        title: Type
                      - href: /api/v3/queries/columns/status
                        title: Status
                      - href: /api/v3/queries/columns/priority
                        title: Priority
                      - href: /api/v3/queries/columns/assignee
                        title: Assignee
                      - href: /api/v3/queries/columns/updated_at
                        title: Updated on
                      groupBy:
                        href: null
                        title: null
                      highlightedAttributes: []
                      project:
                        href: /api/v3/projects/3
                        title: copy
                      results:
                        href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                      self:
                        href: /api/v3/queries/9
                        title: fdsfdsfdsf
                      sortBy:
                      - href: /api/v3/queries/sort_bys/parent-desc
                        title: Parent (Descending)
                      user:
                        href: /api/v3/users/1
                        title: OpenProject Admin
                    _type: Query
                    createdAt: '2015-03-20T12:56:56.343Z'
                    filters:
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/status
                          title: Status
                        operator:
                          href: /api/v3/queries/operators/o
                          title: open
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/status
                        values: []
                      _type: StatusQueryFilter
                      name: Status
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/dueDate
                          title: Finish date
                        operator:
                          href: /api/v3/queries/operators/<t+
                          title: in less than
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/dueDate
                      _type: DueDateQueryFilter
                      name: Finish date
                      values:
                      - '1'
                    id: 9
                    name: fdsfdsfdsf
                    public: false
                    starred: false
                    sums: false
                    updatedAt: '2015-05-20T18:16:53.884Z'
              schema:
                $ref: '#/components/schemas/QueryModel'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not allowed to edit the content of the work package.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** edit work package'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The specified query does not exist.
          description: 'Returned if the query does not exist or the client does not have sufficient permissions to see it.


            **Required permission:** view work packages in the query''s project (unless global)'
          headers: {}
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _embedded:
                      details:
                        attribute: name
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                    message: The name might not be blank.
          description: 'Returned if:


            * the client tries to modify a read-only property (`PropertyIsReadOnly`)


            * a constraint for a property was violated (`PropertyConstraintViolation`)


            * the client provides a link to an invalid resource (`ResourceTypeMismatch`)'
          headers: {}
  /api/v3/queries/{id}/form:
    post:
      summary: Query Update Form
      operationId: Query_Update_Form
      tags:
      - Queries
      description: ''
      parameters:
      - description: Query id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Query_Update_Form'
      responses:
        '200':
          description: OK
          headers: {}
  /api/v3/queries/{id}/star:
    patch:
      parameters:
      - description: Query id
        example: '1'
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      results:
                        _embedded:
                          elements:
                          - <--- shortened for brevity --->
                        _links:
                          changeSize:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          createWorkPackage:
                            href: /api/v3/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/work_packages
                            method: post
                          jumpTo:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          self:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                        _type: WorkPackageCollection
                        count: 30
                        offset: 1
                        pageSize: 2
                        total: 234
                    _links:
                      columns:
                      - href: /api/v3/queries/columns/id
                        title: ID
                      - href: /api/v3/queries/columns/subject
                        title: Subject
                      - href: /api/v3/queries/columns/type
                        title: Type
                      - href: /api/v3/queries/columns/status
                        title: Status
                      - href: /api/v3/queries/columns/priority
                        title: Priority
                      - href: /api/v3/queries/columns/assignee
                        title: Assignee
                      - href: /api/v3/queries/columns/updated_at
                        title: Updated on
                      groupBy:
                        href: null
                        title: null
                      project:
                        href: /api/v3/projects/3
                        title: copy
                      results:
                        href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                      self:
                        href: /api/v3/queries/9
                        title: fdsfdsfdsf
                      sortBy:
                      - href: /api/v3/queries/sort_bys/parent-desc
                        title: Parent (Descending)
                      user:
                        href: /api/v3/users/1
                        title: OpenProject Admin
                    _type: Query
                    createdAt: '2015-03-20T12:56:56.856Z'
                    filters:
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/status
                          title: Status
                        operator:
                          href: /api/v3/queries/operators/o
                          title: open
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/status
                        values: []
                      _type: StatusQueryFilter
                      name: Status
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/dueDate
                          title: Finish date
                        operator:
                          href: /api/v3/queries/operators/<t+
                          title: in less than
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/dueDate
                      _type: DueDateQueryFilter
                      name: Finish date
                      values:
                      - '1'
                    id: 9
                    name: fdsfdsfdsf
                    public: false
                    starred: true
                    sums: false
                    updatedAt: '2015-05-20T18:16:53.089Z'
              schema:
                $ref: '#/components/schemas/Star_QueryModel'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not allowed to star this query.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** for own queries none; for public queries: manage public queries


            *Note that you will only receive this error, if you are at least allowed to see the corresponding query.*'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The specified query does not exist.
          description: 'Returned if the query does not exist or the client does not have sufficient permissions to see it.


            **Required condition:** query belongs to user or query is public


            **Required permission:** view work package in queries project'
          headers: {}
      tags:
      - Queries
      description: ''
      operationId: Star_query
      summary: Star query
  /api/v3/queries/{id}/unstar:
    patch:
      parameters:
      - description: Query id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      results:
                        _embedded:
                          elements:
                          - <--- shortened for brevity --->
                        _links:
                          changeSize:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          createWorkPackage:
                            href: /api/v3/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/work_packages
                            method: post
                          jumpTo:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          self:
                            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                        _type: WorkPackageCollection
                        count: 30
                        offset: 1
                        pageSize: 2
                        total: 234
                    _links:
                      columns:
                      - href: /api/v3/queries/columns/id
                        title: ID
                      - href: /api/v3/queries/columns/subject
                        title: Subject
                      - href: /api/v3/queries/columns/type
                        title: Type
                      - href: /api/v3/queries/columns/status
                        title: Status
                      - href: /api/v3/queries/columns/priority
                        title: Priority
                      - href: /api/v3/queries/columns/assignee
                        title: Assignee
                      - href: /api/v3/queries/columns/updated_at
                        title: Updated on
                      groupBy:
                        href: null
                        title: null
                      project:
                        href: /api/v3/projects/3
                        title: copy
                      results:
                        href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                      self:
                        href: /api/v3/queries/9
                        title: fdsfdsfdsf
                      sortBy:
                      - href: /api/v3/queries/sort_bys/parent-desc
                        title: Parent (Descending)
                      user:
                        href: /api/v3/users/1
                        title: OpenProject Admin
                    _type: Query
                    createdAt: '2015-03-20T12:56:56.468Z'
                    filters:
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/status
                          title: Status
                        operator:
                          href: /api/v3/queries/operators/o
                          title: open
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/status
                        values: []
                      _type: StatusQueryFilter
                      name: Status
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/dueDate
                          title: Finish date
                        operator:
                          href: /api/v3/queries/operators/<t+
                          title: in less than
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/dueDate
                      _type: DueDateQueryFilter
                      name: Finish date
                      values:
                      - '1'
                    id: 9
                    name: fdsfdsfdsf
                    public: false
                    starred: false
                    sums: false
                    updatedAt: '2015-05-20T18:16:53.386Z'
              schema:
                $ref: '#/components/schemas/Unstar_QueryModel'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not allowed to unstar this query.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** for own queries none; for public queries: manage public queries


            *Note that you will only receive this error, if you are at least allowed to see the corresponding query.*'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The specified query does not exist.
          description: 'Returned if the query does not exist or the client does not have sufficient permissions to see it.


            **Required condition:** query belongs to user or query is public


            **Required permission:** view work package in queries project'
          headers: {}
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
      tags:
      - Queries
      description: ''
      operationId: Unstar_query
      summary: Unstar query
  /api/v3/workspaces/{id}/queries/default:
    get:
      summary: View default query for workspace
      operationId: View_default_query_for_workspace
      tags:
      - Queries
      description: Same as [viewing an existing, persisted Query](https://www.openproject.org/docs/api/endpoints/queries/#list-queries) in its response, this resource returns an unpersisted query and by that allows to get the default query configuration. The client may also provide additional parameters which will modify the default query. The query will already be scoped to the workspace.
      parameters:
      - description: Id of the workspace the default query is requested for
        example: '1'
        in: path
        name: id
        required: true
        schema:
          type: integer
      - name: filters
        description: 'JSON specifying filter conditions.

          The filters provided as parameters are not applied to the query but are instead used to override the query''s persisted filters.

          All filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`).'
        example: '[{ "assignee": { "operator": "=", "values": ["1", "5"] }" }]'
        in: query
        required: false
        schema:
          default: '[{ "status_id": { "operator": "o", "values": null }}]'
          type: string
      - name: offset
        description: Page number inside the queries' result collection of work packages.
        example: '25'
        in: query
        required: false
        schema:
          default: 1
          type: integer
      - name: pageSize
        description: Number of elements to display per page for the queries' result collection of work packages.
        example: '25'
        in: query
        required: false
        schema:
          type: integer
      - name: sortBy
        description: JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria.
        example: '[["status", "asc"]]'
        in: query
        required: false
        schema:
          default: '[["id", "asc"]]'
          type: string
      - name: groupBy
        description: The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria.
        example: status
        in: query
        required: false
        schema:
          type: string
      - name: showSums
        description: Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: timestamps
        description: 'Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: "oneDayAgo@HH:MM+HH:MM", "lastWorkingDay@HH:MM+HH:MM", "oneWeekAgo@HH:MM+HH:MM", "oneMonthAgo@HH:MM+HH:MM". The first "HH:MM" part represents the zero paded hours and minutes. The last "+HH:MM" part represents the timezone offset from UTC associated with the time. Values older than 1 day are accepted only with valid Enterprise Token available.

          '
        example: 2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00
        in: query
        required: false
        schema:
          default: PT0S
          type: string
      - name: timelineVisible
        description: Indicates whether the timeline should be shown.
        example: true
        in: query
        required: false
        schema:
          default: false
          type: boolean
      - name: showHierarchies
        description: Indicates whether the hierarchy mode should be enabled.
        example: true
        in: query
        required: false
        schema:
          default: true
          type: boolean
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      results:
                        _embedded:
                          elements:
                          - <--- shortened for brevity --->
                        _links:
                          changeSize:
                            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          createWorkPackage:
                            href: /api/v3/work_packages/form
                            method: post
                          createWorkPackageImmediate:
                            href: /api/v3/work_packages
                            method: post
                          jumpTo:
                            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                            templated: true
                          self:
                            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                        _type: WorkPackageCollection
                        count: 30
                        offset: 1
                        pageSize: 2
                        total: 234
                    _links:
                      columns:
                      - href: /api/v3/queries/columns/id
                        title: ID
                      - href: /api/v3/queries/columns/subject
                        title: Subject
                      - href: /api/v3/queries/columns/type
                        title: Type
                      - href: /api/v3/queries/columns/status
                        title: Status
                      - href: /api/v3/queries/columns/priority
                        title: Priority
                      - href: /api/v3/queries/columns/assignee
                        title: Assignee
                      - href: /api/v3/queries/columns/updated_at
                        title: Updated on
                      groupBy:
                        href: null
                        title: null
                      project:
                        href: /api/v3/projects/42
                        title: Lorem ipsum project
                      results:
                        href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                      self:
                        href: /api/v3/workspaces/42/queries/default
                        title: Default
                      sortBy:
                      - href: /api/v3/queries/sort_bys/parent-desc
                        title: Parent (Descending)
                      user:
                        href: /api/v3/users/1
                        title: OpenProject Admin
                    _type: Query
                    filters:
                    - _links:
                        filter:
                          href: /api/v3/queries/filters/status
                          title: Status
                        operator:
                          href: /api/v3/queries/operators/o
                          title: open
                        schema:
                          href: /api/v3/queries/filter_instance_schemas/status
                        values: []
                      _type: StatusQueryFilter
                      name: Status
                    name: default
                    public: false
                    showHierarchies: true
                    starred: false
                    sums: false
                    timelineVisible: false
                    timelineZoomLevel: days
              schema:
                $ref: '#/components/schemas/Default_Query_for_WorkspaceModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see the default query.


            **Required permission:** view work packages in the workspace'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The requested resource could not be found.
          description: 'Returned if the client does not have sufficient permissions to see the workspace.


            **Required permission:** any permission in the workspace'
          headers: {}
  /api/v3/workspace/{id}/queries/schema:
    get:
      parameters:
      - description: Project id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                QuerySchema:
                  $ref: '#/components/examples/QuerySchemaModel'
              schema:
                $ref: '#/components/schemas/Schema_For_Workspace_QueriesModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not authorized to access this resource.
          description: '**Required permission:** view work package in the workspace'
          headers: {}
      tags:
      - Queries
      description: Retrieve the schema for workspace queries.
      operationId: View_schema_for_workspace_queries
      summary: View schema for workspace queries
components:
  schemas:
    Available_projects_for_queryModel:
      type: object
      example:
        _links:
          self:
            href: /api/v3/queries/available_projects
        _type: Collection
        total: 2
        count: 2
        _embedded:
          elements:
          - _type: Project
            _links:
              self:
                href: /api/v3/projects/6
                title: A project
              createWorkPackage:
                href: /api/v3/projects/6/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/projects/6/work_packages
                method: post
              categories:
                href: /api/v3/projects/6/categories
              versions:
                href: /api/v3/projects/6/versions
            id: 6
            identifier: a_project
            name: A project
            description: Eveniet molestias omnis quis aut qui eum adipisci.
            createdAt: '2015-07-06T13:28:14+00:00'
            updatedAt: '2015-10-01T09:55:02+00:00'
            type: Customer Project
          - _type: Project
            _links:
              self:
                href: /api/v3/projects/14
                title: Another project
              createWorkPackage:
                href: /api/v3/projects/14/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/projects/14/work_packages
                method: post
              categories:
                href: /api/v3/projects/14/categories
              versions:
                href: /api/v3/projects/14/versions
            id: 14
            identifier: another_project
            name: Another project
            description: ''
            createdAt: '2016-02-29T12:50:20+00:00'
            updatedAt: '2016-02-29T12:50:20+00:00'
            type: null
    Link:
      type: object
      required:
      - href
      properties:
        href:
          type:
          - string
          - 'null'
          description: URL to the referenced resource (might be relative)
        title:
          type: string
          description: Representative label for the resource
        templated:
          type: boolean
          default: false
          description: If true the href contains parts that need to be replaced by the client
        method:
          type: string
          default: GET
          description: The HTTP verb to use when requesting the resource
        payload:
          type: object
          description: The payload to send in the request to achieve the desired result
        identifier:
          type: string
          description: An optional unique identifier to the link object
        type:
          type: string
          description: The MIME-Type of the returned resource.
      example:
        href: /api/v3/work_packages
        method: POST
    Query_Filter_Instance_Model:
      type: object
      required:
      - _links
      - _type
      - name
      properties:
        _links:
          type: object
          required:
          - filter
          - schema
          properties:
            filter:
              $ref: '#/components/schemas/Link'
            schema:
              $ref: '#/components/schemas/Link'
            operator:
              $ref: '#/components/schemas/Link'
        _type:
          type: string
        name:
          type: string
    QueryModel:
      type: object
      required:
      - createdAt
      - updatedAt
      properties:
        id:
          type: integer
          description: Query id
          readOnly: true
          exclusiveMinimum: 0
        name:
          type: string
          description: Query name
          readOnly: true
        filters:
          type: array
          description: A set of QueryFilters which will be applied to the work packages to determine the resulting work packages
          readOnly: false
          items:
            $ref: '#/components/schemas/Query_Filter_Instance_Model'
        sums:
          type: boolean
          description: Should sums (of supported properties) be shown?
          readOnly: true
        timelineVisible:
          type: boolean
          description: Should the timeline mode be shown?
          readOnly: true
          deprecated: true
        timelineLabels:
          type: array
          description: Which labels are shown in the timeline, empty when default
          readOnly: true
          deprecated: true
          items:
            type: string
        timelineZoomLevel:
          type: string
          description: Which zoom level should the timeline be rendered in?
          readOnly: true
          deprecated: true
        timestamps:
          type: array
          description: Timestamps to filter by when showing changed attributes on work packages.
          readOnly: false
        highlightingMode:
          type: string
          description: Which highlighting mode should the table have?
          readOnly: true
          deprecated: true
        showHierarchies:
          type: boolean
          description: Should the hierarchy mode be enabled?
          readOnly: true
          deprecated: true
        hidden:
          type: boolean
          description: Should the query be hidden from the query list?
          readOnly: true
          deprecated: true
        public:
          type: boolean
          description: Can users besides the owner see the query?
          readOnly: true
        starred:
          type: boolean
          description: Should the query be highlighted to the user?
          readOnly: true
        createdAt:
          type: string
          format: date-time
          description: Time of creation
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          description: Time of the most recent change to the query
          readOnly: true
        _links:
          type: object
          properties:
            star:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'Elevates the query to the status of ''starred''


                  # Conditions


                  **Permission**: save queries for own queries, manage public queries for public queries; Only present if query is not yet starred'
                readOnly: true
            unstar:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'Removes the ''starred'' status


                  # Conditions


                  **Permission**: save queries for own queries, manage public queries for public queries; Only present if query is starred'
                readOnly: true
            update:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'Use the Form based process to verify the query before persisting


                  # Conditions


                  **Permission**: view work packages'
                readOnly: true
            updateImmediately:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'Persist the query without using a Form based process for guidance


                  # Conditions


                  **Permission**: save queries for own queries, manage public queries for public queries;'
                readOnly: true
    Schema_For_Workspace_QueriesModel:
      type: object
      example:
        _type: Schema
        _dependencies: []
        id:
          type: Integer
          name: ID
          required: true
          hasDefault: false
          writable: false
        name:
          type: String
          name: Name
          required: true
          hasDefault: false
          writable: true
          minLength: 1
          maxLength: 255
        createdAt:
          type: DateTime
          name: Created on
          required: true
          hasDefault: false
          writable: false
        updatedAt:
          type: DateTime
          name: Updated on
          required: true
          hasDefault: false
          writable: false
        user:
          type: User
          name: User
          required: true
          hasDefault: true
          writable: false
        project:
          type: Workspace
          name: Project
          required: false
          hasDefault: false
          writable: true
          _links: {}
        public:
          type: Boolean
          name: Public
          required: false
          hasDefault: true
          writable: true
        sums:
          type: Boolean
          name: Sums
          required: false
          hasDefault: true
          writable: true
        timelineVisible:
          type: Boolean
          name: Timeline visible
          required: false
          hasDefault: true
          writable: true
        timelineZoomLevel:
          type: String
          name: Timeline zoom level
          required: false
          hasDefault: true
          writable: true
        showHierarchies:
          type: Boolean
          name: Show hierarchies
          required: false
          hasDefault: true
          writable: true
        starred:
          type: Boolean
          name: Starred
          required: false
          hasDefault: true
          writable: true
        columns:
          type: '[]QueryColumn'
          name: Columns
          required: false
          hasDefault: true
          writable: true
          _links: {}
        filters:
          type: '[]QueryFilterInstance'
          name: Filters
          required: false
          writable: true
          hasDefault: true
          _links:
            allowedValuesSchemas:
              href: /api/v3/workspaces/42/queries/filter_instance_schemas
        groupBy:
          type: '[]QueryGroupBy'
          name: Group results by
          required: false
          hasDefault: false
          writable: true
          _links: {}
        sortBy:
          type: '[]QuerySortBy'
          name: Sort by
          required: false
          hasDefault: true
          writable: true
          _links: {}
        results:
          type: WorkPackageCollection
          name: Results
          required: false
          hasDefault: false
          writable: false
        _embedded:
          filtersSchemas:
            _type: Collection
            total: 20
            count: 20
            _embedded:
              elements:
              - _type: QueryFilterInstanceSchema
                _dependencies:
                - _type: SchemaDependency
                  'on': operator
                  dependencies:
                    /api/v3/queries/operators/=:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                    /api/v3/queries/operators/!:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                    /api/v3/queries/operators/!*: {}
                    /api/v3/queries/operators/*: {}
                name:
                  type: String
                  name: Name
                  required: true
                  hasDefault: true
                  writable: false
                filter:
                  type: QueryFilter
                  name: Filter
                  required: true
                  hasDefault: false
                  writable: true
                  _links: {}
                _links:
                  self:
                    href: /api/v3/queries/filter_instance_schemas/assignee
                  filter:
                    href: /api/v3/queries/filters/assignee
                    title: Assignee
              - _type: QueryFilterInstanceSchema
                _dependencies:
                - _type: SchemaDependency
                  'on': operator
                  dependencies:
                    /api/v3/queries/operators/=:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                    /api/v3/queries/operators/!:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                name:
                  type: String
                  name: Name
                  required: true
                  hasDefault: true
                  writable: false
                filter:
                  type: QueryFilter
                  name: Filter
                  required: true
                  hasDefault: false
                  writable: true
                  _links: {}
                _links:
                  self:
                    href: /api/v3/queries/filter_instance_schemas/author
                  filter:
                    href: /api/v3/queries/filters/author
                    title: Author
            _links:
              self:
                href: /api/v3/workspaces/42/queries/filter_instance_schemas
        _links:
          self:
            href: /api/v3/workspaces/42/queries/schema
    Query_Create_Form:
      type: object
      properties:
        name:
          type: string
          description: Query name.
      example:
        name: New query name
    Default_QueryModel:
      type: object
      example:
        _type: Query
        name: default
        filters:
        - _type: StatusQueryFilter
          name: Status
          _links:
            filter:
              href: /api/v3/queries/filters/status
              title: Status
            operator:
              href: /api/v3/queries/operators/o
              title: open
            schema:
              href: /api/v3/queries/filter_instance_schemas/status
            values: []
        public: false
        sums: false
        timelineVisible: false
        timelineZoomLevel: days
        timelineLabels: {}
        highlightingMode: inline
        timestamps:
        - P0D
        showHierarchies: true
        starred: false
        _embedded:
          results:
            _type: WorkPackageCollection
            total: 234
            count: 30
            pageSize: 2
            offset: 1
            _embedded:
              elements:
              - <--- shortened for brevity --->
            _links:
              self:
                href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              jumpTo:
                href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              changeSize:
                href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              createWorkPackage:
                href: /api/v3/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/work_packages
                method: post
            highlightedAttributes: []
        _links:
          self:
            href: /api/v3/queries/default
            title: Default
          results:
            href: /api/v3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
          columns:
          - href: /api/v3/queries/columns/id
            title: ID
          - href: /api/v3/queries/columns/subject
            title: Subject
          - href: /api/v3/queries/columns/type
            title: Type
          - href: /api/v3/queries/columns/status
            title: Status
          - href: /api/v3/queries/columns/priority
            title: Priority
          - href: /api/v3/queries/columns/assignee
            title: Assignee
          - href: /api/v3/queries/columns/updated_at
            title: Updated on
          highlightedAttributes: []
          groupBy:
            href: null
            title: null
          sortBy:
          - href: /api/v3/queries/sort_bys/parent-desc
            title: Parent (Descending)
          user:
            href: /api/v3/users/1
            title: OpenProject Admin
          project:
            href: null
    Query_Update_Form:
      type: object
      properties:
        name:
          type: string
          description: Query name.
      example:
        name: Updated query name
    Schema_For_Global_QueriesModel:
      type: object
      example:
        _type: Schema
        _dependencies: []
        id:
          type: Integer
          name: ID
          required: true
          hasDefault: false
          writable: false
        name:
          type: String
          name: Name
          required: true
          hasDefault: false
          writable: true
          minLength: 1
          maxLength: 255
        createdAt:
          type: DateTime
          name: Created on
          required: true
          hasDefault: false
          writable: false
        updatedAt:
          type: DateTime
          name: Updated on
          required: true
          hasDefault: false
          writable: false
        user:
          type: User
          name: User
          required: true
          hasDefault: true
          writable: false
        project:
          type: Project
          name: Project
          required: false
          hasDefault: false
          writable: true
          location: _links
          _links: {}
        public:
          type: Boolean
          name: Public
          required: false
          hasDefault: true
          writable: true
        sums:
          type: Boolean
          name: Sums
          required: false
          hasDefault: true
          writable: true
        timelineVisible:
          type: Boolean
          name: Timeline visible
          required: false
          hasDefault: true
          writable: true
          deprecated: true
        timelineZoomLevel:
          type: String
          name: Timeline zoom level
          required: false
          hasDefault: true
          writable: true
          deprecated: true
        timelineLabels:
          type: QueryTimelineLabels
          name: Timeline labels
          required: false
          hasDefault: true
          writable: true
          deprecated: true
        timestamps:
          type: '[]Timestamp'
          name: Timestamps
          required: false
          hasDefault: true
          writable: true
        highlightingMode:
          type: String
          name: Highlighting mode
          required: false
          hasDefault: true
          writable: true
          deprecated: true
        highlightedAttributes:
          type: '[]QueryColumn'
          name: Highlighted attributes
          required: false
          hasDefault: true
          writable: true
          location: _links
          deprecated: true
        showHierarchies:
          type: Boolean
          name: Show hierarchies
          required: false
          hasDefault: true
          writable: true
          deprecated: true
        starred:
          type: Boolean
          name: Starred
          required: false
          hasDefault: true
          writable: true
        columns:
          type: '[]QueryColumn'
          name: Columns
          required: false
          hasDefault: true
          writable: true
          location: _links
          _links: {}
        filters:
          type: '[]QueryFilterInstance'
          name: Filters
          required: false
          writable: true
          hasDefault: true
          location: _links
          _links:
            allowedValuesSchemas:
              href: /api/v3/queries/filter_instance_schemas
        groupBy:
          type: '[]QueryGroupBy'
          name: Group results by
          required: false
          hasDefault: false
          writable: true
          _links: {}
        sortBy:
          type: '[]QuerySortBy'
          name: Sort by
          required: false
          hasDefault: true
          writable: true
          _links: {}
        results:
          type: WorkPackageCollection
          name: Results
          required: false
          hasDefault: false
          writable: false
        _embedded:
          filtersSchemas:
            _type: Collection
            total: 20
            count: 20
            _embedded:
              elements:
              - _type: QueryFilterInstanceSchema
                _dependencies:
                - _type: SchemaDependency
                  'on': operator
                  dependencies:
                    /api/v3/queries/operators/=:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                    /api/v3/queries/operators/!:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                    /api/v3/queries/operators/!*: {}
                    /api/v3/queries/operators/*: {}
                name:
                  type: String
                  name: Name
                  required: true
                  hasDefault: true
                  writable: false
                filter:
                  type: QueryFilter
                  name: Filter
                  required: true
                  hasDefault: false
                  writable: true
                  _links: {}
                _links:
                  self:
                    href: /api/v3/queries/filter_instance_schemas/assignee
                  filter:
                    href: /api/v3/queries/filters/assignee
                    title: Assignee
              - _type: QueryFilterInstanceSchema
                _dependencies:
                - _type: SchemaDependency
                  'on': operator
                  dependencies:
                    /api/v3/queries/operators/=:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                    /api/v3/queries/operators/!:
                      values:
                        type: '[]User'
                        name: Values
                        required: true
                        hasDefault: false
                        writable: true
                        _links: {}
                name:
                  type: String
                  name: Name
                  required: true
                  hasDefault: true
                  writable: false
                filter:
                  type: QueryFilter
                  name: Filter
                  required: true
                  hasDefault: false
                  writable: true
                  _links: {}
                _links:
                  self:
                    href: /api/v3/queries/filter_instance_schemas/author
                  filter:
                    href: /api/v3/queries/filters/author
                    title: Author
            _links:
              self:
                href: /api/v3/queries/filter_instance_schemas
        _links:
          self:
            href: /api/v3/queries/schema
    ErrorResponse:
      type: object
      required:
      - _type
      - errorIdentifier
      - message
      properties:
        _embedded:
          type: object
          properties:
            details:
              type: object
              properties:
                attribute:
                  type: string
                  example: project
        _type:
          type: string
          enum:
          - Error
        errorIdentifier:
          type: string
          example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
        message:
          type: string
          example: Project can't be blank.
    Default_Query_for_WorkspaceModel:
      type: object
      example:
        _type: Query
        name: default
        filters:
        - _type: StatusQueryFilter
          name: Status
          _links:
            filter:
              href: /api/v3/queries/filters/status
              title: Status
            operator:
              href: /api/v3/queries/operators/o
              title: open
            schema:
              href: /api/v3/queries/filter_instance_schemas/status
            values: []
        public: false
        sums: false
        timelineVisible: false
        timelineZoomLevel: days
        showHierarchies: true
        starred: false
        _embedded:
          results:
            _type: WorkPackageCollection
            total: 234
            count: 30
            pageSize: 2
            offset: 1
            _embedded:
              elements:
              - <--- shortened for brevity --->
            _links:
              self:
                href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              jumpTo:
                href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              changeSize:
                href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              createWorkPackage:
                href: /api/v3/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/work_packages
                method: post
        _links:
          self:
            href: /api/v3/workspaces/42/queries/default
            title: Default
          results:
            href: /api/v3/workspaces/42/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
          columns:
          - href: /api/v3/queries/columns/id
            title: ID
          - href: /api/v3/queries/columns/subject
            title: Subject
          - href: /api/v3/queries/columns/type
            title: Type
          - href: /api/v3/queries/columns/status
            title: Status
          - href: /api/v3/queries/columns/priority
            title: Priority
          - href: /api/v3/queries/columns/assignee
            title: Assignee
          - href: /api/v3/queries/columns/updated_at
            title: Updated on
          groupBy:
            href: null
            title: null
          sortBy:
          - href: /api/v3/queries/sort_bys/parent-desc
            title: Parent (Descending)
          user:
            href: /api/v3/users/1
            title: OpenProject Admin
          project:
            href: /api/v3/projects/42
            title: Lorem ipsum project
    Star_QueryModel:
      type: object
      example:
        _type: Query
        id: 9
        name: fdsfdsfdsf
        createdAt: '2015-03-20T12:56:56.085Z'
        updatedAt: '2015-05-20T18:16:53.619Z'
        filters:
        - _type: StatusQueryFilter
          name: Status
          _links:
            filter:
              href: /api/v3/queries/filters/status
              title: Status
            operator:
              href: /api/v3/queries/operators/o
              title: open
            schema:
              href: /api/v3/queries/filter_instance_schemas/status
            values: []
        - _type: DueDateQueryFilter
          name: Finish date
          values:
          - '1'
          _links:
            filter:
              href: /api/v3/queries/filters/dueDate
              title: Finish date
            operator:
              href: /api/v3/queries/operators/<t+
              title: in less than
            schema:
              href: /api/v3/queries/filter_instance_schemas/dueDate
        public: false
        sums: false
        starred: true
        _embedded:
          results:
            _type: WorkPackageCollection
            total: 234
            count: 30
            pageSize: 2
            offset: 1
            _embedded:
              elements:
              - <--- shortened for brevity --->
            _links:
              self:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              jumpTo:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              changeSize:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              createWorkPackage:
                href: /api/v3/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/work_packages
                method: post
        _links:
          self:
            href: /api/v3/queries/9
            title: fdsfdsfdsf
          results:
            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
          columns:
          - href: /api/v3/queries/columns/id
            title: ID
          - href: /api/v3/queries/columns/subject
            title: Subject
          - href: /api/v3/queries/columns/type
            title: Type
          - href: /api/v3/queries/columns/status
            title: Status
          - href: /api/v3/queries/columns/priority
            title: Priority
          - href: /api/v3/queries/columns/assignee
            title: Assignee
          - href: /api/v3/queries/columns/updated_at
            title: Updated on
          groupBy:
            href: null
            title: null
          sortBy:
          - href: /api/v3/queries/sort_bys/parent-desc
            title: Parent (Descending)
          user:
            href: /api/v3/users/1
            title: OpenProject Admin
          project:
            href: /api/v3/projects/3
            title: copy
    QueriesModel:
      type: object
      example:
        _links:
          self:
            href: /api/v3/queries
        total: 1
        count: 1
        _type: Collection
        _embedded:
          elements:
          - _type: Query
            id: 9
            name: fdsfdsfdsf
            createdAt: '2015-03-20T12:56:56.858Z'
            updatedAt: '2015-05-20T18:16:53.887Z'
            filters:
            - _type: StatusQueryFilter
              name: Status
              _links:
                filter:
                  href: /api/v3/queries/filters/status
                  title: Status
                operator:
                  href: /api/v3/queries/operators/o
                  title: open
                schema:
                  href: /api/v3/queries/filter_instance_schemas/status
                values: []
            - _type: DueDateQueryFilter
              name: Finish date
              values:
              - '1'
              _links:
                filter:
                  href: /api/v3/queries/filters/dueDate
                  title: Finish date
                operator:
                  href: /api/v3/queries/operators/<t+
                  title: in less than
                schema:
                  href: /api/v3/queries/filter_instance_schemas/dueDate
            public: false
            sums: false
            starred: true
            projections:
            - _type: Query::TableProjection
            - _type: Query::TeamPlannerProjection
              _links:
                rows:
                - href: /api/v3/users/1
                  title: Bob Bobbit
            - _type: Query::CalendarProjection
            _embedded:
              results:
                _type: WorkPackageCollection
                total: 234
                count: 30
                pageSize: 30
                offset: 1
                _embedded:
                  elements:
                  - <--- shortened for brevity --->
                _links:
                  self:
                    href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                  jumpTo:
                    href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                    templated: true
                  changeSize:
                    href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                    templated: true
                  createWorkPackage:
                    href: /api/v3/work_packages/form
                    method: post
                  createWorkPackageImmediate:
                    href: /api/v3/work_packages
                    method: post
            _links:
              self:
                href: /api/v3/queries/9
                title: fdsfdsfdsf
              results:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              columns:
              - href: /api/v3/queries/columns/id
                title: ID
              - href: /api/v3/queries/columns/subject
                title: Subject
              - href: /api/v3/queries/columns/type
                title: Type
              - href: /api/v3/queries/columns/status
                title: Status
              - href: /api/v3/queries/columns/priority
                title: Priority
              - href: /api/v3/queries/columns/assignee
                title: Assignee
              - href: /api/v3/queries/columns/updated_at
                title: Updated on
              groupBy:
                href: null
                title: null
              sortBy:
              - href: /api/v3/queries/sort_bys/parent-desc
                title: Parent (Descending)
              user:
                href: /api/v3/users/1
                title: OpenProject Admin
              project:
                href: /api/v3/projects/3
                title: copy
    Unstar_QueryModel:
      type: object
      example:
        _type: Query
        id: 9
        name: fdsfdsfdsf
        createdAt: '2015-03-20T12:56:56.257Z'
        updatedAt: '2015-05-20T18:16:53.953Z'
        filters:
        - _type: StatusQueryFilter
          name: Status
          _links:
            filter:
              href: /api/v3/queries/filters/status
              title: Status
            operator:
              href: /api/v3/queries/operators/o
              title: open
            schema:
              href: /api/v3/queries/filter_instance_schemas/status
            values: []
        - _type: DueDateQueryFilter
          name: Finish date
          values:
          - '1'
          _links:
            filter:
              href: /api/v3/queries/filters/dueDate
              title: Finish date
            operator:
              href: /api/v3/queries/operators/<t+
              title: in less than
            schema:
              href: /api/v3/queries/filter_instance_schemas/dueDate
        public: false
        sums: false
        starred: false
        _embedded:
          results:
            _type: WorkPackageCollection
            total: 234
            count: 30
            pageSize: 2
            offset: 1
            _embedded:
              elements:
              - <--- shortened for brevity --->
            _links:
              self:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              jumpTo:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              changeSize:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              createWorkPackage:
                href: /api/v3/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/work_packages
                method: post
        _links:
          self:
            href: /api/v3/queries/9
            title: fdsfdsfdsf
          results:
            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
          columns:
          - href: /api/v3/queries/columns/id
            title: ID
          - href: /api/v3/queries/columns/subject
            title: Subject
          - href: /api/v3/queries/columns/type
            title: Type
          - href: /api/v3/queries/columns/status
            title: Status
          - href: /api/v3/queries/columns/priority
            title: Priority
          - href: /api/v3/queries/columns/assignee
            title: Assignee
          - href: /api/v3/queries/columns/updated_at
            title: Updated on
          groupBy:
            href: null
            title: null
          sortBy:
          - href: /api/v3/queries/sort_bys/parent-desc
            title: Parent (Descending)
          user:
            href: /api/v3/users/1
            title: OpenProject Admin
          project:
            href: /api/v3/projects/3
            title: copy
  examples:
    QueriesModel:
      value:
        _links:
          self:
            href: /api/v3/queries
        total: 1
        count: 1
        _type: Collection
        _embedded:
          elements:
          - _type: Query
            id: 9
            name: fdsfdsfdsf
            createdAt: '2015-03-20T12:56:56.413Z'
            updatedAt: '2015-05-20T18:16:53.392Z'
            filters:
            - _type: StatusQueryFilter
              name: Status
              _links:
                filter:
                  href: /api/v3/queries/filters/status
                  title: Status
                operator:
                  href: /api/v3/queries/operators/o
                  title: open
                schema:
                  href: /api/v3/queries/filter_instance_schemas/status
                values: []
            - _type: DueDateQueryFilter
              name: Finish date
              values:
              - '1'
              _links:
                filter:
                  href: /api/v3/queries/filters/dueDate
                  title: Finish date
                operator:
                  href: /api/v3/queries/operators/<t+
                  title: in less than
                schema:
                  href: /api/v3/queries/filter_instance_schemas/dueDate
            public: false
            sums: false
            starred: true
            projections:
            - _type: QueryProjection::Table
            - _type: QueryProjection::TeamPlanner
              _links:
                rows:
                - href: /api/v3/users/1
                  title: Bob Bobbit
            - _type: QueryProjection::Calendar
            _embedded:
              results:
                _type: WorkPackageCollection
                total: 234
                count: 30
                pageSize: 30
                offset: 1
                _embedded:
                  elements:
                  - <--- shortened for brevity --->
                _links:
                  self:
                    href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                  jumpTo:
                    href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                    templated: true
                  changeSize:
                    href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                    templated: true
                  createWorkPackage:
                    href: /api/v3/work_packages/form
                    method: post
                  createWorkPackageImmediate:
                    href: /api/v3/work_packages
                    method: post
            _links:
              self:
                href: /api/v3/queries/9
                title: fdsfdsfdsf
              results:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              columns:
              - href: /api/v3/queries/columns/id
                title: ID
              - href: /api/v3/queries/columns/subject
                title: Subject
              - href: /api/v3/queries/columns/type
                title: Type
              - href: /api/v3/queries/columns/status
                title: Status
              - href: /api/v3/queries/columns/priority
                title: Priority
              - href: /api/v3/queries/columns/assignee
                title: Assignee
              - href: /api/v3/queries/columns/updated_at
                title: Updated on
              groupBy:
                href: null
                title: null
              sortBy:
              - href: /api/v3/queries/sort_bys/parent-desc
                title: Parent (Descending)
              user:
                href: /api/v3/users/1
                title: OpenProject Admin
              project:
                href: /api/v3/projects/3
                title: copy
    QuerySchemaModel:
      value:
        _dependencies: []
        _embedded:
          filtersSchemas:
            _embedded:
              elements:
              - _dependencies:
                - _type: SchemaDependency
                  dependencies:
                    /api/v3/queries/operators/!:
                      values:
                        _links: {}
                        hasDefault: false
                        name: Values
                        required: true
                        type: '[]User'
                        writable: true
                    /api/v3/queries/operators/!*: {}
                    /api/v3/queries/operators/*: {}
                    /api/v3/queries/operators/=:
                      values:
                        _links: {}
                        hasDefault: false
                        name: Values
                        required: true
                        type: '[]User'
                        writable: true
                  'on': operator
                _links:
                  filter:
                    href: /api/v3/queries/filters/assignee
                    title: Assignee
                  self:
                    href: /api/v3/queries/filter_instance_schemas/assignee
                _type: QueryFilterInstanceSchema
                filter:
                  _links: {}
                  hasDefault: false
                  name: Filter
                  required: true
                  type: QueryFilter
                  writable: true
                name:
                  hasDefault: true
                  name: Name
                  required: true
                  type: String
                  writable: false
              - _dependencies:
                - _type: SchemaDependency
                  dependencies:
                    /api/v3/queries/operators/!:
                      values:
                        _links: {}
                        hasDefault: false
                        name: Values
                        required: true
                        type: '[]User'
                        writable: true
                    /api/v3/queries/operators/=:
                      values:
                        _links: {}
                        hasDefault: false
                        name: Values
                        required: true
                        type: '[]User'
                        writable: true
                  'on': operator
                _links:
                  filter:
                    href: /api/v3/queries/filters/author
                    title: Author
                  self:
                    href: /api/v3/queries/filter_instance_schemas/author
                _type: QueryFilterInstanceSchema
                filter:
                  _links: {}
                  hasDefault: false
                  name: Filter
                  required: true
                  type: QueryFilter
                  writable: true
                name:
                  hasDefault: true
                  name: Name
                  required: true
                  type: String
                  writable: false
            _links:
              self:
                href: /api/v3/queries/filter_instance_schemas
            _type: Collection
            count: 20
            total: 20
        _links:
          self:
            href: /api/v3/queries/schema
        _type: Schema
        columns:
          _links: {}
          hasDefault: true
          location: _links
          name: Columns
          required: false
          type: '[]QueryColumn'
          writable: true
        createdAt:
          hasDefault: false
          name: Created on
          required: true
          type: DateTime
          writable: false
        filters:
          _links:
            allowedValuesSchemas:
              href: /api/v3/queries/filter_instance_schemas
          hasDefault: true
          location: _links
          name: Filters
          required: false
          type: '[]QueryFilterInstance'
          writable: true
        groupBy:
          _links: {}
          hasDefault: false
          name: Group results by
          required: false
          type: '[]QueryGroupBy'
          writable: true
        highlightedAttributes:
          hasDefault: true
          location: _links
          name: Highlighted attributes
          required: false
          type: '[]QueryColumn'
          writable: true
          deprecated: true
        highlightingMode:
          hasDefault: true
          name: Highlighting mode
          required: false
          type: String
          writable: true
          deprecated: true
        id:
          hasDefault: false
          name: ID
          required: true
          type: Integer
          writable: false
        name:
          hasDefault: false
          maxLength: 255
          minLength: 1
          name: Name
          required: true
          type: String
          writable: true
        project:
          _links: {}
          hasDefault: false
          location: _links
          name: Project
          required: false
          type: Project
          writable: true
        public:
          hasDefault: true
          name: Public
          required: false
          type: Boolean
          writable: true
        results:
          hasDefault: false
          name: Results
          required: false
          type: WorkPackageCollection
          writable: false
        showHierarchies:
          hasDefault: true
          name: Show hierarchies
          required: false
          type: Boolean
          writable: true
          deprecated: true
        sortBy:
          _links: {}
          hasDefault: true
          name: Sort by
          required: false
          type: '[]QuerySortBy'
          writable: true
        starred:
          hasDefault: true
          name: Starred
          required: false
          type: Boolean
          writable: true
        sums:
          hasDefault: true
          name: Sums
          required: false
          type: Boolean
          writable: true
        timelineLabels:
          hasDefault: true
          name: Timeline labels
          required: false
          type: QueryTimelineLabels
          writable: true
          deprecated: true
        timelineVisible:
          hasDefault: true
          name: Timeline visible
          required: false
          type: Boolean
          writable: true
          deprecated: true
        timelineZoomLevel:
          hasDefault: true
          name: Timeline zoom level
          required: false
          type: String
          writable: true
          deprecated: true
        timestamps:
          hasDefault: true
          name: Timestamps
          required: false
          type: '[]Timestamp'
          writable: true
        updatedAt:
          hasDefault: false
          name: Updated on
          required: true
          type: DateTime
          writable: false
        user:
          hasDefault: true
          name: User
          required: true
          type: User
          writable: false
    QueryModel:
      value:
        _type: Query
        id: 9
        name: abcdefg
        createdAt: '2015-03-20T12:56:56.235Z'
        updatedAt: '2015-05-20T18:16:53.976Z'
        filters:
        - _type: StatusQueryFilter
          name: Status
          _links:
            filter:
              href: /api/v3/queries/filters/status
              title: Status
            operator:
              href: /api/v3/queries/operators/o
              title: open
            schema:
              href: /api/v3/queries/filter_instance_schemas/status
            values: []
        - _type: DueDateQueryFilter
          name: Finish date
          values:
          - '1'
          _links:
            filter:
              href: /api/v3/queries/filters/dueDate
              title: Finish date
            operator:
              href: /api/v3/queries/operators/<t+
              title: in less than
            schema:
              href: /api/v3/queries/filter_instance_schemas/dueDate
        public: false
        sums: false
        starred: false
        hidden: false
        timestamps:
        - PT0S
        projections:
        - _type: QueryProjection::Table
          showHierarchies: true
          _links:
            columns:
            - href: /api/v3/queries/columns/id
              title: ID
            - href: /api/v3/queries/columns/subject
              title: Subject
            - href: /api/v3/queries/columns/type
              title: Type
            - href: /api/v3/queries/columns/status
              title: Status
            - href: /api/v3/queries/columns/priority
              title: Priority
            - href: /api/v3/queries/columns/assignee
              title: Assignee
            - href: /api/v3/queries/columns/updated_at
              title: Updated on
            highlightedAttributes: []
        - _type: QueryProjection::Gantt
          labels: {}
          zoomLevel: auto
          _links:
            highlightedAttributes: []
        - _type: QueryProjection::TeamPlanner
          _links:
            rows:
            - href: /api/v3/users/1
              title: Alan Touring
            - href: /api/v3/users/5
              title: John von Neumann
        - _type: QueryProjection::Calendar
        _embedded:
          results:
            _type: WorkPackageCollection
            total: 234
            count: 30
            pageSize: 30
            offset: 1
            _embedded:
              elements:
              - <--- shortened for brevity --->
            _links:
              self:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
              jumpTo:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=%7Boffset%7D&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              changeSize:
                href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=%7Bsize%7D&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
                templated: true
              createWorkPackage:
                href: /api/v3/work_packages/form
                method: post
              createWorkPackageImmediate:
                href: /api/v3/work_packages
                method: post
        _links:
          self:
            href: /api/v3/queries/9
            title: abcdefg
          results:
            href: /api/v3/projects/3/work_packages?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22o%22%2C%22values%22%3A%5B%5D%7D%7D%2C%7B%22dueDate%22%3A%7B%22operator%22%3A%22%3Ct%2B%22%2C%22values%22%3A%5B%221%22%5D%7D%7D%5D&offset=1&pageSize=2&sortBy=%5B%5B%22parent%22%2C%22desc%22%5D%5D
          groupBy:
            href: null
            title: null
          sortBy:
          - href: /api/v3/queries/sort_bys/parent-desc
            title: Parent (Descending)
          user:
            href: /api/v3/users/1
            title: OpenProject Admin
          project:
            href: /api/v3/projects/3
            title: copy
  responses:
    MissingContentType:
      description: Occurs when the client did not send a Content-Type header
      content:
        text/plain:
          schema:
            type: string
          example: Missing content-type header
    UnsupportedMediaType:
      description: Occurs when the client sends an unsupported Content-Type header.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:TypeNotSupported
            message: Expected CONTENT-TYPE to be (expected value) but got (actual value).
    InvalidRequestBody:
      description: Occurs when the client did not send a valid JSON object in the request body.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
            message: The request body was not a single JSON object.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic