Skip to content

Describing Objects in Salesforce

This task will describe objects in Salesforce, providing detailed information about them including their fields and relationships. The data will be returned in XML format.

Settings

Connection

Required
The Salesforce connection to use, see Connecting to Salesforce

Output File

Required
The file name to output the describe object results to e.g. salesforce_describe_objects_output.xml

Objects

Optional
You can optionally provide a list of the API names of specific objects you want the task to describe, or you can leave this field empty to describe all objects. The list can either be specified as a comma separated string, or you can use the 'List' data type.

Zynk Settings

See Common Task Settings

Examples

Sample output file, showing the 'Account' object:

<?xml version="1.0" encoding="utf-8"?>
<DescribeObjectResponses xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DescribeObjectResponse>
    <activateable>false</activateable>
    <createable>true</createable>
    <custom>false</custom>
    <customSetting>false</customSetting>
    <deletable>true</deletable>
    <deprecatedAndHidden>false</deprecatedAndHidden>
    <feedEnabled>false</feedEnabled>
    <keyPrefix>001</keyPrefix>
    <label>Account</label>
    <labelPlural>Accounts</labelPlural>
    <layoutable>true</layoutable>
    <mergeable>true</mergeable>
    <name>Account</name>
    <queryable>true</queryable>
    <replicateable>true</replicateable>
    <retrieveable>true</retrieveable>
    <searchable>true</searchable>
    <triggerable>true</triggerable>
    <undeletable>true</undeletable>
    <updateable>true</updateable>
    <urls>
      <rowTemplate>/services/data/v57.0/sobjects/Account/{ID}</rowTemplate>
      <uiDetailTemplate>https://d4000000092bxeaa-dev-ed.my.salesforce.com/{ID}</uiDetailTemplate>
      <uiEditTemplate>https://d4000000092bxeaa-dev-ed.my.salesforce.com/{ID}/e</uiEditTemplate>
      <describe>/services/data/v57.0/sobjects/Account/describe</describe>
      <uiNewRecord>https://d4000000092bxeaa-dev-ed.my.salesforce.com/001/e</uiNewRecord>
      <sobject>/services/data/v57.0/sobjects/Account</sobject>
    </urls>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>18</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>false</createable>
      <custom>false</custom>
      <defaultedOnCreate>true</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>true</groupable>
      <idLookup>true</idLookup>
      <label>Account ID</label>
      <length>18</length>
      <name>Id</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>false</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>tns:ID</soapType>
      <sortable>true</sortable>
      <type>id</type>
      <unique>false</unique>
      <updateable>false</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>765</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>true</createable>
      <custom>false</custom>
      <defaultedOnCreate>false</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>true</groupable>
      <idLookup>false</idLookup>
      <label>Account Name</label>
      <length>255</length>
      <name>Name</name>
      <nameField>true</nameField>
      <namePointing>false</namePointing>
      <nillable>true</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>xsd:string</soapType>
      <sortable>true</sortable>
      <type>string</type>
      <unique>false</unique>
      <updateable>true</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>18</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>true</createable>
      <custom>false</custom>
      <defaultedOnCreate>false</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>true</groupable>
      <idLookup>false</idLookup>
      <label>Record Type ID</label>
      <length>18</length>
      <name>RecordTypeId</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>true</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>tns:ID</soapType>
      <sortable>true</sortable>
      <type>reference</type>
      <unique>false</unique>
      <updateable>true</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>0</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>false</createable>
      <custom>false</custom>
      <defaultedOnCreate>false</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>false</groupable>
      <idLookup>false</idLookup>
      <label>Billing Address</label>
      <length>0</length>
      <name>BillingAddress</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>true</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>urn:address</soapType>
      <sortable>false</sortable>
      <type>address</type>
      <unique>false</unique>
      <updateable>false</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>0</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>false</createable>
      <custom>false</custom>
      <defaultedOnCreate>false</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>false</groupable>
      <idLookup>false</idLookup>
      <label>Shipping Address</label>
      <length>0</length>
      <name>ShippingAddress</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>true</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>urn:address</soapType>
      <sortable>false</sortable>
      <type>address</type>
      <unique>false</unique>
      <updateable>false</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>9</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>true</createable>
      <custom>false</custom>
      <defaultedOnCreate>true</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>true</groupable>
      <idLookup>false</idLookup>
      <label>Account Currency</label>
      <length>3</length>
      <name>CurrencyIsoCode</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>true</nillable>
      <picklistValues>
        <active>true</active>
        <defaultValue>true</defaultValue>
        <label>British Pound</label>
        <value>GBP</value>
      </picklistValues>
      <picklistValues>
        <active>true</active>
        <defaultValue>false</defaultValue>
        <label>Euro</label>
        <value>EUR</value>
      </picklistValues>
      <picklistValues>
        <active>true</active>
        <defaultValue>false</defaultValue>
        <label>U.S. Dollar</label>
        <value>USD</value>
      </picklistValues>
      <precision>0</precision>
      <restrictedPicklist>true</restrictedPicklist>
      <scale>0</scale>
      <soapType>xsd:string</soapType>
      <sortable>true</sortable>
      <type>picklist</type>
      <unique>false</unique>
      <updateable>true</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>0</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>false</createable>
      <custom>false</custom>
      <defaultedOnCreate>true</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>false</groupable>
      <idLookup>false</idLookup>
      <label>Created Date</label>
      <length>0</length>
      <name>CreatedDate</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>false</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>xsd:dateTime</soapType>
      <sortable>true</sortable>
      <type>datetime</type>
      <unique>false</unique>
      <updateable>false</updateable>
    </fields>
    <fields>
      <autoNumber>false</autoNumber>
      <byteLength>0</byteLength>
      <calculated>false</calculated>
      <caseSensitive>false</caseSensitive>
      <createable>false</createable>
      <custom>false</custom>
      <defaultedOnCreate>true</defaultedOnCreate>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <digits>0</digits>
      <filterable>true</filterable>
      <groupable>false</groupable>
      <idLookup>false</idLookup>
      <label>Last Modified Date</label>
      <length>0</length>
      <name>LastModifiedDate</name>
      <nameField>false</nameField>
      <namePointing>false</namePointing>
      <nillable>false</nillable>
      <precision>0</precision>
      <restrictedPicklist>false</restrictedPicklist>
      <scale>0</scale>
      <soapType>xsd:dateTime</soapType>
      <sortable>true</sortable>
      <type>datetime</type>
      <unique>false</unique>
      <updateable>false</updateable>
    </fields>
    <childRelationships>
      <cascadeDelete>false</cascadeDelete>
      <childSObject>Account</childSObject>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <field>ParentId</field>
      <relationshipName>ChildAccounts</relationshipName>
    </childRelationships>
    <childRelationships>
      <cascadeDelete>true</cascadeDelete>
      <childSObject>Contact</childSObject>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <field>AccountId</field>
      <relationshipName>Contacts</relationshipName>
    </childRelationships>
    <childRelationships>
      <cascadeDelete>true</cascadeDelete>
      <childSObject>Opportunity</childSObject>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <field>AccountId</field>
      <relationshipName>Opportunities</relationshipName>
    </childRelationships>
    <childRelationships>
      <cascadeDelete>false</cascadeDelete>
      <childSObject>Opportunity</childSObject>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <field>ContactId</field>
      <relationshipName>PersonOpportunities</relationshipName>
    </childRelationships>
    <childRelationships>
      <cascadeDelete>true</cascadeDelete>
      <childSObject>Order</childSObject>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <field>AccountId</field>
      <relationshipName>Orders</relationshipName>
    </childRelationships>
    <childRelationships>
      <cascadeDelete>false</cascadeDelete>
      <childSObject>Quote</childSObject>
      <deprecatedAndHidden>false</deprecatedAndHidden>
      <field>ContactId</field>
      <relationshipName>PersonQuotes</relationshipName>
    </childRelationships>
    <recordTypeInfos>
      <available>true</available>
      <defaultRecordTypeMapping>true</defaultRecordTypeMapping>
      <name>Business Account</name>
      <recordTypeId>01240000000Dke9AAC</recordTypeId>
    </recordTypeInfos>
    <recordTypeInfos>
      <available>false</available>
      <defaultRecordTypeMapping>false</defaultRecordTypeMapping>
      <name>Person Account</name>
      <recordTypeId>01240000000DkeEAAS</recordTypeId>
    </recordTypeInfos>
    <recordTypeInfos>
      <available>true</available>
      <defaultRecordTypeMapping>false</defaultRecordTypeMapping>
      <name>Master</name>
      <recordTypeId>012000000000000AAA</recordTypeId>
    </recordTypeInfos>
  </DescribeObjectResponse>
</DescribeObjectResponse>