Create filter

POST /data/user/filters
Jwt authorization

Create a new filter for the current user limited to open projects only.

application/json

Body Required

  • name string Required

    Filter name

  • query string Required

    Filter query as JSON string

  • list_type string Required

    Type of list this filter applies to

  • entity_type string

    Entity type this filter applies to

  • project_id string(uuid) Required

    Project identifier

  • is_shared boolean

    Whether to share this filter with others

    Default value is false.

  • search_filter_group_id string(uuid)

    Filter group identifier

  • department_id string(uuid)

    Department identifier

Responses

  • 201 application/json

    Filter created successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Filter unique identifier

    • name string

      Filter name

    • query string

      Filter query JSON

    • list_type string

      List type

    • entity_type string

      Entity type

    • project_id string(uuid)

      Project identifier

    • is_shared boolean

      Whether filter is shared

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
  • 400

    Bad request

POST /data/user/filters 
curl \
 --request POST 'http://api.example.com/data/user/filters' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"My Custom Filter","query":"{\"project_id\": \"uuid\"}","list_type":"todo","entity_type":"Asset","project_id":"a24a6ea4-ce75-4665-a070-57453082c25","is_shared":false,"search_filter_group_id":"b35b7fb5-df86-5776-b181-68564193d36","department_id":"c46c8gc6-eg97-6887-c292-79675204e47"}'
Request examples 
{
  "name": "My Custom Filter",
  "query": "{\"project_id\": \"uuid\"}",
  "list_type": "todo",
  "entity_type": "Asset",
  "project_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "is_shared": false,
  "search_filter_group_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "department_id": "c46c8gc6-eg97-6887-c292-79675204e47"
}
Response examples (201) 
{
  "id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "name": "My Custom Filter",
  "query": "{\"project_id\": \"uuid\"}",
  "list_type": "todo",
  "entity_type": "Asset",
  "project_id": "e68e0ie8-gi19-8009-e514-91897426g69",
  "is_shared": false,
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}