Database.com Metadata API Developer's Guide - Salesforce.com

More documents

Recommendations

Info

GlossaryClient AppAn app that runs outside the Database.com user interface and uses only the Force.com API or Bulk API. It typicallyruns on a desktop or mobile device. These apps treat the platform as a data source, using the development model ofwhatever tool and platform for which they are designed. See also Composite App and Native App.Component, MetadataA component is an instance of a metadata type in the Metadata API. For example, CustomObject is a metadata typefor custom objects, and the MyCustomObject__c component is an instance of a custom object. A component isdescribed in an XML file and it can be deployed or retrieved using the Metadata API, or tools built on top of it, suchas the Force.com IDE or the Force.com Migration Tool.Controlling FieldAny standard or custom picklist or checkbox field whose values control the available values in one or more correspondingdependent fields.Custom FieldA field that can be added in addition to the standard fields to customize Database.com for your organization’s needs.Custom LinksCustom links are URLs defined by administrators to integrate your Database.com data with external websites andback-office systems. Formerly known as Web links.Custom ObjectDDatabaseCustom records that allow you to store information unique to your organization.An organized collection of information. The underlying architecture of Database.com includes a database where yourdata is stored.Database TableA list of information, presented with rows and columns, about the person, thing, or concept you want to track. See alsoObject.Data Manipulation Language (DML)An Apex method or operation that inserts, updates, or deletes records from Database.com.Decimal PlacesParameter for number, currency, and percent custom fields that indicates the total number of digits you can enter to theright of a decimal point, for example, 4.98 for an entry of 2. Note that the system rounds the decimal numbers you enter,if necessary. For example, if you enter 4.986 in a field with Decimal Places of 2, the number rounds to 4.99.Database.com uses the round half-up rounding algorithm. Half-way values are always rounded up. For example, 1.45is rounded to 1.5. –1.45 is rounded to –1.5.Dependent FieldAny custom picklist or multi-select picklist field that displays available values based on the value selected in itscorresponding controlling field.Developer ForceThe Developer Force website at developer.force.com provides a full range of resources for platform developers, includingsample code, toolkits, an online developer community, and the ability to obtain limited Force.com platform environments.180
GlossaryEEnterprise WSDLA strongly-typed WSDL for customers who want to build an integration with their Database.com organization only,or for partners who are using tools like Tibco or webMethods to build integrations that require strong typecasting. Thedownside of the Enterprise WSDL is that it only works with the schema of a single Database.com organization becauseit is bound to all of the unique objects and fields that exist in that organization's data model.Entity Relationship Diagram (ERD)A data modeling tool that helps you organize your data into entities (or objects, as they are called in the Force.complatform) and define the relationships between them. ERD diagrams for key Database.com objects are published in theSOAP API Developer's Guide.Enumeration FieldFFieldAn enumeration is the WSDL equivalent of a picklist field. The valid values of the field are restricted to a strict set ofpossible values, all having the same data type.A part of an object that holds a specific piece of information, such as a text or currency value.Field-Level SecuritySettings that determine whether fields are hidden, visible, read only, or editable for users.Filter Condition/CriteriaCondition on particular fields that qualifies items to be included in a list view or report, such as “State equals California.”Foreign KeyA field whose value is the same as the primary key of another table. You can think of a foreign key as a copy of a primarykey from another table. A relationship is made between two tables by matching the values of the foreign key in one tablewith the values of the primary key in another.Formula FieldA type of custom field. Formula fields automatically calculate their values based on the values of merge fields, expressions,or other values.FunctionGBuilt-in formulas that you can customize with input parameters. For example, the DATE function creates a date fieldtype from a given year, month, and day.Gregorian YearHA calendar based on a 12-month structure used throughout much of the world.HTTP DebuggerAn application that can be used to identify and inspect SOAP requests that are sent from the AJAX Toolkit. Theybehave as proxy servers running on your local machine and allow you to inspect and author individual requests.181
Page 1:
Version 30.0: Spring ’14Database.
Page 4 and 5:
Table of ContentsrenameMetadata()..
Page 7 and 8:
GETTING STARTEDChapter 1Understandi
Page 9 and 10:
Understanding Metadata APIDevelopme
Page 11 and 12:
Chapter 2Quick StartThe easiest way
Page 13 and 14:
Quick StartStep 3: Walk Through the
Page 15:
Page 18 and 19:
Page 20 and 21:
USING METADATA APIChapter 3Deployin
Page 22 and 23:
Deploying and Retrieving MetadataSa
Page 24 and 25:
Deploying and Retrieving MetadataSa
Page 26 and 27:
Deploying and Retrieving MetadataMa
Page 28 and 29:
CRUD-Based Metadata DevelopmentNote
Page 30 and 31:
Chapter 5Error HandlingMetadata API
Page 32 and 33:
File-Based Callsdeploy()2. If the c
Page 34 and 35:
File-Based Callsdeploy()NamerunAllT
Page 36 and 37:
File-Based Callsdeploy()if (!deploy
Page 38 and 39:
File-Based CallscancelDeploy()1. Is
Page 40 and 41:
File-Based Callsretrieve()}}// and
Page 42 and 43:
File-Based Callsretrieve()private v
Page 44 and 45:
File-Based Callsretrieve()}} catch
Page 46 and 47:
File-Based CallscheckRetrieveStatus
Page 48 and 49:
Chapter 7CRUD-Based CallsUse the fo
Page 50 and 51:
CRUD-Based Callsupdate()1. Determin
Page 52 and 53:
CRUD-Based CallscreateMetadata()}//
Page 54 and 55:
CRUD-Based CallsreadMetadata()nf.se
Page 56 and 57:
CRUD-Based CallsupdateMetadata()upd
Page 58 and 59:
CRUD-Based CallsdeleteMetadata()Ver
Page 60 and 61:
CRUD-Based CallsrenameMetadata()}if
Page 62 and 63:
Utility CallsdescribeMetadata()desc
Page 64 and 65:
Utility CallsListMetadataQueryRespo
Page 66 and 67:
Result ObjectsAsyncResultNameTypeDe
Page 68 and 69:
Result ObjectsDeployResultNamedonei
Page 70 and 71:
Result ObjectsDeployResultNamestate
Page 72 and 73:
Result ObjectsDeployResultRunTestsR
Page 74 and 75:
Result ObjectsDescribeMetadataResul
Page 76 and 77:
Result ObjectsRetrieveResultEach Re
Page 78 and 79:
Result ObjectsErrorErrorRepresents
Page 80 and 81:
Metadata TypesMetadata TypeMetadata
Page 82 and 83:
Metadata TypesUnsupported Metadata
Page 84 and 85:
Metadata TypesApexTriggerApexTrigge
Page 86 and 87:
Metadata TypesAppMenuField NameFiel
Page 88 and 89:
Metadata TypesCallCenterVersionCall
Page 90 and 91:
Metadata TypesCustomObjectVersionCu
Page 92 and 93:
Metadata TypesCustomObjectField Nam
Page 94 and 95:
Metadata TypesCustomFieldField Name
Page 96 and 97:
Metadata TypesCustomFieldField Name
Page 98 and 99:
Metadata TypesCustomFieldssnThe fir
Page 100 and 101:
Metadata TypesNamedFilter....See Al
Page 102 and 103:
Metadata TypesPicklist (Including D
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Metadata TypesSharingRecalculationr
Page 110 and 111:
Metadata TypesWeblinkDeclarative Me
Page 112 and 113:
Metadata TypesWeblinkField Nameopen
Page 114 and 115:
Metadata TypesMetadata Field TypesF
Page 116 and 117:
Metadata TypesExternalDataSourceFie
Page 118 and 119:
Metadata TypesInstalledPackageInsta
Page 120 and 121:
Metadata TypesLayoutField Namerelat
Page 122 and 123:
Metadata TypesLayoutField Nameunitw
Page 124 and 125:
Metadata TypesLayoutField Namelayou
Page 126 and 127:
Metadata TypesLayoutField Namerelat
Page 128 and 129:
EditOwnerIdEditCurrencyIsoCodeTwoCo
Page 130 and 131:
Metadata TypesMetadatafeedItemTypeC
Page 132 and 133:
Metadata TypesPermissionSetNamename
Page 134 and 135:
Metadata TypesPermissionSetFieldedi
Page 136 and 137: Metadata TypesProfileCustomTabJob_R
Page 138 and 139: Metadata TypesProfileField Nameapex
Page 140 and 141: Metadata TypesProfileField Nameallo
Page 142 and 143: Metadata TypesProfile}// Employees
Page 144 and 145: Metadata TypesQueueFieldsThis metad
Page 146 and 147: Metadata TypesQuickActionField Name
Page 148 and 149: Metadata TypesRemoteSiteSettingDecl
Page 150 and 151: Metadata TypesSamlSsoConfigFieldsFi
Page 152 and 153: Metadata TypesSettingsField Namesam
Page 154 and 155: Metadata TypesActivitiesSettingsFil
Page 156 and 157: Metadata TypesActivitiesSettingsFie
Page 158 and 159: Metadata TypesBusinessHoursSettings
Page 160 and 161: Metadata TypesBusinessHoursSettings
Page 163 and 164: Metadata TypesMobileSettingsFielden
Page 165 and 166: Metadata TypesSecuritySettingsField
Page 167 and 168: Metadata TypesSecuritySettingsField
Page 169 and 170: Metadata TypesSharingRulesFieldsFie
Page 171 and 172: Metadata TypesBaseSharingRuleequals
Page 173 and 174: Metadata TypesCriteriaBasedSharingR
Page 175 and 176: Metadata TypesSiteDotComFieldField
Page 177 and 178: Metadata TypesWorkflowDeclarative M
Page 179 and 180: Metadata TypesWorkflowField Nametar
Page 181 and 182: Metadata TypesWorkflowField Namecri
Page 183 and 184: Metadata TypesWorkflowadmin@acme.co
Page 185: GlossaryA |B |C |D |E |F |G |H |I |
Page 189 and 190: GlossaryMany-to-Many RelationshipA
Page 191 and 192: GlossaryRelationship QueryIn a SOQL
Page 193 and 194: GlossaryVValidation RuleWA rule tha
Page 195 and 196: IndexIndexAAccount Team Roles 16Acc
Page 197: IndexWSC 6WSDL integration 5-6ZZip
show all

Database.com Metadata API Developer's Guide - Salesforce.com

Create successful ePaper yourself

Delete template?

Save as template?