- URL:
« /RestApi/DescribeAll?authToken=<authToken> »
- Method: GET
- URL Params:
- authToken [string] [Required]=the authentication token
- Success Response:
- Status Code=200 (OK)
- Returned Data [in XML or JSON]=a list of all the objects of the user organization
- Error Response:
- Status Code=401 (Unauthorized) (in case of a wrong authentication token)
Example of returned data (in xml format):
<?xml version="1.0"?>
<ArrayOfObjectDescriptor>
<ObjectDescriptor>
<APIName>Organization</APIName>
<Fields i:nil="true"/>
<Icon/>
<IsCustom>false</IsCustom>
<IsDeletable>false</IsDeletable>
<IsEditable>true</IsEditable>
<Label>Organization</Label>
<PluralLabel>Organizations</PluralLabel>
</ObjectDescriptor>
<ObjectDescriptor>
<APIName>UserPosition</APIName>
<Fields i:nil="true"/>
<Icon/>
<IsCustom>false</IsCustom>
<IsDeletable>false</IsDeletable>
<IsEditable>false</IsEditable>
<Label>Position</Label>
<PluralLabel>Positions</PluralLabel>
</ObjectDescriptor>
<ObjectDescriptor>
<APIName>Profile</APIName>
<Fields i:nil="true"/>
<Icon/>
<IsCustom>false</IsCustom>
<IsDeletable>false</IsDeletable>
<IsEditable>false</IsEditable>
<Label>Profile</Label>
<PluralLabel>Profiles</PluralLabel>
</ObjectDescriptor>
<ObjectDescriptor>
<APIName>License</APIName>
<Fields i:nil="true"/>
<Icon/>
<IsCustom>false</IsCustom>
<IsDeletable>true</IsDeletable>
<IsEditable>true</IsEditable>
<Label>License</Label>
<PluralLabel>Licenses</PluralLabel>
</ObjectDescriptor>
<ObjectDescriptor>
<APIName>LoginHistory</APIName>
<Fields i:nil="true"/>
<Icon/>
<IsCustom>false</IsCustom>
<IsDeletable>false</IsDeletable>
<IsEditable>false</IsEditable>
<Label>Login History</Label>
<PluralLabel>Login History</PluralLabel>
</ObjectDescriptor>
<ObjectDescriptor>
<APIName>Account</APIName>
<Fields i:nil="true"/>
<Icon/>
<IsCustom>true</IsCustom>
<IsDeletable>true</IsDeletable>
<IsEditable>true</IsEditable>
<Label>Account</Label>
<PluralLabel>Accounts</PluralLabel>
</ObjectDescriptor>
</ArrayOfObjectDescriptor>