RetrieveResult

The retrieve() call returns an array of RetrieveResult objects.

Fields 

A RetrieveResult object has these fields.

done 

• Type: boolean
• Description: Required. Indicates whether the retrieve() call is completed (true) or not (false). This field is available in API version 31.0 and later.

errorMessage 

• Type: string
• Description: If an error occurs during the retrieve() call, this field contains a descriptive message about this error. This field is available in API version 31.0 and later.

errorStatusCode 

• Type: StatusCode

• Description: If an error occurs during the retrieve() call, this field contains the status code for this error. This field is available in API version 31.0 and later.

  For a description of each StatusCode value, see StatusCode in the SOAP API Developer Guide.

fileProperties 

• Type: FileProperties[]
• Description: Contains information about the properties of each component in the .zip file, and the manifest file package.xml. One object per component is returned.

id 

• Type: ID
• Description: ID of the component being retrieved.

messages 

• Type: RetrieveMessage[]
• Description: Contains information about the success or failure of the retrieve() call.

status 

• Type: RetrieveStatus (enumeration of type string)

• Description: The status of the retrieve() call.

  This field is available in API version 31.0 and later.

• Possible values:

  • Pending
  • InProgress
  • Succeeded
  • Failed

success 

• Type: boolean
• Description: Indicates whether the retrieve() call was successful (true) or not (false). This field is available in API version 31.0 and later.

zipFile 

• Type: base64Binary
• Description: The zip file returned by the retrieve request. Base 64-encoded binary data. Before making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is handled for you by a SOAP client.

FileProperties 

This component contains information about the properties of each component in the .zip file, and the manifest file package.xml. One object per component is returned. This component doesn’t contain information about any associated metadata files in the .zip file, only the component files and manifest file. FileProperties contains the following properties:

createdById 

• Type: string
• Description: Required. ID of the user who created the file.

createdByName 

• Type: string
• Description: Required. Name of the user who created the file.

createdDate 

• Type: dateTime
• Description: Required. Date and time when the file was created.

fileName 

• Type: string
• Description: Required. Name of the file.

fullName 

• Type: string
• Description: Required. The file developer name used as a unique identifier for API access. The value is based on the fileNamebut the characters allowed are more restrictive. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

id 

• Type: string
• Description: Required. ID of the file.

lastModifiedById 

• Type: string
• Description: Required. ID of the user who last modified the file.

lastModifiedByName 

• Type: string
• Description: Required. Name of the user who last modified the file.

lastModifiedDate 

• Type: dateTime
• Description: Required. Date and time that the file was last modified.

manageableState 

• Type: ManageableState (enumeration of type string)

• Description: Indicates the manageable state of the specified component if it’s contained in a package:

  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged

namespacePrefix 

• Type: string
• Description: If any, the namespace prefix of the component.

type 

• Type: string
• Description: Required. The metadata type, such as CustomObject, CustomField, or ApexClass.

RetrieveMessage 

RetrieveResult returns this object, which contains information about the success or failure of the retrieve() call. One object per problem is returned:

fileName 

• Type: string
• Description: The name of the file in the retrieved .zip file where a problem occurred.

problem 

• Type: string
• Description: A description of the problem that occurred.