使用API

批量查询数据

请求地址

https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records

请求方法

GET

接口描述

查询业务表下的数据

参数说明

参数名 分类 参数类型 必填/选填 参数说明
应用ID Path 字符串 必填
业务表ID Path 字符串 必填
Authorization Request Header 字符串 必填 Bearer {API KEY}
sort Query 逗号分隔的字段名及排序 选填 用于指定数据的排序规则。参数值必须包含排序字段及排序方式,排序方式可为升序或降序,1 表示升序,-1 表示降序。默认按照 id 降序排列。e.g. sort=id,-1
page Query 数字 选填 请求指定页数的数据。默认值为 1。
pageSize Query 数字 选填 每页包含的数据条数。必须小于或等于 100。默认值为 100。
keyStyle Query 字符串 选填 筛选条件和响应结果中标识字段的格式,可选为 id 或 name。默认值为 name。
filter Query &分隔的字段名及过滤条件 选填 用于指定条件来筛选权限可见的所有数据,参数值需要 URL encoded。

示例请求

curl -X GET 'https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records?sort=id,-1&pageSize=5&page=1' -H "Authorization: Bearer {API KEY}"

示例结果

{
    "page": 1,
    "pageSize": 5,
    "totalCount": 4,
    "items": [
        {
            "id": "609ccf69c15a635324597667",
            "values": {
                "名称": "举办客户年中大会",
                "截止日期": "2021-06-30T00:00:00Z",
                "开始日期": "2021-05-14T00:00:00Z",
                "负责人": {
                    "id": "60331d7230f719551659d490",
                    "name": "李江",
                    "avatarUrl": "https://assets-acc.hipacloud.com/prod%2Favatars%2F6070fd884dfc262c7bc8c10f",
                    "role": "admin"
                },
                "总任务数": 0,
                "已完成任务数": 0,
                "进度": 0.0,
                "状态": "🕗 未开始",
                "子任务": []
            }
        },
        {
            "id": "608aa0df3909e3c5cca9c795",
            "values": {
                "名称": "完成甘特图上线",
                "截止日期": "2021-06-08T00:00:00Z",
                "开始日期": "2021-04-30T00:00:00Z",
                "负责人": {
                    "id": "605d69b6cb0a49375c85b3bc",
                    "name": "李帆",
                    "avatarUrl": null,
                    "role": null
                },
                "总任务数": 3,
                "已完成任务数": 0,
                "进度": 0.0,
                "状态": "🕗 未开始",
                "子任务": [
                    {
                        "id": "609cc528bcca1143485a646a",
                        "displayValue": "产品设计"
                    },
                    {
                        "id": "609cc6d0bcca1143485a646d",
                        "displayValue": "报价设计"
                    },
                    {
                        "id": "609cc6bbbcca1143485a646b",
                        "displayValue": "产品研发"
                    }
                ]
            }
        }
    ]
}

查询指定数据

请求地址

https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records/{数据ID}

请求方法

GET

接口描述

查询业务表下指定数据ID的数据结果

参数说明

参数名 分类 参数类型 必填/选填 参数说明
应用ID Path 字符串 必填
业务表ID Path 字符串 必填
数据ID Path 字符串 必填
Authorization Request Header 字符串 必填 Bearer {API KEY}

示例请求

curl -X GET 'https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records/{数据ID}' -H "Authorization: Bearer {API KEY}"

示例结果

{
    "id": "608aa0df3909e3c5cca9c795",
    "values": {
        "名称": "完成甘特图上线",
        "截止日期": "2021-06-08T00:00:00Z",
        "开始日期": "2021-04-30T00:00:00Z",
        "负责人": {
            "id": "605d69b6cb0a49375c85b3bc",
            "name": "李帆",
            "avatarUrl": null,
            "role": null
        },
        "总任务数": 3,
        "已完成任务数": 0,
        "进度": 0.0,
        "状态": "🕗 未开始",
        "子任务": [
            {
                "id": "609cc528bcca1143485a646a",
                "displayValue": "产品设计"
            },
            {
                "id": "609cc6d0bcca1143485a646d",
                "displayValue": "报价设计"
            },
            {
                "id": "609cc6bbbcca1143485a646b",
                "displayValue": "产品研发"
            }
        ]
    }
}

创建数据

请求地址

https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records

请求方法

POST

接口描述

向业务表中创建一条数据。

参数说明

