Salesforce empowers its CRMs functionality by providing many prebuilt applications with the ability of customization to fit the organizations need. Nevertheless, some organizations have complex processes that are uncorroborated with the existing Salesforce functionalities; so the Salesforce Lightning Platform offers multiple applications/ technologies like SOAP API, Apex, Visual force and more that provides high-end customization functionalities for advanced administrators and developers.

SOAP API

SOAP API is a Lightning Platform technology that provides powerful, convenient, and simple functionalities for the record management. SOAP API calls can be used to create, retrieve, delete or update any accounts, leads or custom objects records. Also, managing passwords, executing searches and more. There are over 20 different SOAP API calls which can be used in any language supporting Web Services.

describeLayout()

The SOAP API Describe Layout call is used to retrieve description and metadata of the page layouts for a specific object type.

 

The describeLayout() call returns a DescribeLayoutResult object that contains the top-level record type.

information on the specific passed-in sObjectType and mapping of record types to layouts. This object can be traverse to retrieve details and metadata of the page layouts.

For Live Demo Click here

Syntax:

DescribeLayoutResult = connection.describeLayout (string sObjectType, string layoutName, ID recordTypeID[]);

 

Representing a specific layout for the specified sObjectType, each DescribeLayout has a unique layout ID for reference consisting of two types of views:

 

  • Detail view

In this detail layout, certain information details (such as address details) are accumulated into a single DescribeLayoutItem. This view is a Read-only display of the object.

 

  • Edit view

In this edit layout, individual pieces of information (such as an address) is will be fragmented into separate fields. This view is an Editable display of the object.

URI

URI used to return descriptions of global publisher layouts:

 

/vXX.X/sobjects/Global/describe/layouts/

 

URI used to return layout description for a specific object:

 

/vXX.X/sobjects/Object/describe/layouts/

 

URI used to return layout description for objects that have more than one record type defined:

 

/vXX.X/sobjects/Object/describe/layouts/
<recordTypeId>.

 

For example, the following URI requests the layout for a specific Contact record:

 

/vXX.X/sobjects/Contact/describe/layouts/

012xx00000024x5AAA.

Conclusion:

Describe Layout call is used to retrieve information about the layout for a specific object type; returning metadata such as the detail page layout, the edit page layout, and the record type mappings of the given page layout. When a user profile has multiple layouts per objects with each layout specific to a record type, this call can be used to return metadata for multiple layouts.

That is all on SOAP API Describe Layout. If there any queries regarding this command or if you need any assistance, please reach out to us.

Related Articles
Hands-On Guide Building a Drag-and-Drop Form Builder Using Lightning Web Components

Drag-and-drop interfaces are a user experience staple, and when paired with the power of Lightning Web Components (LWC), they unlock dynamic, highly interactive Salesforce components. In this blog post, we’ll walk you through how to build a custom drag-and-drop form builder in LWC. Users can drag form fields like text inputs and dropdowns into a […]

Read More
Please Make Blog Banner How to Create an Agentforce Enabled Scratch Org in Salesforce 100 1

Setting up an Agentforce-enabled scratch org is the most important step for developers who want to experiment with AI features such as Prompt Builder and Einstein GPT. Whether you’re developing the next generation CRM software or experimenting with how generative AI may improve user experience, a scratch org equipped with Agentforce is your playground. Follow […]

Read More
Step-by-Step Guide to Enhance Your LWC Development Workflow with the Logger API

Are you looking to streamline your LWC development workflow but confused about how to do it? Then you are in the right place. The Salesforce Logger API is a powerful tool that helps you monitor, debug, and improve code quality in real time.  This step-by-step guide walks you through how to set it up and […]

Read More
Enhancing Your Salesforce Experience with a Custom Activity Component

In today’s fast-paced business landscape, productivity hinges on streamlined workflows and intuitive interfaces. While Salesforce offers robust activity tracking capabilities, sometimes the standard components fall short of specific organizational needs.  That’s where a Custom Activity Component comes in—designed to tailor your activity management experience, boost user efficiency, and provide deeper insights into customer interactions. In […]

Read More
Step-by-Step Guide to Integrating Salesforce Doc-Gen with eSigning Tools

In today’s fast-paced digital landscape, streamlining document workflows is no longer a luxury—it’s a necessity.  Integrating a document generation app, like Docs Made Easy, with an eSigning tool, helps businesses automate the entire document lifecycle—from creation to signature—saving time, reducing errors, and boosting productivity. In this guide, we’ll walk you through the key steps, tools, […]

Read More
How to Build a Real Time Chat Application Using LWC and Models API

The Models API plays a significant role in providing access to and facilitating interaction with large language models (LLMs) from various Salesforce partners such as Anthropic, Google, and OpenAI. It enables applications to leverage these models for various tasks, including text generation and other AI-powered capabilities. As a user, you can configure any Salesforce-enabled model […]

Read More
Our Location worldwide
Indian Flag India
3rd Floor, A-10, Pegasus Tower, Sector 68, Noida, Uttar Pradesh 201301 +91-1203117884
United States of America Flag USA
333 West Brown Deer Road Unit G – 366 Milwaukee WI, USA 53217 +1(262) 310-7818
United Kingdom Flag UK
7 Bell Yard, London, WC2A 2JR +44 20 3239 9428
Canada Canada
HIC Global Solutions INC
43 Lafferty Lane, Richmond Hill, L4C 3N8, CA +1(262) 310-7818