Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

Package

Used to specify metadata components to be retrieved as part of a retrieve() call, or to define a package of components.

Name	Type	Description
apiAccessLevel	APIAccessLevel (enumeration of type string)	Package components have access via dynamic Apex and the API to standard and custom objects in the organization where they are installed. Administrators who install packages may wish to restrict this access after installation for improved security. The valid values are: Unrestricted—Package components have the same API access to standard objects as the user who is logged in when the component sends a request to the API. Restricted—The administrator can select which standard objects the components can access. Further, the components in restricted packages can only access custom objects in the current package if the user's permissions allow access to them. For more information, see “About API and Dynamic Apex Access in Packages” in the Salesforce online help.
description	string	A short description of the package.
fullName	string	The package name used as a unique identifier for API access. 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. This field is inherited from the Metadata component.
namespacePrefix	string	The namespace of the developer organization where the package was created.
objectPermissions	ProfileObjectPermissions[]	Indicates which objects are accessible to the package, and the kind of access available (create, read, update, delete).
setupWeblink	string	The weblink used to describe package installation.
types	PackageTypeMembers[]	The type of component being retrieved.
version	string	Required. The version of the component type.

PackageTypeMembers

Use to specify the name and type of components to be retrieved in a package.

Name	Type	Description
members	string	One or more named components, or the wildcard character (`*`) to retrieve all custom metadata components of the type specified in the `<name>` element. To retrieve a standard object, specify it by name. For example `<members>Account</members>` will retrieve the standard Account object.
name	string	The type of metadata component to be retrieved. For example `<name>CustomObject</name>` will retrieve one or more custom objects as specified in the `<members>` element.