分类 API

7 endpoints.

获取全部分类

GEThttp://localhost:3000/api/categories

获取服务端保存的全部分类。

响应

200分类列表

[
  {
    "archives": [
      "0d50858d727723d856d2ab78564bb8e906e65f14",
      "7f03b8b1f337e1e42b2c2890533c0de7479d41ca"
    ],
    "id": "SET_1613080290",
    "name": "My great category",
    "pinned": 0,
    "search": null
  }
]

服务器地址API 令牌

填写你自己的实例地址，请求由浏览器直接发往该地址。

创建分类

PUThttp://localhost:3000/api/categories

创建一个新分类。

请求体

application/x-www-form-urlencoded, multipart/form-data

响应

200成功响应

{
  "category_id": "SET_1613080290",
  "operation": "create_category",
  "success": 0
}

400错误响应

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。

删除分类

DELETEhttp://localhost:3000/api/categories/{id}

删除一个分类。

响应

200成功响应

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423该分类 ID 当前被锁定，无法修改

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。

获取单个分类

GEThttp://localhost:3000/api/categories/{id}

获取指定分类 ID 的详情。

响应

200分类

{
  "archives": [
    "0d50858d727723d856d2ab78564bb8e906e65f14",
    "7f03b8b1f337e1e42b2c2890533c0de7479d41ca"
  ],
  "id": "SET_1613080290",
  "name": "My great category",
  "pinned": 0,
  "search": null
}

服务器地址API 令牌

填写你自己的实例地址，请求由浏览器直接发往该地址。

更新分类

PUThttp://localhost:3000/api/categories/{id}

修改一个分类。

请求体

application/x-www-form-urlencoded, multipart/form-data

响应

200成功响应

{
  "category_id": "SET_1613080290",
  "operation": "update_category",
  "success": 0
}

400错误响应

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423该分类当前被锁定，无法修改

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。

把档案移出分类

DELETEhttp://localhost:3000/api/categories/{id}/{archive}

把某个档案 ID 从一个分类中移除。

路径参数

idstring · min: 14 · max: 14 · pattern必填: 要移出的分类 ID。
archivestring · min: 40 · max: 40 · pattern必填: 要移除的档案 ID。

响应

200结果

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423该分类 ID 当前被锁定，无法修改

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

idpatharchivepath

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。

把档案加入分类

PUThttp://localhost:3000/api/categories/{id}/{archive}

把指定的档案 ID（见「档案 API」）加入给定分类。

路径参数

idstring · min: 14 · max: 14 · pattern必填: 要加入的分类 ID。
archivestring · min: 40 · max: 40 · pattern必填

响应

200结果

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423该分类 ID 当前被锁定，无法修改

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

服务器地址API 令牌

idpatharchivepath

该端点需要管理员令牌：访客（只读）令牌会被服务端拒绝。

填写你自己的实例地址，请求由浏览器直接发往该地址。