# Schema: QueryModel
---
type: object
required:
- createdAt
- updatedAt
properties:
  id:
    type: integer
    description: Query id
    readOnly: true
    minimum: 0
    exclusiveMinimum: true
  name:
    type: string
    description: Query name
    readOnly: true
  filters:
    type: "[]queryfilterinstance"
    description: A set of QueryFilters which will be applied to the work packages
      to determine the resulting work packages
    readOnly: true
  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
  timelineLabels:
    type: querytimelinelabels
    description: Which labels are shown in the timeline, empty when default
    readOnly: true
  timelineZoomLevel:
    type: string
    description: Which zoom level should the timeline be rendered in?
    readOnly: true
  highlightingMode:
    type: string
    description: Which highlighting mode should the table have?
    readOnly: true
  showHierarchies:
    type: boolean
    description: Should the hierarchy mode be enabled?
    readOnly: true
  hidden:
    type: boolean
    description: Should the query be hidden from the query list?
    readOnly: 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": "./link.yml"
        - 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": "./link.yml"
        - 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": "./link.yml"
        - description: |-
            Use the Form based process to verify the query before persisting

            # Conditions

            **Permission**: view work packages
          readOnly: true
      updateImmediately:
        allOf:
        - "$ref": "./link.yml"
        - 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
example:
  _type: Query
  id: 9
  name: fdsfdsfdsf
  createdAt: '2015-03-20T12:56:56Z'
  updatedAt: '2015-05-20T18:16:53Z'
  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
    highlightedAttributes: []
  _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
    highlightedAttributes: []
    groupBy:
      href: 
      title: 
    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