API: Query Filters

A QueryFilter can be referenced by a filter instance defined for a Query to denote the filtering applied to the query’s work package results. This resource is not an instance of an applicable filter but rather the type an applicable filter can have.

Actions

As of now, no actions are defined.

Linked Properties

Property	Description	Type	Constraints	Supported operations
self	This query filter	QueryFilter	not null	READ

Local Properties

Property	Description	Type	Constraints	Supported operations
id	QueryFilter id	String	not null	READ

Methods

View query filter

Retrieve an individual QueryFilter as identified by the id parameter.

id
string

required path

QueryFilter identifier

Example:
status

200

{
  "_links": {
    "self": {
      "href": "/api/v3/queries/filters/status",
      "title": "Status"
    }
  },
  "_type": "QueryFilter",
  "id": "status"
}

Query_FilterModel

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "QueryFilter id"
    }
  },
  "example": {
    "_type": "QueryFilter",
    "id": "status",
    "_links": {
      "self": {
        "href": "/api/v3/queries/filters/status",
        "title": "Status"
      }
    }
  }
}

403

Returned if the client does not have sufficient permissions to see it.

Required permission: view work package in any project

{
  "_type": "Error",
  "errorIdentifier": "urn:openproject-org:api:v3:errors:Unauthenticated",
  "message": "You are not authorized to access this resource."
}

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."
    }
  }
}

404

Returned if the QueryFilter does not exist.

{
  "_type": "Error",
  "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
  "message": "The specified query does not exist."
}

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."
    }
  }
}