Zoho crm Logo

更改自定义视图的排序顺序

目的

要修改自定义视图中记录的排序顺序。

端点

  • PUT /settings/custom_views/{custom_view_ID}/actions/change_sort?module={module_API_name}
  • PUT /settings/custom_views/actions/change_sort?module={module_API_name}

请求详情

请求网址

要修改特定自定义视图记录的排序顺序:
{api-domain}/crm/{version}/settings/custom_views/{custom_view_ID}/actions/change_sort?module={module_API_name}

要修改多个自定义视图记录的排序顺序:
{api-domain}/crm/{version}/settings/custom_views/actions/change_sort?module={module_API_name}

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.custom_views.{operation_type}
(或)
ZohoCRM.settings.ALL

可能的操作类型

全部 - 完全访问自定义视图模块
更新 - 更新自定义视图

参数

输入 JSON 键

  • sort_by JSON 对象,必填

    您想用来排序记录的字段的 api 名称和 ID。

  • sort_order 字符串,必填

    您想用来排序记录的顺序。
    可能的值 :
    asc:升序
    desc:降序

注意

您可以在一次API调用中更新多达100个自定义视图。

示例请求对单个自定义视图进行排序

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/custom_views/1306462000000505004/actions/change_sort?module=Leads"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

示例输入

Copied{
    "custom_views": [
        {
            "sort_by": {
                "api_name": "Email",
                "id" : "1306462000000000563"
            },
            "sort_order": "asc"
        }
    ]
}

示例响应

Copied{
    "custom_views": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "1306462000000505004"
            },
            "message": "custom view updated",
            "status": "success"
        }
    ]
}

可能的错误

  • INVALID_REQUEST_METHOD HTTP 400

    HTTP请求方法类型无效
    解决方法:您指定了一个无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参阅上面的端点部分。

  • INVALID_DATA HTTP 400
    • 无效的自定义视图 ID
      解决方案:确保在请求 URL 中指定了有效的自定义视图 ID。
    • 无效的 sort_by 键的 API 名称和 ID
      解决方案:确认 input JSON 中提供的 sort_by 键的 API 名称和 ID 正确无误。
    • 无效的排序顺序键
      解决方案:检查分配给 sort_order 键的值是否正确。有效值为 "asc" 和 "desc"
  • INVALID_MODULE HTTP 400

    给定的模块名称似乎无效
    解决方法:在请求 URL 中指定一个有效的模块名称。

  • MANDATORY_NOT_FOUND HTTP 400

    未找到必填字段
    解决方法:您未在输入主体中指定一个必填键。请指定所有必填键。

  • OAUTH_SCOPE_MISMATCH HTTP 401

    未经授权
    解决方案:客户端没有所需的 OAuth 范围。创建具有有效范围的新客户端。有关更多详细信息,请参阅上面的范围部分。

  • INVALID_URL_PATTERN HTTP 404

    请检查要访问的URL是否正确
    解决方案: 指定的请求URL不正确。请指定有效的请求URL。参考上面的请求URL部分。

  • INTERNAL_ERROR HTTP 500

    内部服务器错误
    解决方法:服务器中的意外和未处理异常。请联系支持团队。

示例请求多个自定义视图

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/custom_views/actions/change_sort?module=Leads"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

多个自定义视图的示例输入

Copied{
   "custom_views":[
      {
         "sort_by":{
            "api_name":"Email",
            "id":"1306462000000000563"
         },
         "sort_order":"desc",
         "id":"1306462000000505004"
      },
      {
         "sort_by":{
            "api_name":"Company",
            "id":"1306462000000000555"
         },
         "sort_order":"asc",
         "id":"1306462000000091501"
      }
   ]
}

多个自定义视图的示例输出

Copied{
    "custom_views": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "1306462000000505004"
            },
            "message": "custom view updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "1306462000000091501"
            },
            "message": "custom view updated",
            "status": "success"
        }
    ]
}