--- schema_version: "1" id: f15b793c3c30981d31bd786e679eae2136000a24c095a1cdadc25acb73510aa1 title: RetrieveResult collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_retrieveresult.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieveresult.htm source_site: developer.salesforce.com content_type: documentation content_hash: 9a5d68ea8f4d319b2cedfbb2b7ea2abcbe1f7918ac06ee4c2ba8a5216d81f03e description: The retrieve() call returns an array of RetrieveResult objects. --- # RetrieveResult The retrieve() call returns an array of RetrieveResult objects. #### See Also - [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm "The retrieve() call retrieves XML file representations of components in an organization.") ## 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()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") 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()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode_topic) in the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/ "HTML (New Window)"). ### fileProperties - **Type**: [FileProperties](#meta_retrieveresult_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](#meta_retrieveresult_retrievemessage)\[\] - **Description**: Contains information about the success or failure of the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") call. ### status - **Type**: RetrieveStatus ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) - **Description**: The status of the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") 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()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") 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](#meta_retrieveresult "The retrieve() call returns an array of RetrieveResult objects.") returns this object, which contains information about the success or failure of the [retrieve()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm#meta_retrieve "The retrieve() call retrieves XML file representations of components in an organization.") 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.