过滤器

方法与权限

API	GET	POST	PUT	PATCH	DELETE
过滤器列表	管理员, 成员*	管理员, 成员	-	-	-
过滤器详情	管理员, 成员*	-	-	管理员, 成员*	管理员, 成员*

*成员只能查看/编辑属于自己的过滤器

获取过滤器列表

端点: /tables/filter/list/{level}/{sid}/{serializer}/

参数: level (路径, 字符串)

organization

参数: sid (路径, 字符串)

organization sid

参数: serializer (路径, 字符串)

参数: token (头部, 字符串)

参数: table__sid (查询, 字符串)

响应: 200

# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 5,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "My experiments",
            "count": 2
        },
        ...
    ]
}
# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 5,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "My experiments",
            "description": "The experiments created by me",
            "query": "{\"user__profile__euid\": \"xxx\"}",
            "users": [
                {
                    "sid": "xxx",
                    "name": "xxx"
                }
            ],
            "show_in_menu": true,
            "digest_frequency": "None",
            "is_default": false,
            "is_archived": false,
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "change_permission": true
        },
        ...
    ]
}
# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 5,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "name": "My experiments",
            "description": "The experiments created by me",
            "query": "{\"user__profile__euid\": \"xxx\"}",
            "users": [
                {
                    "sid": "xxx",
                    "name": "xxx"
                }
            ],
            "digest_frequency": "None",
            "show_in_menu": true,
            "is_default": false,
            "is_archived": false,
            "date_updated": "2020-05-16T01:43:55.354273Z",
            "date_created": "2020-02-10T03:02:27.135768Z",
            "change_permission": true
        },
        ...
    ]
}

创建过滤器

端点: /tables/filter/list/{level}/{sid}/{serializer}/

参数: level (路径, 字符串)

organization

参数: sid (路径, 字符串)

organization sid

参数: serializer (路径, 字符串)

参数: token (头部, 字符串)

参数: table__sid (查询, 字符串)

参数: name (正文, 字符串)

参数: description (正文, 字符串)

参数: is_archived (正文, 布尔值)

参数: users (正文, 数组)

参数: query (正文, 对象)

{field__expr: value}

响应: 200

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "name": "My experiments",
    "description": "The experiments created by me",
    "query": "{\"user__profile__euid\": \"xxx\"}",
    "users": [
        {
            "sid": "xxx",
            "name": "xxx"
        }
    ],
    "digest_frequency": "None",
    "show_in_menu": true,
    "is_default": false,
    "is_archived": false,
    "date_updated": "2020-05-16T01:43:55.354273Z",
    "date_created": "2020-02-10T03:02:27.135768Z",
    "change_permission": true
}

获取过滤器详情

端点: /tables/filter/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

响应: 200

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "name": "My experiments",
    "description": "The experiments created by me",
    "query": "{\"user__profile__euid\": \"xxx\"}",
    "users": [
        {
            "sid": "xxx",
            "name": "xxx"
        }
    ],
    "digest_frequency": "None",
    "show_in_menu": true,
    "is_default": false,
    "is_archived": false,
    "date_updated": "2020-05-16T01:43:55.354273Z",
    "date_created": "2020-02-10T03:02:27.135768Z",
    "change_permission": true
}

修改过滤器详情

端点: /tables/filter/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

参数: name (正文, 字符串)

参数: description (正文, 字符串)

参数: is_archived (正文, 字符串)

参数: users (正文, 字符串)

参数: query (正文, 字符串)

请注意这与 POST 不同

响应: 200

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "name": "My experiments",
    "description": "The experiments created by me",
    "query": "{\"user__profile__euid\": \"xxx\"}",
    "users": [
        {
            "sid": "xxx",
            "name": "xxx"
        }
    ],
    "digest_frequency": "None",
    "show_in_menu": true,
    "is_default": false,
    "is_archived": false,
    "date_updated": "2020-05-16T01:43:55.354273Z",
    "date_created": "2020-02-10T03:02:27.135768Z",
    "change_permission": true
}

删除过滤器详情

端点: /tables/filter/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

响应: 204

{}