Skip to main content

Get help for ARIS Process Mining functions and services

HTTP extraction from Salesforce

Use the following settings to configure the connection and HTTP extraction for a Salesforce system.

Disclaimer

Any references to third-party applications in this documentation are provided solely for informational purposes. Such references do not constitute any contractual commitment, representation, or warranty of any kind. The information is provided “as is,” and no guarantee is made as to the accuracy, completeness, or currentness of information relating to third-party applications.

Connection

REST-API base URL

https://<your-instance>.salesforce.com

Example

https://<your-instance>.salesforce.com/services/data/vXX.X
https://<your-instance>.salesforce.com/services/data/v65.0
  • Replace <your-instance> with your Salesforce domain.

  • vXX.X refers to the API version (for example, v65.0)

Test-connection resources

Salesforce Developer Edition org:

  • Includes a few sample accounts and contacts.

  • You can also create your own test records easily.

  • GET /services/data/v65.0/query?q=SELECT+Id,Name+FROM+Account+LIMIT+5 (requires authentication)

  • GET /services/data/v65.0/sobjects/Account (requires authentication)

Sample endpoints:

  • /sobjects - works with standard/custom objects

  • /query - runs SOQL queries

  • /search - SOSL search

  • /composite - batch or chained requests

Supported authentication methods

  • OAuth 2.0 (client credentials)

    Required tokens:

    • Consumer Key (client_id)

    • Consumer Secret (client_secret)

    • Salesforce domain/instance URL

    • Token endpoint (OAuth URL)

      Tip

      Use the App Manager in the Salesforce Setup to create an external client App (for API access). Enable OAuth, select OAuth scopes, and create a Consumer key (Client ID) and Secret (Client secret) for the created external client app. Use the domain name from the Setup, client ID, and client secret to configure the connection.

      For more information on using the Salesforce Setup, please refer to the Salesforce documentation.

  • Bearer Token

    Tip

    We recommend not to enable Bearer Tokens as a separate setting on the Salesforce setup page. Instead, configure an OAuth client as mentioned above that issues these tokens. Use the tokens to configure the connection.

Permissions or scopes

Scope / Permission

Purpose

api

Access Salesforce APIs

full

Full access to all data

read

Read-only access

Extraction

Supported API Endpoints

Resource type

Endpoint

Method

Required parameters

Sample response

Accounts

/services/data/vXX.X/sobjects/Account

GET

fields, limit

{ "Id": "001xx000003DGbYAAW", "Name": "Acme Corporation" }

Contacts

/services/data/vXX.X/sobjects/Contact

GET

fields, limit

{ "Id": "003xx000004TmiQAAS", "FirstName": "John", "LastName": "Doe" }

Opportunities

/services/data/vXX.X/sobjects/Opportunity

GET

fields, limit

{ "Id": "006xx000003DGbYAAW", "Name": "New Deal", "StageName": "Prospecting" }

Query (SOQL)

/services/data/vXX.X/query?q=SELECT+Id,Name+FROM+Account

GET

q (SOQL query string)

{ "totalSize": 1, "records": [ { "Id": "001xx000003DGbYAAW", "Name": "Acme Corporation" } ] }

Search (SOSL)

/services/data/vXX.X/search?q=FIND+{Acme}

GET

q (SOSL query string)

{ "searchRecords": [ { "Id": "001xx000003DGbYAAW", "Name": "Acme Corporation" }

Pagination

  • Parameters:

    nextRecordsUrl in response for next page.

  • Max page size:

    Default: 2000 records per query.

Feature

Description

Pagination type

Server-driven pagination using nextRecordsUrl (Recommended & Easiest)

Initial request

GET /services/data/vXX.X/query?q=SELECT Id, Name FROM Account ORDER BY Id LIMIT 200

Sample response

                                 json<br>{<br> "totalSize": 12345,<br> "done": false,<br> "records": [ ...200 records... ],<br> "nextRecordsUrl": "/services/data/vXX.X/query/01g5g00000ABCDeEAL-200"<br>}
                              

Next page request

Use nextRecordsUrl from response:

GET /services/data/vXX.X/query/01g5g00000ABCDeEAL-200

Pagination logic

Continue calling nextRecordsUrl until "done": true

Page size control

Controlled by SOQL LIMIT clause (for example, LIMIT 200)

Limitations and known issues

Rate limits

  • Daily API requests:

    Typically 100,000 per 24 hours (varies by edition).

  • Concurrent requests:

    Limited to 20 per org.

Data freshness

  • Real-time for most objects; some derived reports may have slight delays.

Unsupported features

  • Bulk extraction via REST is limited; use Bulk API for large data sets.

Known Bugs or API instabilities

  • Occasionally, queryMore fails if session expires mid-pagination.