REST API Developer Guide - Salesforce
https://resources.docs.salesforce.com/latest/latest/en-us/sfdc/pdf/api_rest.pdf
In this chapter ...SEE ALSO:About REST APISEE ALSO:REST API Release NotesSupported Editions and Required PermissionsSupported Editions for API AccessAPI User PermissionsSEE ALSO:REST Resources and RequestsURIsRequest BodiesSEE ALSO:REST API ArchitectureClient-serverStatelessCaching behaviorUniform interfaceNamed resourcesLayered componentsCross-Origin Resource SharingHTTPSApply an OAuth Authorization FlowMore ResourcesHeadersAssignment Rule HeaderCall Options HeaderCompression HeadersConditional Request HeadersDuplicate Rule HeaderLimit Info HeaderPackage Version HeaderQuery Options HeaderAssignment Rule HeaderField valuesField valuesExampleConditional Request HeadersField valuesField valuesField valuesExampleLimit Info HeaderField valuesPackage Version HeaderField name and valueQuery Options HeaderWarning HeaderSend REST Requests with cURLConfigure Salesforce CORS AllowlistEDITIONSAvailable in: Developer, Enterprise, Performance, and Unlimited EditionsUSER PERMISSIONSStatus Codes and Error ResponsesResource doesn’t existIn this chapter ...Using cURLStep One: Sign up for Salesforce Developer EditionSEE ALSO:Step Two: Set Up AuthenticationOptional Salesforce CLI ShortcutsList My OrgsOpen My OrgDisplay the Access Token for My OrgUse These Commands in a ScriptSee AlsoUsing Other ToolsGetting Information About My OrganizationList Available REST API VersionsList Available REST ResourcesGet a List of ObjectsGet a List of Objects If Metadata Has ChangedList Available REST API VersionsExample usageList Org LimitsList Available REST ResourcesFurther InformationGet a List of ObjectsWorking with Object MetadataGet Metadata for an ObjectGet Field and Other Metadata for an ObjectGet Object Metadata ChangesGet Metadata for an ObjectGet Field and Other Metadata for an ObjectWorking with RecordsCreate a RecordUpdate a RecordDelete a RecordGet Field Values from a Standard Object RecordGet Field Values from an External Object Record by Using the Salesforce IDGet Field Values from an External Object Record by Using the External ID Standard FieldGet a Record Using an External IDInsert or Update (Upsert) a Record Using an External IDTraverse Relationships with Friendly URLsGet a List of Deleted Records Within a Given TimeframeGet a List of Updated Records Within a Given TimeframeCreate a RecordUpdate a RecordDelete a RecordIDGet Field Values from an External Object Record by Using the External ID Standard FieldGet a Record Using an External IDInsert or Update (Upsert) a Record Using an External IDExample JSON request body newrecord.json fileExample JSON request body newrecord.json fileTraverse Relationships with Friendly URLsExample response body for updating relationship recordTraversing Relationships with Multiple RecordsExample response body after successfully deleting eventsConsiderationsWorking with Searches and QueriesExecute a SOQL QueryExecute a SOQL Query that Includes Deleted ItemsGet Feedback on Query Performance (Beta)Search for a StringGet the Default Search Scope and OrderGet Search Result Layouts for ObjectsView Relevant ItemsExecute a SOQL QueryExecute a SOQL Query that Includes Deleted ItemsGet Feedback on Query Performance (Beta)Search for a StringExample SOSL Search Using the GET MethodExample Parameterized Search Using the GET MethodExample Parameterized Search Using the POST MethodGet the Default Search Scope and OrderGet Search Result Layouts for ObjectsExample response bodyView Relevant ItemsGet an Image from a Rich Text Area FieldInserting a Document with Blob DataUpdating a Document with Blob DataInserting a ContentVersionUsing sObject Collections to Insert a Collection of Blob RecordsAttributesMultipart Message ConsiderationsContent-Disposition HeaderContent-Type HeaderNew LineSEE ALSO:Get Blob DataExample response bodyWorking with Recently Viewed InformationView Recently Viewed RecordsMark Records as Recently ViewedView Recently Viewed RecordsMark Records as Recently ViewedManaging User PasswordsManage User PasswordsXML example response body for getting current password expiration statusExample error response if session has insufficient privilegesExample error response if new password does not meet organization password requirementsWorking with Approval Processes and Process RulesGet a List of All Approval ProcessesSubmit a Record for ApprovalApprove a RecordReject a RecordBulk ApprovalsGet a List of Process RulesGet a Particular Process RuleTrigger Process RulesGet a List of All Approval ProcessesSubmit a Record for ApprovalApprove a RecordReject a RecordBulk ApprovalsGet a List of Process RulesGet a Particular Process RuleTrigger Process RulesDescribe Event Monitoring Using RESTQuery Event Monitoring Data with RESTGet Event Monitoring Content from a RecordDelete Event Monitoring DataQuery or View Hourly Event Log FilesDescribe Event Monitoring Using RESTGet Event Monitoring Content from a RecordDelete Event Monitoring DataQuery or View Hourly Event Log FilesEDITIONSExamples Performance, Unlimited, and Developer EditionsUSER PERMISSIONSConsiderationsUsing Composite ResourcesExecute Dependent Requests in a Single API CallUpdate an Account, Create a Contact, and Link Them with a Junction ObjectUpdate a Record and Get Its Field Values in a Single RequestUpsert an Account and Create a ContactCreate Nested RecordsCreate Multiple RecordsUsing Composite GraphsUsing a Composite GraphExecute Dependent Requests in a Single API CallUpdate an Account, Create a Contact, and Link Them with a Junction ObjectUpdate a Record and Get Its Field Values in a Single RequestUpsert an Account and Create a ContactCreate Nested RecordsCreate Multiple RecordsThe AllOrNone ParameterExample: Submitting a Composite Graph JobCase 1: outerFlag = false, innerFlag = falseCase 2: outerFlag = false, innerFlag = trueCase 3: outerFlag = true, innerFlag = true"success" : true,Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)Supported EditionsGiving FeedbackVersionsResources by VersionsObject Basic InformationGet Object Metadata Using sObject Basic InformationCreate Records Using sObject Basic InformationGet Object Metadata Using sObject Basic InformationCreate Records Using sObject Basic InformationExampleSEE ALSO:URIExampleURIExamplesURIsObject RowsExampleExampleSEE ALSO:ExamplesObject Rows by External IDGet Records Using sObject Rows by External IDCreate Records Using sObject Rows by External IDUpsert Records Using sObject Rows by External IDDelete Records Using sObject Rows by External IDReturn Headers Using sObject Rows by External IDGet Records Using sObject Rows by External IDURIUpsert Records Using sObject Rows by External IDURIDelete Records Using sObject Rows by External IDURIReturn Headers Using sObject Rows by External IDURIsObject Blob GetURIURIURIURIURIURIURIsObject LayoutsGet Layouts and Descriptions for a Specified ObjectReturn Layout Headers for a Specified ObjectGet Layouts and Descriptions for a Specified ObjectURIReturn Layout Headers for a Specified ObjectURIsObject Layouts for an Object With Multiple Record TypesGet Layouts and Descriptions for an Object With Multiple Record TypesURIReturn Layout Headers for an Object With Multiple Record TypesURIsObject Global Publisher LayoutsGet Global Publisher Layouts and DescriptionsReturn Headers for All Global Publisher LayoutsGet Global Publisher Layouts and DescriptionsURIReturn Headers for All Global Publisher LayoutsURIURIURIsObject Specific Quick ActionsURIURIURIsObject Quick Action DetailsURIURIsObject Quick Action Default ValuesURIURIsObject Quick Action Default Values by IDURIURIsObject Rich Text Image GetURIGet Records Using sObject RelationshipsUpdate Records Using sObject RelationshipsDelete Records Using sObject RelationshipsURIExampleURIExampleURIDescriptionExamplesObjects Suggested ArticlesURIURIsObject User PasswordURIURIURIURIsObject Self-Service User PasswordURIURIURIURIURIApache Avro FormatApache Avro FormatAppMenu ItemsAppMenu Mobile ItemsAuthenticationDescriptionCompile Consent SettingsActionURICompile Multiple Types of Consent SettingsActionURIUse the Consent API with Data CloudRequired PermissionsData Cloud Read ParametersURIWrite ParametersURI when action is processingURI when action is shouldforgetURI action is portabilityURIActionSecurityExample Response BodyEmbedded Service Configuration DescribeURIURIInvocable ActionsInvocable Actions CustomGet Custom Invocable ActionsInvocable Actions StandardURIURIURIExample Response BodyInput:Output:URIInput:Output:• Data Category DetailAuthenticationInput:Valid channel ValuesValid channel ValuesEndpointParameterized SearchURIAuthenticationsobject-level ParametersAuthenticationdataCategoriesFilter[] ParametersRequest bodyProcess ApprovalsRequest bodyResponse bodyExampleProcess RulesRequest bodyProcess Rule for an sObjectGet a Process Rule for an sObjectTrigger a Process Rule for an sObjectReturn HTTP Headers for a Process Rule of an sObjectGet a Process Rule for an sObjectURITrigger a Process Rule for an sObjectURIReturn HTTP Headers for a Process Rule of an sObjectURIProcess Rule List for an sObjectURIURIURIResources for Executing SOQL QueriesSOQL LimitationsQuery More ResultsResources for Executing SOQL QueriesDescriptionResources for Executing SOQL QueriesQueryAll More ResultsResources for Executing SOQL QueriesResponse bodyResources for Executing SOQL QueriesURIRecently Viewed ItemsURIResponse headerResponse bodyExample Response BodySearchSearch Scope and OrderURIURIExampleURIURIURIURIURISalesforce Scheduler ResourcesGet Appointment SlotsGet Appointment CandidatesSEE ALSO:Get Appointment SlotsURIRequest bodyResponse BodyGet Appointment CandidatesResource AvailabilityResource UnavailabilityWork Type DurationURIRequest bodyResponse BodyRequest BodiesSkill RequirementWork TypeSkill RequirementResponse BodiesTime SlotsCandidatesTime SlotsCandidatesSearch for Records Suggested by Autocomplete and Instant ResultsDescriptionURIDescriptionSearch Suggested Article Title MatchesURISearch Suggested QueriesURISalesforce Surveys Translation ResourcesURIURIURIURIURIResponse dataCompositeSend Multiple Requests Using CompositeGet a List of Composite ResourcesExampleComposite Subrequest ResultComposite Request BodyComposite Collection InputJSON exampleComposite SubrequestRequired or OptionalComposite Subrequest ResultBehavior and Responses If There Are Illegal Characters in Reference IDs"httpStatusCode" : 400,Get a List of Composite ResourcesRequest BodyResponse BodyComposite SubrequestUsageComposite Graph LimitsBatch Request BodyBatch Collection InputSubrequestBatch Response BodysObject Tree Request BodyExample Request BodyURIExample Request BodyURIREST API is one of several web interfaces that you can use to access your Salesforce data without using the Salesforce user interface. With API access, you can perform operations and integrate Salesforce into your applications as you like. You can use REST API tools to create, manipulate, and search data in Salesforce by sending HTTP requests to en...See more on resources.docs.salesforce.com REST API is one of several web interfaces that you can use to access your Salesforce data without using the Salesforce user interface. With API access, you can perform operations and integrate Salesforce into your applications as you like. You can use REST API tools to create, manipulate, and search data in Salesforce by sending HTTP requests to en...
REST API is one of several web interfaces that you can use to access your Salesforce data without using the Salesforce user interface. With API access, you can perform operations and integrate Salesforce into your applications as you like. You can use REST API tools to create, manipulate, and search data in Salesforce by sending HTTP requests to en...
DA: 56 PA: 44 MOZ Rank: 7