API 开发指南
遇到问题了吗?不用担心,答案都在这。
全站搜索

大量操作

大量操作 API 设计用来在单一请求中对表单中的多笔数据运行相同的操作。

有两种指定要更新纪录的方法:

  • 使用 where筛选
  • https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/<大量操作类型>?api&where=<字段 ID>,<过滤操作元>,<值>
    
  • 在查询字段中使用 recordId,例如 recordId=1&recordId=2
  • https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/<大量操作类型>?api&recordId=<数据 ID>
    

请求格式

  • 大量操作 API 是异步操作。
  • 根据您的 Ragic 数据库帐号 URL,需要将 API URL 中的 www 修改为 na3、ap5 或 eu2。
HTTP 方法 - POST
URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/<大量操作类型>?api
首部
Authorization: Basic 

主体
{
// 描述要运行操作的 JSON 数据
}

==========

响应
{
"taskId": <识别任务的 UUID>
}

大量加锁

大量加锁 API 许可一次加锁或解锁多笔数据。 大量加锁
HTTP 方法 - POST
URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/massLock?api

{
    "action": 
}

==========

响应
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

批次签核

批次签核 API 许可一次同意或拒绝多笔数据的签核。 批次签核
HTTP 方法 - POST
URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/massApproval?api

{
    "action": , 
    "comment": <响应> // 可选
}

==========

响应
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

批次运行动作单击钮

批次运行动作单击钮 API 许可一次运行多笔数据的单击钮。 批次运行动作单击钮
HTTP 方法 - POST
URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/massActionButton?api
{
"buttonId": <单击钮 ID>
}

==========

响应
{
"taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

获取表单中可用的动作单击钮列表

HTTP 方法 - GET
URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/metadata/actionButton?api&category=massOperation

==========

响应
{
    "actionButtons": [
        {
            "id": <单击钮 ID 1>,
            "name": <单击钮名称 1>
        },
        .....
        ,{
            "id": <单击钮 ID 2>,
            "name": <单击钮名称 2>
        }
    ]
}

大量修改

大量修改 API 许可一次更新多笔数据的字段值。

大量修改

HTTP 方法 - POST
URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/massUpdate?api

{
    "action": [
        {
            "field": <字段 ID>,
            "value": <新字段值>
        }
    ]
}

==========

响应
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

大量修改API也支持对 内部用户表单外部用户表单 进行修改,但使用上有一些限制。

以下字段不开放大量修改:

  • 电邮(domainId: 1)
  • 用户名称(domainId: 4)
  • 系统备注(domainId: 10)
  • 状态(domainId: 31)
  • 内外部(domainId: 43)

群组(domainId: 3) 开放修改,但有限制:

  • value 的值必须为 JSON 数组,其中包含字符串元素。
  • 字符串中的专用字符需要使用跳脱字符(\)来表示,特别是双引号(“)需要表示为 \”
  • HTTP 方法 - POST
    URL - https://www.ragic.com/<帐号>/<页签路径参数>/<表单路径参数>/massOperation/massUpdate?api
    
    {
        "action": [
            {
                "field": 3,
                "value": "[\"SYSAdmin\"]"
            }
        ]
    }
    
    ==========
    
    响应
    {
        "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
    }
        
  • 内部用户表单,必须至少有一个用户的群组为 SYSAdmin
  • 外部用户表单,用户的群组必须以 x- 或 X- 开头

工作项目跟踪

大量操作是异步的。操作的工作项目 ID 可用于监控其进度。
HTTP 方法 - GET
URL - https://www.ragic.com/<帐号>?api&taskId=<工作项目 ID>

==========

响应
{
    "id": <工作项目 ID>,
    "ap": <帐号>,
    "taskName": <工作项目名称>,
    "status": <状态>
}

回最上面 目录

马上登记
免费试用 Ragic!

用 Google 帐号登记

立即科技 Ragic, Inc.
02-7728-8692
info@ragic.com
台北市中正区南昌路二段81号9楼