/pmse_Emails_Templates/:/find_modules GET

Overview

Get the related module list for a module

Summary

This endpoint will retrieve a list of related modules that can be accessed in the Process Email Templates definition from the specified module. Input parameters are passed in as the URL query string. Pagination is supported.

Request Arguments

Name	Type	Description	Required
module_list	String	The name of the module the retrieved module list is related to.	True

Request

rest/v11/pmse_Emails_Templates/Quotes/find_modules?module_list=Quotes

Response Arguments

Name	Type	Description
search	String	The value of the input module_list parameter.
success	Boolean	Whether the related module list has been successfully retrieved.
result	Array	An array of related module objects.

Response

{
    "search":"Quotes",
    "success":true,
    "result":[
        {
            "value":"Quotes",
            "text":"\u003CQuotes\u003E",
            "module":"Quotes",
            "module_label":"Quotes",
            "module_name":"Quotes",
            "relationship":"Quotes"
        },
        {
            "value":"billing_accounts",
            "text":"Accounts (Bill to Account: billing_accounts)",
            "module":"Accounts",
            "module_label":"Accounts",
            "module_name":"Accounts",
            "relationship":"quotes_billto_accounts"
        },
        {
            "value":"shipping_accounts",
            "text":"Accounts (Ship to Account: shipping_accounts)",
            "module":"Accounts",
            "module_label":"Accounts",
            "module_name":"Accounts",
            "relationship":"quotes_shipto_accounts"
        },
        {
            "value":"billing_contacts",
            "text":"Contacts (Bill to Contact: billing_contacts)",
            "module":"Contacts",
            "module_label":"Contacts",
            "module_name":"Contacts",
            "relationship":"quotes_contacts_billto"
        },
        {
            "value":"shipping_contacts",
            "text":"Contacts (Ship to Contact: shipping_contacts)",
            "module":"Contacts",
            "module_label":"Contacts",
            "module_name":"Contacts",
            "relationship":"quotes_contacts_shipto"
        },
        {
            "value":"contracts",
            "text":"Contracts (Contracts: contracts)",
            "module":"Contracts",
            "module_label":"Contracts",
            "module_name":"Contracts",
            "relationship":"contracts_quotes"
        },
        {
            "value":"opportunities",
            "text":"Opportunities (Opportunity: opportunities)",
            "module":"Opportunities",
            "module_label":"Opportunities",
            "module_name":"Opportunities",
            "relationship":"quotes_opportunities"
        },
        {
            "value":"assigned_user_link",
            "text":"Users (Assigned to User: assigned_user_link)",
            "module":"Users",
            "module_label":"Users",
            "module_name":"Users",
            "relationship":"quotes_assigned_user"
        },
        {
            "value":"created_by_link",
            "text":"Users (Created by User: created_by_link)",
            "module":"Users",
            "module_label":"Users",
            "module_name":"Users",
            "relationship":"quotes_created_by"
        },
        {
            "value":"modified_user_link",
            "text":"Users (Modified by User: modified_user_link)",
            "module":"Users",
            "module_label":"Users",
            "module_name":"Users",
            "relationship":"quotes_modified_user"
        }
    ]
}