Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Describe

Completely describes the object’s metadata at all levels, including fields, URLs, and child relationships.

Parameters

  • API version (string)
  • Object type (string)

iOS

Swift
Delegate Method
1RestClient.shared.requestForDescribe(withObjectType:)
Block Method
1describe(_:onFailure:onSuccess:)
Objective-C
Delegate Method
1- (SFRestRequest *)
2    requestForDescribeWithObjectType:(NSString *)objectType 
3                          apiVersion:(nullable NSString *)apiVersion;
Block Method
1- (SFRestRequest *) performDescribeWithObjectType:(NSString *)objectType 
2	                                 failBlock:(SFRestFailBlock)failBlock 
3	                             completeBlock:(SFRestDictionaryResponseBlock)completeBlock;

Android

Kotlin
1fun getRequestForDescribe(apiVersion: String?, objectType: String?): RestRequest
Java
1public static RestRequest getRequestForDescribe(String apiVersion, String objectType)