| Description |
- Type
- textarea
- Properties
- Filter, Nillable, Sort
- Description
- Description of the briefcase definition. Limited to 1024 characters.
|
| DeveloperName |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The unique name of the object in the API. This name can contain only
underscores and alphanumeric characters, and must be unique in your org. It
must begin with a letter, not include spaces, not end with an underscore, and
not contain two consecutive underscores. In managed packages, this field
prevents naming conflicts on package installations. With this field, a
developer can change the object’s name in a managed package and the changes
are reflected in a subscriber’s organization.
|
| FullName |
- Type
- string
- Properties
- Create, Group, Nillable
- Description
- The unique name used as the briefcase definition 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.
- Query this field only if the query result contains no more than one record.
Otherwise, an error is returned. If more than one record exists, use multiple
queries to retrieve the records. This limit protects performance.
|
| IsActive |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the briefcase is available for use (true) or not (false). The default value is false.
|
| Language |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The language for the briefcase. This field defaults to the user's language
unless the org is multi-language enabled. Specifies the language of the labels
returned.
- Possible values are:
-
da—Danish
-
de—German
-
en_US—English
-
es—Spanish
-
es_MX—Spanish (Mexico)
-
fi—Finnish
-
fr—French
-
it—Italian
-
ja—Japanese
-
ko—Korean
-
nl_NL—Dutch
-
no—Norwegian
-
pt_BR—Portuguese
(Brazil)
-
ru—Russian
-
sv—Swedish
-
th—Thai
-
zh_CN—Chinese
(Simplified)
-
zh_TW—Chinese
(Traditional)
|
| ManageableState |
- Type
- ManageableState enumerated list
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates the manageable state of the specified component that is contained
in a package:
- beta
- deleted
- deprecated
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged
|
| MasterLabel |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The unique label for the briefcase definition. This internal label doesn’t
get translated.
|
| Metadata |
- Type
- complexvalue
- Properties
- Create, Nillable, Update
- Description
- The BriefcaseDefinition metadata, which includes rules and rule filters.
Query this field only if the query result contains no more than one record.
Otherwise, an error is returned. If more than one record exists, use multiple
queries to retrieve the records. This limit protects performance.
|
| NamespacePrefix |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The namespace prefix that is associated with this object. Each Developer
Edition org that creates a managed package has a unique namespace prefix.
Limit: 15 characters. You can refer to a component in a managed package by
using the namespacePrefix__componentName
notation.
The namespace prefix can have one of the following values.
- In Developer Edition orgs, NamespacePrefix is set
to the namespace prefix of the org for all objects that support it, unless
an object is in an installed managed package. In that case, the object has
the namespace prefix of the installed managed package. This field’s value
is the namespace prefix of the Developer Edition org of the package
developer.
- In orgs that are not Developer Edition orgs,
NamespacePrefix is set only for objects that are
part of an installed managed package. All other objects have no namespace
prefix.
|
| Type |
- Type
- picklist
- Properties
- Aggregate, Filter, Group, Nillable, Restricted picklist, Sort
- Description
-
-
Standard: Standard briefcase that can be
used with priming APIs.
-
HighVolume: Increased-capacity briefcase
that's used with performance priming in the Salesforce Field Service
mobile app.
-
MobileAppSync: Automatically generated
briefcase that's used for performance priming in the Salesforce Field
Service mobile app.
|
j