function readOnly(count){ }
Starting November 20, the site will be set to read-only. On December 4, 2023,
forum discussions will move to the Trailblazer Community.
+ Start a Discussion

Documentation issues for Field

I've identified a handful of problems in the documentation for the results of describeSObjects.
  1. The "writeRequiresMasterRead" attribute is listed in the documentation for 14 as part of DescribeSObjectResult, but according to the 14 partner WSDL, it's part of Field.
  2. "relationshipOrder" has the same issue as "writeRequiresMasterRead": it's documented as part of DescribeSObjectResult but the WSDL says it's in Field.
  3. "calculatedFormula" is in the WSDL definition of Field, but not documented.
  4. "externalId" is in the WSDL definition of Field, but not documented.

Mysti, Developer DocumentationMysti, Developer Documentation
Thank you for identifying these issues! I'll remove #1, #2 from the describeSObject topics.

calculated formulas are discussed here:

and external Ids are discussed here:

Field hasn't been documented yet in the API guide, the describeSObject call doesn't work for it, but clearly these issues need to be addressed. In the meantime, you can learn about Field from the metadata api documentation in the context of a custom field metadata component:

Mysti Berry
Lead Technical Writer, API
So does that mean the documentation for #1 and #2 will just be moved into the Field documentation?

The meaning of external ID as a boolean seems clear from context after looking at your custom field metadata link: it's true if this field should be treated as an external ID. However, I still don't really understand what the calculated formula string is. Is that a string representation of the formula used to generate the values? (the separate "calculated" boolean is already documented.) Or, should I just ignore it and move on? I'm writing a wrapper library around the partner API, so I don't need the calculated formula information at the moment; I just want to know if I should expose that in the wrapper.
Oh, also, the "triggerable" boolean on SObjectDescription is not documented.
Mysti, Developer DocumentationMysti, Developer Documentation
We don't currently document Field in the regular API developer guide. I'll find out if this is deliberate and if not, we will add it to the list of things we should do as soon as possible.


Mysti Berry
Lead Technical Writer
Mysti, Developer DocumentationMysti, Developer Documentation
This is an attribute we don't currently document. I'll ask about adding it to the doc set as well.

Thank you!