2. Describe | Cirrus Shield Help

URL:

« /RestApi/Describe/<objectName>?authToken=<authToken> »

Method: GET
URL Params:
- objectName [string] [Required]=the name of the object that the user wants to describe
- authToken [string] [Required]=the authentication token
Success Response:
- Status Code=200 (OK)
- Returned Data [in XML or JSON]=a detailed description of the object (name, label, plural label, fields, …)
Error Response:
- Status Code=401 (Unauthorized) (in case of a wrong authentication token)Or
- Status Code=400 (BadRequest) (in case of an empty object name parameter)

Example of returned data (in xml format) (objectName=”Account”):

<?xml version="1.0"?>

<ObjectDescriptor>

  <APIName>Account</APIName>

  <Fields>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>Text</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>false</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>true</IsUnique>

<Label>Id</Label>

<Length i:nil="true"/>
<Name>Id</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName/>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>Text</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>true</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Name</Label>

<Length i:nil="true"/>

<Name>Name</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName/>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>LookupRelationship</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>true</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Owner</Label>

<Length i:nil="true"/>

<Name>OwnerId</Name>

<PicklistValues i:nil="true"/>

 <Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName>Account1</RelationshipName>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>LookupRelationship</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>false</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Created By</Label>

<Length i:nil="true"/>

<Name>CreatedById</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName>Account2</RelationshipName>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>DateTime</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>false</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Creation Date</Label>

<Length i:nil="true"/>

<Name>CreationDate</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName/>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>LookupRelationship</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>false</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Modified By</Label>

<Length i:nil="true"/>

<Name>ModifiedById</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName>Account3</RelationshipName>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>DateTime</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>
<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>false</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Modification Date</Label>

<Length i:nil="true"/>

<Name>ModificationDate</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName/>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

<FieldDescriptor>

<ClrValIfLkUpDel>false</ClrValIfLkUpDel>

<DataType>Checkbox</DataType>

<DecimalPlaces i:nil="true"/>

<DefaultValue/>

<DisplayFormat/>

<IsAlphabeticallySorted>false</IsAlphabeticallySorted>

<IsCaseSensitive>false</IsCaseSensitive>

<IsCustom>false</IsCustom>

<IsDeletable>false</IsDeletable>

<IsEditable>false</IsEditable>

<IsRequired>true</IsRequired>

<IsUnique>false</IsUnique>

<Label>Is Deleted</Label>

<Length i:nil="true"/>

<Name>IsDeleted</Name>

<PicklistValues i:nil="true"/>

<Prefix/>

<RelatedToObject i:nil="true"/>

<RelationshipName/>

<StartingNumber i:nil="true"/>

<Suffix/>

<VisibleLinesNb i:nil="true"/>
</FieldDescriptor>

</Fields>

<Icon/>

<IsCustom>true</IsCustom>

<IsDeletable>true</IsDeletable>

<IsEditable>true</IsEditable>

<Label>Account</Label>

<PluralLabel>Accounts</PluralLabel>

</ObjectDescriptor>

How can we help?