Zoho crm Logo

相关列表元数据

目的

要获取特定模块中相关列表的元数据,请在您的Zoho CRM帐户中进行操作。

端点

  • GET /settings/related_lists?module={module_API_name}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/related_lists

支持的模块

潜在客户,Account,联系人,交易,活动,任务,案例,事件,通话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,预约,服务和自定义模块。

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.related_lists.READ  (或)
ZohoCRM.settings.related_lists.ALL   (或)
ZohoCRM.settings.ALL

参数

  • module string, mandatory

    指定所需模块的API名称。例如,潜在客户、联系人、Account、交易等。请参阅本页开头的支持模块部分。

  • layout_id string, optional

    指定布局的唯一ID,以获取特定于该布局的相关列表的元数据。如果不包含此参数,则从标准布局中获取相关列表的元数据。

注意

  • 响应中的 "href" 属性必须在 URL 中使用,以调用相关列表 API。例如,调用相关列表 API 的 URL 必须是:https://www.zohoapis.com/crm/v5/Leads/{ENTITYID}/Entity_Scores__s。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/related_lists?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/related_lists?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

响应 JSON 

  • sequence_numberinteger

    表示在CRM模块中相关列表的位置。

  • display_labelstring

    表示相关列表的显示名称。

  • customize_sortBoolean

    表示相关列表中的记录是否可以排序。

  • customize_fieldsBoolean

    表示相关列表的字段是否可以自定义。

  • customize_display_labelBoolean

    表示相关列表的显示标签是否可以自定义。

  • api_namestring

    表示相关列表的 API 名称。

  • moduleJSON object

    表示相关列表所属模块的 API 名称和 ID。

  • namestring

    表示相关列表所属模块的显示名称。

  • idstring

    表示相关列表的唯一ID。

  • hrefstring

    表示访问当前相关列表的URL引用。

  • typestring

    表示当前相关列表的类型。值可以是 default 或 multiselectlookup。

  • connectedmodulestring

    如果相关列表是多选查找,则该键表示相关模块的 API 名称。

  • linkingmodulestring

    表示链接模块的 API 名称。

  • parent_related_listsstring

    表示为 Chronological_View 和 Chronological_View_History 相关列表配置的模块详细信息

  • fields string

    表示为 Chronological_View 和 Chronological_View_History 相关列表配置的字段详细信息

  • status string

    表示相关列表在模块中是可见还是隐藏的。

    可能的值:

    • visible
    • user_hidden
    • scheduled_for_deletion

示例响应

Copied{
    "related_lists": [
        {
            "module": {
                "api_name": "Entity_Cadences__s",
                "id": "2276164000000833075"
            },
            "type": "default",
            "sequence_number": "1",
            "display_label": "Cadences",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Entity_Cadences_leads",
            "customize_display_label": false,
            "name": "Cadences",
            "action": null,
            "href": "Leads/{ENTITYID}/Entity_Cadences_leads",
            "id": "2276164000000833156",
            "status": "visible"
        },
        {
            "module": {
                "api_name": "Notes",
                "id": "2276164000000000147"
            },
            "type": "default",
            "sequence_number": "1",
            "display_label": "Notes",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Notes",
            "customize_display_label": false,
            "name": "Notes",
            "action": null,
            "href": "Leads/{ENTITYID}/Notes",
            "id": "2276164000000002730",
            "status": "visible"
        },
        {
            "module": {
                "api_name": "Attachments",
                "id": "2276164000000000177"
            },
            "type": "default",
            "sequence_number": "2",
            "display_label": "Attachments",
            "customize_sort": true,
            "customize_fields": false,
            "api_name": "Attachments",
            "customize_display_label": false,
            "name": "Attachments",
            "action": null,
            "href": "Leads/{ENTITYID}/Attachments",
            "id": "2276164000000002724",
            "status": "visible"
        },
        {
            "module": {
                "api_name": "Products",
                "id": "2276164000000000163"
            },
            "type": "default",
            "sequence_number": "3",
            "display_label": "Products",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Products",
            "customize_display_label": false,
            "name": "Products",
            "action": null,
            "href": "Leads/{ENTITYID}/Products",
            "id": "2276164000000002726",
            "status": "visible"
        },
        {
            "module": null,
            "parent_related_lists": null,
            "type": "grouped",
            "sequence_number": "4",
            "display_label": "ChronologicalView",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Activities_Chronological_View",
            "customize_display_label": true,
            "name": "ChronologicalView",
            "action": null,
            "href": null,
            "id": "2276164000000472680",
            "status": "visible"
        },
        {
            "module": {
                "api_name": "Calls",
                "id": "2276164000000017015"
            },
            "type": "default",
            "sequence_number": "4",
            "display_label": "Open Calls",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Calls",
            "customize_display_label": false,
            "name": "Calls",
            "action": null,
            "href": "Leads/{ENTITYID}/Calls",
            "id": "2276164000000371752",
            "status": "visible"
        },
        {
            "module": {
                "api_name": "Events",
                "id": "2276164000000000145"
            },
            "type": "default",
            "sequence_number": "4",
            "display_label": "Open Meetings",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Events",
            "customize_display_label": false,
            "name": "Events",
            "action": null,
            "href": "Leads/{ENTITYID}/Events",
            "id": "2276164000000371750",
            "status": "visible"
        },
        {
            "module": {
                "api_name": "Tasks",
                "id": "2276164000000000143"
            },
            "type": "default",
            "sequence_number": "4",
            "display_label": "Open Tasks",
            "customize_sort": true,
            "customize_fields": true,
            "api_name": "Tasks",
            "customize_display_label": false,
            "name": "Tasks",
            "action": null,
            "href": "Leads/{ENTITYID}/Tasks",
            "id": "2276164000000371748",
            "status": "visible"
        },
        .
        .
        .
    ]
}

