Skip to main content
Planview Customer Success Center

Update a board filter

PATCH /io/board/:boardId/filter/:filterId

Update a board filter

Request Properties

Param Type Usage Default
name string Name of the filter
isShared boolean Share the filter with other users false
filters.filterTagByOr boolean Should the tags filter use AND or OR
filters.parentCards string array List of parent card ids, -1 can be used for Not Assigned
filters.parentCardView enumeration Controls parent card filter display, not currently used
filters.cardTypes string array List of card type ids
filters.classOfServices string array List of custom icon ids, -1 can be used for Not Assigned
filters.blocks integer array 1 indicates blocked cards, 0 is cards that are not blocked
filters.priorities integer array List of priority values
0 (Normal)
1 (Low)
2 (High)
3 (Critical)
filters.users string array List of assigned user ids
filters.title string Title or custom id match
filters.startDate integer Planned start date is before this number of days from now
filters.finishDate integer Planned finish date is before this number of days from now
filters.plannedStartRange.start date Planned start date is on or after this date
filters.plannedStartRange.end date Planned start date is on or before this date
filters.plannedFinishRange.start date Planned finish date is on or after this date
filters.plannedFinishRange.end date Planned finish date is on or before this date
filters.tags string array List of tags
filters.activity.mode enumeration Possible values are
noActivity
withActivity
notMoved
haveMoved
filters.activity.days integer Number of days applied to the activity mode

Example Request

Minimal request

{
  "filters": {
    "tags": [ "two" ]
  }
}

All fields

{
    "filters": {
        "filterTagByOr": false,
        "parentCards": [
            "682817489"
        ],
        "parentCardView": "textView",
        "cardTypes": [
            "622011857",
            "622011860"
        ],
        "classOfServices": [
            "622033247",
            -1
        ],
        "blocks": [
            1
        ],
        "priorities": [
            2,
            0
        ],
        "users": [
          "478440842"
        ],
        "title": "sample title",
        "startDate": 2,
        "finishDate": 4,
        "plannedStartRange": {
            "start": "2020-01-07",
            "end": "2020-01-09"
        },
        "plannedFinishRange": {
            "start": "2020-01-09",
            "end": "2020-01-11"
        },
        "tags": [
            "one",
            "two"
        ],
        "activity": {
            "mode": "withActivity",
            "days": 14
        }
    }
}

Example Successful Response

200 OK

{
    "id": "956623925",
    "boardId": "621306390",
    "name": "Sample filter",
    "filters": {
        "filterTagByOr": false,
        "parentCards": [
            "682817489"
        ],
        "parentCardView": "textView",
        "cardTypes": [
            "622011857",
            "622011860"
        ],
        "classOfServices": [
            "622033247",
            -1
        ],
        "blocks": [
          1
        ],
        "priorities": [
            2,
            0
        ],
        "users": [
            "478440842"
        ],
        "title": "sample title",
        "startDate": 2,
        "finishDate": 4,
        "plannedStartRange": {
            "start": "2020-01-07",
            "end": "2020-01-09"
        },
        "plannedFinishRange": {
            "start": "2020-01-09",
            "end": "2020-01-11"
        },
        "tags": [
            "one"
        ],
        "activity": {
            "mode": "withActivity",
            "days": 14
        }
    },
    "isShared": true,
    "user": {
        "id": "478440842",
        "firstName": "First",
        "lastName": "Last",
        "avatar": "https://myaccount.leankit.com/avatar/show/478440842/?s=25"
    }
}



Updated 2020-01-23 @ 21:01 PM