# Schema: GridModel
---
type: object
properties:
  id:
    type: integer
    description: Grid's id
    readOnly: true
    minimum: 0
    exclusiveMinimum: true
  rowCount:
    type: integer
    description: The number of rows the grid has
    minimum: 0
    exclusiveMinimum: true
  columnCount:
    type: integer
    description: The number of columns the grid has
    minimum: 0
    exclusiveMinimum: true
  widgets:
    type: "[]gridwidget"
    description: |-
      The set of `GridWidget`s selected for the grid

      # Conditions

      The widgets cannot overlap
  createdAt:
    type: string
    format: date-time
    description: The time the grid was created
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    description: The time the grid was last updated
    readOnly: true
  _links:
    type: object
    required:
    - self
    - page
    properties:
      updateImmediately:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Directly perform edits on this grid

            # Conditions

            **Permission**: depends on the page the grid is defined for
          readOnly: true
      update:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Validate edits on the grid via a form resource before committing

            # Conditions

            **Permission**: depends on the page the grid is defined for
          readOnly: true
      self:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            This grid

            **Resource**: Grid
          readOnly: true
      page:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            The url of the page the grid is defined for

            **Resource**: url

            # Conditions

            The page cannot be changed after the creation
example:
  _type: Grid
  id: 2
  rowCount: 8
  columnCount: 5
  widgets:
  - _type: GridWidget
    identifier: time_entries_current_user
    startRow: 1
    endRow: 8
    startColumn: 1
    endColumn: 3
  - _type: GridWidget
    identifier: news
    startRow: 3
    endRow: 8
    startColumn: 4
    endColumn: 5
  - _type: GridWidget
    identifier: documents
    startRow: 1
    endRow: 3
    startColumn: 3
    endColumn: 6
  createdAt: '2018-12-03T16:58:30Z'
  updatedAt: '2018-12-13T19:36:40Z'
  _links:
    scope:
      href: "/my/page"
      type: text/html
    updateImmediately:
      href: "/api/v3/grids/2"
      method: patch
    update:
      href: "/api/v3/grids/2/form"
      method: post
    self:
      href: "/api/v3/grids/2"