参数名 分类 参数类型 必填/选填 参数说明
应用ID Path 字符串 必填
业务表ID Path 字符串 必填
Authorization Request Header 字符串 必填 Bearer {API KEY}
Content-Type Request Header 字符串 必填 application/json
data Request Body Object 必填

示例请求

curl -X POST 'https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records' \
-H "Authorization: Bearer {API KEY}" \
-H "Content-Type: application/json" \
--data '
{
  "values": {
    "名称": "举办客户年中大会",
    "截止日期": "2021-06-30T00:00:00Z",
    "开始日期": "2021-05-14T00:00:00Z",
    "子任务": [
      "608aa1a611222731ac1e1b25"
    ],
    "负责人": "李江"
  }
}
'

示例结果

{
  "id": "32f87sh5lbl0n7942e1r7b4x",
  "values": {
    "名称": "举办客户年中大会",
    "截止日期": "2021-06-30T00:00:00Z",
    "开始日期": "2021-05-14T00:00:00Z",
    "子任务": [
      {
        "id": "608aa1a611222731ac1e1b25",
        "displayValue": "邀请嘉宾"
      }
    ],
    "负责人": {
      "id": "60331d7230f719551659d490",
      "name": "李江",
      "avatarUrl": "https://assets-acc.hipacloud.com/prod%2Favatars%2F6070fd884dfc262c7bc8c10f",
      "role": "admin"
    },
    "总任务数": 0,
    "已完成任务数": 0,
    "进度": 0,
    "状态": "🕗 未开始"
  }
}

更新数据

请求地址

https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records/{数据ID}

请求方法

PATCH

接口描述

修改业务表中的一条数据。

参数说明

参数名 分类 参数类型 必填/选填 参数说明
应用ID Path 字符串 必填
业务表ID Path 字符串 必填
数据ID Path 字符串 必填
Authorization Request Header 字符串 必填 Bearer {API KEY}
Content-Type Request Header 字符串 必填 application/json
data Request Body Object 必填

示例请求

curl -X PATCH 'https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records/{数据ID}' \
-H "Authorization: Bearer {API KEY}" \
-H "Content-Type: application/json" \
--data '
{
  "values": {
    "名称": "举办客户年中大会",
    "截止日期": "2021-06-30T00:00:00Z",
    "开始日期": "2021-05-14T00:00:00Z",
    "子任务": [
      "608aa1a611222731ac1e1b25"
    ],
    "负责人": "李江"
  }
}
'

示例结果

{
  "id": "32f87sh5lbl0n7942e1r7b4x",
  "values": {
    "名称": "举办客户年中大会",
    "截止日期": "2021-06-30T00:00:00Z",
    "开始日期": "2021-05-14T00:00:00Z",
    "子任务": [
      {
        "id": "608aa1a611222731ac1e1b25",
        "displayValue": "邀请嘉宾"
      }
    ],
    "负责人": {
      "id": "60331d7230f719551659d490",
      "name": "李江",
      "avatarUrl": "https://assets-acc.hipacloud.com/prod%2Favatars%2F6070fd884dfc262c7bc8c10f",
      "role": "admin"
    },
    "总任务数": 0,
    "已完成任务数": 0,
    "进度": 0,
    "状态": "🕗 未开始"
  }
}

删除数据

请求地址

https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records/{数据ID}

请求方法

DELETE

接口描述

删除业务表中的一条数据。

参数说明

参数名 分类 参数类型 必填/选填 参数说明
应用ID Path 字符串 必填
业务表ID Path 字符串 必填
数据ID Path 字符串 必填
Authorization Request Header 字符串 必填 Bearer {API KEY}

示例请求

curl -X DELETE 'https://api.hipacloud.com/v1/apps/{应用ID}/tables/{业务表ID}/records/{数据ID}' \
-H "Authorization: Bearer {API KEY}"

示例结果

{
  "id": "609ccf69c15a635324597667"
}

API状态码

黑帕云 API 遵循标准 HTTP 状态码语义。2xx 代表成功,4xx 表示请求错误,5xx 表示服务器错误。

状态码 语义 状态说明
200 Success 请求处理成功
400 Bad Request 请求不合法
401 Unauthorized 请求 API Key 无效
403 Forbidden 当前账户无数据操作权限
404 Not Found 请求资源不存在或当前账户无数据操作权限
429 Too Many Requests 请求次数超过限制
500 Server Error 服务器内部错误

最后更新时间: 06月11日 14:57