mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 00:02:34 +08:00
122 lines
8.2 KiB
JSON
122 lines
8.2 KiB
JSON
|
{
|
|||
|
|
"sections": [
|
|||
|
|
"title",
|
|||
|
|
"description",
|
|||
|
|
"fields",
|
|||
|
|
"special_access_rules",
|
|||
|
|
"usage",
|
|||
|
|
"associated_objects",
|
|||
|
|
"wsdl_segment",
|
|||
|
|
"field_reference"
|
|||
|
|
],
|
|||
|
|
"title": "BriefcaseDefinition - Data API",
|
|||
|
|
"description": "Represents a briefcase definition. A briefcase makes selected records available for users to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This object is available in API version 50.0 and later.",
|
|||
|
|
"fields_columns": [
|
|||
|
|
"type",
|
|||
|
|
"properties",
|
|||
|
|
"description"
|
|||
|
|
],
|
|||
|
|
"fields": {
|
|||
|
|
"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. Limited to 80 characters. Label is Name. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
|
|||
|
|
},
|
|||
|
|
"IsActive": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"properties": "Defaulted on create, Filter, Group, Sort",
|
|||
|
|
"description": "Indicates whether the briefcase is available for use (true) or not (false). Label is Active."
|
|||
|
|
},
|
|||
|
|
"Language": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Filter, Group, 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: Chinese (Simplified): zh_CN Chinese (Traditional): zh_TW Danish: da Dutch: nl_NL English: en_US Finnish: fi French: fr German: de Italian: it Japanese: ja Korean: ko Norwegian: no Portuguese (Brazil): pt_BR Russian: ru Spanish: es Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. Swedish: sv Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English."
|
|||
|
|
},
|
|||
|
|
"MasterLabel": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Sort",
|
|||
|
|
"description": "The master label for the briefcase. This internal label doesn’t get translated. Limited to 80 characters."
|
|||
|
|
},
|
|||
|
|
"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."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"special_access_rules": "This object is read-only.",
|
|||
|
|
"usage": "Use this object to query a briefcase or a list of briefcases with selected records and user assignments. For example:\n\nSELECT Id, Description FROM BriefcaseDefinition\n\nWHERE Id in (SELECT BriefcaseId FROM BriefcaseRule\n\nWHERE TargetEntity='Account')\n\nAND Id in (SELECT BriefcaseId FROM BriefcaseAssignment where UserOrGroupId='00GR0000000VtwUMAS')",
|
|||
|
|
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **BriefcaseDefinitionChangeEvent (API version 55.0)**: Change events are available for the object.",
|
|||
|
|
"wsdl_segment": "```xml\n<complexType name=\"BriefcaseDefinition\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"BriefcaseRules\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Briefcases\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n```",
|
|||
|
|
"field_reference": {
|
|||
|
|
"CreatedById": {
|
|||
|
|
"field_label": "Created By ID",
|
|||
|
|
"type": "reference",
|
|||
|
|
"length": "18"
|
|||
|
|
},
|
|||
|
|
"CreatedDate": {
|
|||
|
|
"field_label": "Created Date",
|
|||
|
|
"type": "datetime"
|
|||
|
|
},
|
|||
|
|
"Description": {
|
|||
|
|
"field_label": "Description",
|
|||
|
|
"type": "textarea",
|
|||
|
|
"length": "1024"
|
|||
|
|
},
|
|||
|
|
"DeveloperName": {
|
|||
|
|
"field_label": "Name",
|
|||
|
|
"type": "string",
|
|||
|
|
"length": "80"
|
|||
|
|
},
|
|||
|
|
"Id": {
|
|||
|
|
"field_label": "Briefcase Definition ID",
|
|||
|
|
"type": "id",
|
|||
|
|
"length": "18"
|
|||
|
|
},
|
|||
|
|
"IsActive": {
|
|||
|
|
"field_label": "Active",
|
|||
|
|
"type": "boolean"
|
|||
|
|
},
|
|||
|
|
"IsDeleted": {
|
|||
|
|
"field_label": "Deleted",
|
|||
|
|
"type": "boolean"
|
|||
|
|
},
|
|||
|
|
"Language": {
|
|||
|
|
"field_label": "Master Language",
|
|||
|
|
"type": "picklist",
|
|||
|
|
"length": "40"
|
|||
|
|
},
|
|||
|
|
"LastModifiedById": {
|
|||
|
|
"field_label": "Last Modified By ID",
|
|||
|
|
"type": "reference",
|
|||
|
|
"length": "18"
|
|||
|
|
},
|
|||
|
|
"LastModifiedDate": {
|
|||
|
|
"field_label": "Last Modified Date",
|
|||
|
|
"type": "datetime"
|
|||
|
|
},
|
|||
|
|
"MasterLabel": {
|
|||
|
|
"field_label": "Master Label",
|
|||
|
|
"type": "string",
|
|||
|
|
"length": "80"
|
|||
|
|
},
|
|||
|
|
"NamespacePrefix": {
|
|||
|
|
"field_label": "Namespace Prefix",
|
|||
|
|
"type": "string",
|
|||
|
|
"length": "15"
|
|||
|
|
},
|
|||
|
|
"SystemModstamp": {
|
|||
|
|
"field_label": "System Modstamp",
|
|||
|
|
"type": "datetime"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"field_reference_columns": [
|
|||
|
|
"field_label",
|
|||
|
|
"type",
|
|||
|
|
"length"
|
|||
|
|
]
|
|||
|
|
}
|