Related Lists Meta Data

Purpose

To get the related list data of a particular module.

Request URL

https://workerly.zoho.com/workerly/v2/settings/related_lists?module={module_api_name}

module_api_name - The API name of the module

Request Method

GET

Scope

scope=ZohoWorkerly.settings.related_lists.read
(or)
scope=ZohoWorkerly.settings.related_lists.all
(or)
scope=ZohoWorkerly.settings.all

Parameters

Parameter Name	Data Type	Description
module (mandatory)	String	Specify the API name of the required module. For example, Temps, Contacts, Clients, Timesheets and so on. The related list of the specified module will be retrieved.

Possible Errors

HTTP Status	Error Code	Message	Reason
400	INVALID_MODULE	The module name given is invalid	Invalid module name or no tab permission, or the module could have been removed from the organized module
400	INVALID_MODULE	The given module is not supported in API	The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are supported.)

Note:

The "href" attribute in the response must be used in the URL to call the related list API. For example, the URL for calling the related list API must be:
https://workerly.zoho.com/workerly/v2/Temps/{module_id}/Notes

Sample Request

Copiedhttps://workerly.zoho.com/workerly/v2/settings/related_lists?module=Temps

Sample Response

Copied{
    "related_lists": [
        {
            "sequence_number": "1",
            "list_label": "Notes",
            "api_name": "Notes",
            "module": "Notes",
            "name": "Notes",
            "id": "15304000000014780",
            "href": "Temps/{ENTITYID}/Notes",
            "type": "default"
        },
        {
            "sequence_number": "2",
            "list_label": "Attachments",
            "api_name": "Attachments",
            "module": "Attachments",
            "name": "Attachments",
            "id": "15304000000014783",
            "href": "Temps/{ENTITYID}/Attachments",
            "type": "default"
        },
        {
            "sequence_number": "3",
            "list_label": "Timesheets",
            "api_name": "Timesheets",
            "module": "Timesheets",
            "name": "Timesheets",
            "id": "15304000000014789",
            "href": "Temps/{ENTITYID}/Timesheets",
            "type": "default"
        },
        {
            "sequence_number": "4",
            "list_label": "Emails",
            "api_name": "Emails",
            "module": "Emails",
            "name": "Emails",
            "id": "15304000000014792",
            "href": null,
            "type": "default"
        },
        {
            "sequence_number": "5",
            "list_label": "SMS",
            "api_name": "SMS",
            "module": null,
            "name": "SMS",
            "id": "15304000000014798",
            "href": null,
            "type": "default"
        },
        {
            "sequence_number": "6",
            "api_name": "Invited_Events",
            "module": "Events",
            "name": "Invited Events",
            "id": "15304000000014801",
            "href": "Temps/{ENTITYID}/Invited_Events",
            "type": "default"
        },
        {
            "sequence_number": "7",
            "list_label": "Open Activities",
            "api_name": "Activities",
            "module": "Activities",
            "name": "Activities",
            "id": "15304000000014807",
            "href": "Temps/{ENTITYID}/Activities",
            "type": "default"
        }
    ]
}