组织小插件

方法与权限

API	GET	POST	PUT	PATCH	DELETE
组织小插件列表	管理员, 成员	管理员	-	-	-
组织小插件详情	管理员, 成员	-	-	管理员 *	管理员

*只能更改 is_archived字段。

获取组织小插件列表

端点: /organizations/organizationwidget/list/{level}/{sid}/{serializer}/

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

organization

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

organization sid

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

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

响应: 200

# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 9,
    "count": 81,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "ehkn0a40x1glqvAFKP",
            "name": "Plain Text"
        },
        ...
    ]
}

# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 9,
    "count": 81,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "is_archived": false,
            "change_permission": true
        },
        ...
    ]
}

# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 9,
    "count": 81,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xx",
            "is_archived": false,
            "updated_by": "xxx",
            "date_updated": "2020-02-10T03:02:28.525127Z",
            "date_created": "2020-02-10T03:02:28.523525Z",
            "change_permission": true
        },
        ...
    ]
}

创建组织小插件

端点: /organizations/organizationwidget/list/{level}/{sid}/{serializer}/

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

organization

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

organization sid

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

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

参数: widget (正文, 对象)

响应: 201

{
    "sid": "xx",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:28.525127Z",
    "date_created": "2020-02-10T03:02:28.523525Z",
    "change_permission": true
}

响应: 406

- Error: Invaid widget sid!
- Error: the widget is not available for your organization!

获取组织小插件详情

端点: /organizations/organizationwidget/detail/{sid}/

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

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

响应: 200

{
    "sid": "xx",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:28.525127Z",
    "date_created": "2020-02-10T03:02:28.523525Z",
    "change_permission": true
}

删除组织小插件详情

端点: /organizations/organizationwidget/detail/{sid}/

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

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

响应: 204

{}