The week column contains the relative week(s) (from the current week) of the dates inputted. The API allows you to read, filter, update, and clear the week column.

Read a week column

You can query the week column using the column_values object that enables you to return column-specific subfields by sending a fragment in your query. Values for the week column are of the WeekValue type.

query {
  items (ids:[1234567890, 9876543210]) {
    column_values {
      ... on WeekValue {
        start_date
        end_date
      }
    }
  }
}

Fields

Filter a week column

Using the items_page object, you can easily filter a board's items by specific columns or column values. The table below contains the week column's supported operators and compare values.

Examples

The following example returns all items on the specified board with a week column value of any week in the past.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "week"
            compare_value: ["past_weeks"]
            operator:any_of
          }
        ]
      }
	) {
      items {
        id
        name
      }
    }
  }
}

Update a week column

You can update a week column using the change_multiple_column_values mutation and passing a JSON string in the column_values argument. Simple string updates are not supported.

JSON

To update a week column using JSON, send the start and end dates in a YYYY-MM-DD format. The dates must be seven days apart (inclusive of the first and last date) and start at the beginning of the work week defined in the account settings.

mutation {
  change_multiple_column_values(
    item_id:9876543210
    board_id:1234567890
    column_values: "{\"week\":{ \"week\": {\"startDate\" : \"2019-06-10\", \"endDate\" : \"2019-06-16\"}}}"
	) {
    id
  }
}

Clear a week column

You can also clear a week column using the change_multiple_column_values mutation and passing null or an empty object in the column_values argument.

mutation {
  change_multiple_column_values(
    item_id:9876543210
    board_id:1234567890
    column_values: "{\"week\" : null}"
	) {
    id
  }
}