/pmse_Emails_Templates/variables/find GET

Overview

Get the variable list for a module

Summary

This endpoint will retrieve a list of variables that can be used 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
base_module	String	The name of the target module of the Process Email Templates definition.	True
module_list	String	The name of the module the variable list is retrieved from. Should be related to the base_module.	True
q	String	Only variables with name containing this search string will be returned.	False
max_num	Integer	Maximum number of variables to return for this request.	False
offset	Integer	The index of the first variable in the whole list to return for this request. Use "end" to indicate no variable should be returned.	False
order_by	String	Property to sort the variable list by. For example, "name:asc,id:desc" will sort the returned variable list by name ASC first and then id DESC.	False

Request

rest/v11/pmse_Emails_Templates/variables/find?max_num=20&order_by=date_modified%3Adesc&module_list=Quotes&base_module=Quotes

Response Arguments

Name	Type	Description
next_offset	Integer	The offset value that should be used to retrieve the next batch of the list.
records	Array	A sorted array of variable objects.

Response

{
    "next_offset":20,
    "records":[
        {
            "id":"date_quote_expected_closed",
            "_module":"Quotes",
            "name":"Valid Until",
            "rhs_module":"Quotes"
        },
        {
            "id":"total_usdollar",
            "_module":"Quotes",
            "name":"Total (US Dollar)",
            "rhs_module":"Quotes"
        },
        {
            "id":"total",
            "_module":"Quotes",
            "name":"Total",
            "rhs_module":"Quotes"
        },
        {
            "id":"tax_usdollar",
            "_module":"Quotes",
            "name":"Tax (US Dollar)",
            "rhs_module":"Quotes"
        },
        {
            "id":"tax",
            "_module":"Quotes",
            "name":"Tax",
            "rhs_module":"Quotes"
        },
        {
            "id":"subtotal_usdollar",
            "_module":"Quotes",
            "name":"Subtotal (US Dollar)",
            "rhs_module":"Quotes"
        },
        {
            "id":"subtotal",
            "_module":"Quotes",
            "name":"Subtotal",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping_address_state",
            "_module":"Quotes",
            "name":"Shipping State",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping_address_postalcode",
            "_module":"Quotes",
            "name":"Shipping Postal Code",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping_address_country",
            "_module":"Quotes",
            "name":"Shipping Country",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping_address_city",
            "_module":"Quotes",
            "name":"Shipping City",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping_address_street",
            "_module":"Quotes",
            "name":"Shipping Address",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping_usdollar",
            "_module":"Quotes",
            "name":"Shipping (US Dollar)",
            "rhs_module":"Quotes"
        },
        {
            "id":"shipping",
            "_module":"Quotes",
            "name":"Shipping",
            "rhs_module":"Quotes"
        },
        {
            "id":"quote_type",
            "_module":"Quotes",
            "name":"Quote Type",
            "rhs_module":"Quotes"
        },
        {
            "id":"name",
            "_module":"Quotes",
            "name":"Quote Subject",
            "rhs_module":"Quotes"
        },
        {
            "id":"quote_stage",
            "_module":"Quotes",
            "name":"Quote Stage",
            "rhs_module":"Quotes"
        },
        {
            "id":"quote_num",
            "_module":"Quotes",
            "name":"Quote Number",
            "rhs_module":"Quotes"
        },
        {
            "id":"purchase_order_num",
            "_module":"Quotes",
            "name":"Purchase Order Num",
            "rhs_module":"Quotes"
        },
        {
            "id":"payment_terms",
            "_module":"Quotes",
            "name":"Payment Terms",
            "rhs_module":"Quotes"
        }
    ]
}