注意

  • 在 v5 版本中引入了两个新的相关列表 Chronological_View 和 Chronological_View_History。您可以在 Chronological_View 相关列表中获取未完成的通话、任务和会议的详细信息,在 Chronological_View_History 中获取已完成的通话、任务和会议的详细信息。这些相关列表的类型键将是 grouped     

获取相关列表的按时间顺序视图时的示例响应

Copied{
  "related_lists": [
    {
      "module": null,
      "parent_related_lists": [
        {
          "api_name": "Calls",
          "id": "2022124000000371752"
        },
        {
          "api_name": "Events",
          "id": "2022124000000371750"
        },
        {
          "api_name": "Tasks",
          "id": "2022124000000371748"
        }
      ],
      "personality_name": "CHRONOLOGICALVIEWPERSONALITY",
      "sort_by": null,
      "type": "grouped",
      "sequence_number": "4",
      "display_label": "OpenActivities",
      "customize_sort": true,
      "customize_fields": true,
      "api_name": "Activities_Chronological_View",
      "customize_display_label": true,
      "name": "Activities_Chronological_View",
      "action": null,
      "id": "2022124000000542018",
      "href": null,
      "fields": [
        {
          "api_name": "!Calls.Subject",
          "id": "2022124000000017019"
        },
        {
          "api_name": "!Calls.Call_Start_Time",
          "id": "2022124000000017029"
        },
        {
          "api_name": "!Calls.Owner",
          "id": "2022124000000017017"
        },
        {
          "api_name": "!Calls.Call_Purpose",
          "id": "2022124000000017023"
        },
        {
          "api_name": "!Calls.Call_Agenda",
          "id": "2022124000000455890"
        },
        {
          "api_name": "!Events.Event_Title",
          "id": "2022124000000000249"
        },
        {
          "api_name": "!Events.Start_DateTime",
          "id": "2022124000000101001"
        },
        {
          "api_name": "!Events.End_DateTime",
          "id": "2022124000000101003"
        },
        {
          "api_name": "!Events.All_day",
          "id": "2022124000000057003"
        },
        {
          "api_name": "!Events.Owner",
          "id": "2022124000000000247"
        },
        {
          "api_name": "!Tasks.Subject",
          "id": "2022124000000000221"
        },
        {
          "api_name": "!Tasks.Due_Date",
          "id": "2022124000000000223"
        },
        {
          "api_name": "!Tasks.Owner",
          "id": "2022124000000000219"
        },
        {
          "api_name": "!Tasks.Status",
          "id": "2022124000000000229"
        },
        {
          "api_name": "!Tasks.Priority",
          "id": "2022124000000000231"
        }
      ],
      "sort_order": null
    }
  ]
}