SAP Help Portal
SAP Open Connectors
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Objects
OCNQL
IT and Security
Bulk
Events
Best Practices
Table of Contents
Table of Contents
Toggle navigation
SAP Open Connectors
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Objects
OCNQL
IT and Security
Bulk
Events
Best Practices
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Objects
OCNQL
IT and Security
Bulk
Events
Best Practices
Home
Glossary
Getting Started
Get to Know SAP Open Connectors
Take a Tour
Resources
Platform Reference
API Reference
Accounts
Base /accounts APIs
GET /accounts
GET /accounts/{id}
POST /accounts
PATCH /accounts/{id}
DELETE /accounts/{id}
GET /accounts
Account Level Common Objects APIs
GET /accounts/.../definitions
Retrieve Account-Level Fields from a Specific Account Resource
Create One or More New Account Resources
Create a New Account Resource
PUT /accounts/.../{objectName}/definitions
Delete all Account-Level Fields in Account Resources
DELETE /accounts/objects/{objectName}/definitions
PATCH /accounts/objects/{{objectName}}
Account Level Transformation APIs
List Account-Level Transformations by Connector
GET /accounts/{id}/elements/{keyOrId}/transformations/{objectName}
Create a Default Transformation
Replace a Default Transformation
Delete All Account Transformations for a Specific Connector
Delete Account Transformations for an Account Resource
Connector and Formula Instance Account APIs
List Connector Instances
List Formula Instances
Account Level Users APIs
GET /accounts/{id}/users
Retrieve a User by Id or Email
Create Account Users
Update Account Users
Delete Account Users
Audit Logs
List API Request Logs
List Authentication API Request Logs
List Common Objects API Request Logs
GET /audit-logs/common-resources/{commonResourceName}
List Connector Instance API Request Logs
Retrieve the Logs of a Specific Connector Instance
List Connector API Request Logs
Retrieve the Logs of a Specific Connector
List Formula Instance API Request Logs
List Formula API Request Logs
Retrieve the Formula Template Logs of a Specific Trigger, Step, or Configuration
Connectors
List Connector
Retrieve the OpenAPI Schema
GET /elements/{id}/metadata
Retrieve a Specific Connector
GET /elements/{keyOrId}/instances
Create a Connector Instance
Organizations
Base /organizations APIs
Retrieve Organization
Update Organization Name
Organization Level Common Resource APIs
List Organization Level Common Objects
Retrieve a Specific Organization Resource
Create a New Organization Resource
POST /organizations/objects/{objectName}/definitions
Replace Fields in a Specific Organization Resource
Delete all Resources in an Organization
Delete a Specific Organization Resource
Change the Name of an Organization Resource
Organization Level Transformation APIs
List Organization-Level Transformations by Connector
Retrieve Transformations for a Specific Organization Resource
Create a Default Organization-Level Transformation
Replace a Default Organization-Level Transformation
Delete All Organization Transformations for a Specific Connector
Delete Organization Transformations for a CO
Organization Level Users APIs
List Organization Users
Retrieve a User by Id or Email
Create Organization Users
Update Organization Users
Delete Organization Users
Users
Manage Users APIs
List Users
Retrieve a User by Id or Email
Update Users
Delete a User
Roles
Retrieve a User's Roles and Privileges
Revoke a Role from a User
Assign a Role to a User
Instances
Create an Connector Instance
Change the Name of a CO
Discovery APIs
List Connector Objects
GET /hubs/{hubName}/objects (v2)
Retrieve the Open API Specifications (API docs) for an Object
GET /hubs/{hubName}/objects/{objectName}/metadata
User Profile
Authorization Headers, Organization Secret, and User Secret
Error Codes
Pagination
Base URLs and Data Centers
Usage Limits
FAQ
What data does SAP Open Connectors store?
How do I reset my password?
How Does Cursor Pagination Work?
Do I need to refresh the SAP Open Connectors Tokens?
What is a connector token and how do I find it?
What is a connector instance?
Resources and Terminology
Release Notes
Production Release Notes
Production Release Notes - Version v2.208.1901
Production Release Notes - Version vhotfix-ENG-2384-stg
Production Release Notes - Version v2.208.1827
Production Release Notes - Version vhotfix-ENG-2109
Production Release Notes - Version vhotfix-ENG-1344-2
Production Release Notes - Version v2.208.1803
Production Release Notes - Version v2.208.1794
Production Release Notes - Version v2.208.1771
Production Release Notes - Version v2.208.1754
Production Release Notes - Version v2.208.1741
Production Release Notes - Version v2.208.1696
Production Release Notes - Version v2.208.1683
Production Release Notes - Version vhotfix-ENG-804
Production Release Notes - Version v2.208.1644
Production Release Notes - Version v2.208.1630
Production Release Notes - Version vhotfix-ENG-345
Production Release Notes - Version vhotfix-CU-1084
Production Release Notes - Version vhotfix-EL-8104
Production Release Notes - Version vhotfix-SRE-673
Production Release Notes - Version v2.208.1537
Production Release Notes - Version vhotfix-SDR-3374_branch
Production Release Notes - Version vhotfix-EL-7869
Production Release Notes - Version v2.208.1477
Production Release Notes - Version v2.208.1455
Production Release Notes - Version v2.208.1443
Production Release Notes - Version vhotfix-EL-7657
Production Release Notes - Version v2.208.1410
Production Release Notes - Version v2.208.1395
Production Release Notes - Version v2.208.1385
Production Release Notes - Version vhotfix-EL-7239
Production Release Notes - Version vhotfix-SDR-3036
Production Release Notes - Version vhotfix-SDR-2944
Production Release Notes - Version v2.208.1332
Production Release Notes - Version v2.208.1289
Production Release Notes - Version v2.208.1277
Production Release Notes - Version v2.208.1264
Production Release Notes - Version v2.208.1257
Production Release Notes - Version vhotfix-EL-6234
Production Release Notes - Version vhotfix-EL-6164
Production Release Notes - Version v2.208.1199
Production Release Notes - Version v2.208.1179
Production Release Notes - Version v2.208.1166
Production Release Notes - Version vhotfix-EL-5823
Production Release Notes - Version v2.208.1136
Production Release Notes - Version v2.208.1126
Production Release Notes - Version v2.208.1116
Production Release Notes - Version v2.208.1093
Production Release Notes - Version v2.208.1048
Production Release Notes - Version vhotfix-EL-5156-2
Production Release Notes - Version vhotfix-EL-5310
Production Release Notes - Version v2.208.1045
Production Release Notes - Version v2.208.1012
Production Release Notes - Version v2.208.1002
Production Release Notes - Version v2.208.988
Production Release Notes - Version v2.208.960
Production Release Notes - Version v2.208.956
Production Release Notes - Version v2.208.940
Production Release Notes - Version v2.208.930
Production Release Notes - Version v2.208.903
Production Release Notes - Version v1867
Production Release Notes - Version v2.208.856
Production Release Notes - Version v2.208.841
Production Release Notes - Version vEL3450
Production Release Notes - Version v2.208.756
Production Release Notes - Version v2.208.746
Production Release Notes - Version SDR1109
Production Release Notes - Version v2.208.628
Production Release Notes - Version v2.208.584
Production Release Notes - Version v2.208.570
Production Release Notes - Version v2.208.529
Production Release Notes - Version v2.208.498
Production Release Notes - Version v2.208.405
Production Release Notes - Version vPR1134
Production Release Notes - Version vRVCL1062
Production Release Notes - Version v2.208.307
Production Release Notes - Version v2.208.229
Production Release Notes - Version v2.208.195
Production Release Notes - Version v2.208.162
Production Release Notes - Version v2.208.119
Production Release Notes - Version v2.208.78.2
Production Release Notes - Version v2.208.45
Production Release Notes - Version v2.208.6
Production Release Notes - Version 2.207
Production Release Notes - Version v.EL2134
Release Notes - Version 2.206
Release Notes - Version 2.205
Release Notes - Version 2.204
Release Notes - Version 2.203
Release Notes - Version 2.202
Release Notes - Version 2.201
Staging Release Notes
Staging Release Notes - Version v2.208.1901
Staging Release Notes - Version v2.208.1908
Staging Release Notes - Version v2.208.1827
Staging Release Notes - Version v2.208.1820
Staging Release Notes - Version v2.208.1811
Staging Release Notes - Version v2.208.1803
Staging Release Notes - Version v2.208.1788
Staging Release Notes - Version v2.208.1778
Staging Release Notes - Version v2.208.1777
Staging Release Notes - Version 2.207
Staging Release Notes - Version v2.208.1760
Staging Release Notes - Version v2.208.1754
Staging Release Notes - Version v2.208.1741
Staging Release Notes - Version v2.208.1721
Staging Release Notes - Version v2.208.1719
Staging Release Notes - Version v2.208.1696
Staging Release Notes - Version v2.208.1682
Staging Release Notes - Version v2.208.1671
Staging Release Notes - Version v2.208.1644
Staging Release Notes - Version v2.208.1636
Staging Release Notes - Version v2.208.1630
Staging Release Notes - Version v2.208.1620
Staging Release Notes - Version v2.208.1609
Staging Release Notes - Version v2.208.1575
Staging Release Notes - Version v2.208.1565
Staging Release Notes - Version v2.208.1537
Staging Release Notes - Version v2.208.1531
Staging Release Notes - Version v2.208.1519
Staging Release Notes - Version v2.208.1514
Staging Release Notes - Version v2.208.1493
Staging Release Notes - Version v2.208.1477
Staging Release Notes - Version v2.208.1471
Staging Release Notes - Version v2.208.1455
Staging Release Notes - Version v2.208.1443
Staging Release Notes - Version v2.208.1437
Staging Release Notes - Version v2.208.1417
Staging Release Notes - Version vhotfix-SDR-3177-staging
Staging Release Notes - Version v2.208.1409
Staging Release Notes - Version v2.208.1395
Staging Release Notes - Version v2.208.1381
Staging Release Notes - Version v2.208.1361
Staging Release Notes - Version v2.208.1349
Staging Release Notes - Version v2.208.1340
Staging Release Notes - Version v2.208.1332
Staging Release Notes - Version v2.208.1331
Staging Release Notes - Version v2.208.1323
Staging Release Notes - Version v2.208.1303
Staging Release Notes - Version v2.208.1289
Staging Release Notes - Version v2.208.1277
Staging Release Notes - Version v2.208.1264
Staging Release Notes - Version v2.208.1253
Staging Release Notes - Version v2.208.1235
Staging Release Notes - Version vhotfix-EL-6380
Staging Release Notes - Version vhotfix-ENGG-7
Staging Release Notes - Version v2.208.1216
Staging Release Notes - Version v2.208.1204
Staging Release Notes - Version v2.208.1196
Staging Release Notes - Version v2.208.1175
Staging Release Notes - Version v2.208.1166
Staging Release Notes - Version v2.208.1164
Staging Release Notes - Version v2.208.1150
Staging Release Notes - Version v2.208.1136
Staging Release Notes - Version vhotfix-EL-5549
Staging Release Notes - Version v2.208.1106
Staging Release Notes - Version v2.208.1089
Staging Release Notes - Version v2.208.1075
Staging Release Notes - Version v2.208.1070
Staging Release Notes - Version v2.208.1058
Staging Release Notes - Version v2.208.1048
Staging Release Notes - Version v2.208.1042
Staging Release Notes - Version v2.208.1012
Staging Release Notes - Version v2.208.988
Staging Release Notes - Version v2.208.978
Staging Release Notes - Version v2.208.967
Staging Release Notes - Version v2.208.960
Staging Release Notes - Version v2.208.956
Staging Release Notes - Version v2.208.940
Staging Release Notes - Version v2.208.930
Staging Release Notes - Version v2.208.926
Staging Release Notes - Version v2.208.903
Staging Release Notes - Version v2.208.889
Staging Release Notes - Version v2.208.875
Staging Release Notes - Version v2.208.849
Staging Release Notes - Version v2.208.841
Staging Release Notes - Version v2.208.834
Staging Release Notes - Version v2.208.806
Staging Release Notes - Version v2.208.781
Staging Release Notes - Version v2.208.761
Staging Release Notes - Version v2.208.756
Staging Release Notes - Version v2.208.746
Staging Release Notes - Version v2.208.744
Staging Release Notes - Version v2.208.739
Staging Release Notes - Version v2.208.708
Staging Release Notes - Version v2.208.694
Staging Release Notes - Version v2.208.663
Staging Release Notes - Version v2.208.645
Staging Release Notes - Version v2.208.628
Staging Release Notes - Version v2.208.620
Staging Release Notes - Version v2.208.568
Staging Release Notes - Version v2.208.540
Staging Release Notes - Version v2.208.529
Staging Release Notes - Version v2.208.527
Staging Release Notes - Version v2.208.508
Staging Release Notes - Version v2.208.498
Staging Release Notes - Version v2.208.484
Staging Release Notes - Version v2.208.464
Staging Release Notes - Version v2.208.441
Staging Release Notes - Version v2.208.405
Staging Release Notes - Version v2.208.393
Staging Release Notes - Version v2.208.379
Staging Release Notes - Version v2.208.354
Staging Release Notes - Version v2.208.344
Staging Release Notes - Version v2.208.328
Staging Release Notes - Version v2.208.307
Staging Release Notes - Version v2.208.297
Staging Release Notes - Version v2.208.282
Staging Release Notes - Version v2.208.259
Staging Release Notes - Version v2.208.242
Staging Release Notes - Version v2.208.229
Staging Release Notes - Version v2.208.218
Staging Release Notes - Version v2.208.205
Staging Release Notes - Version v2.208.194
Staging Release Notes - Version v2.208.176
Staging Release Notes - Version v2.208.139
Staging Release Notes - Version v2.208.119
Staging Release Notes - Version v2.208.100
Staging Release Notes - Version v2.208.78
Staging Release Notes - Version v2.208.45
Staging Release Notes - Version v2.208.6
Staging Release Notes - Version 2.207
Release Notes - Version 2.206
Release Notes - Version 2.205
Release Notes - Version 2.204
Release Notes - Version 2.203
Release Notes - Version 2.202
Release Notes - Version 2.201
Release Notes - Version 2.200
Connectors
Connectors Catalog
Working with Connectors
Introduction to Connectors
View Connector API Docs
Import and Export Connectors
Authenticate a Connector Instance (UI)
Authenticate a Connector Instance with Events (UI)
Authenticate a Connector Instance (API)
Authenticate a Connector Instance with Events (API)
About Authenticating Connector Instances
Sandbox Procurement
Shopify Sandbox
Dynamics 365 Operations Sandbox
Magento 2.0 Sandbox
Amazon Marketplace
Knowledgebase
Revoking an OAuth Token and Reauthenticating an Connector Instance
Google Drive - What ID Can Be Used To Get The Root Folder of Documents Hub Connectors?
Disabling and Enabling Connector Instances
Using JSON with an XML-only Service
Connectwise - How to Set Incident Priority
Salesforce Sales Cloud - Querying Numeric Fields
Marketo: Error Handling for Failure to Create Duplicate Leads
Microsoft Dynamics CRM - 500 Errors While Authenticating a Connector Instance
How to Export an Element Instance
Quickbooks Online - Uploading Invoice Attachments
How to get your bulk call back in gzip format
Dropbox - Creating New File Links
Adobe Sign - Troubleshooting Provisioning Through the UI
Resetting 2FA Phone Number via API
File Compression for Streaming Data Download
OAuth Proxies
How to Use OAuth Proxies with SAP Open Connectors
Callback URLs for OAuth Proxies
Authentication
Automatic Disabling of Connector Instances after Failed Token Refresh
Formulas
Formula Template
Build Formula Templates
Formula Triggers
Formula Step Types
Formula Variables
Formula Template Examples
Formula Instances
Create Formula Instances
Formula as a Resource (FaaR)
Use a Formula as a Resource
Knowledgebase
Javascript in Formulas
How to Use Bulk Within a Formula
Retrying with amqpRequest Step
How can I pass data between formula steps?
Can you send notifications to a webhook in a formula step?
Automatic Cleanup of Temporary Formula Instances
Replaying Formula Executions Via API
Formula Data Context Example
Searching Formula Executions
Formulas - How to Aggregate Loop Step Results
Formula Instance Deactivation Criteria
Introduction to Formulas
Common Objects
Defining Common Objects and Transformations
Introduction to Common Objects
Creating and Managing Common Objects
Mapping and Transforming Fields
Transforming COs Fields with the API
Migrating Resources and Transformations Between Environments
Using Custom JS to Make an HTTP Request
Using Common Resource Templates
Knowledgebase
Custom JavaScript Transformations on Common Objects
How Can I Retrieve all the Field Levels of my Transformation?
How do I Create a Transformation with an Array?
Exporting and Importing Transformations and Objects between Environments
How to Properly Export your Transformation using SAP Open Connectors
JS Transformations: How Do I Use the transformedObject Variable?
How can Sub-resources be Transformed?
What API can be used to update an existing transformation?
Common Objects V2 Engine
Introducing Common Objects v2 Engine
Common Objects UI and Automapper
Common Objects Automapper Templates
Common Objects Sharing
Common Objects Tracelogging
OCNQL
Querying with OCNQL
How Do You Escape Spaces in Field Names When Querying
IT and Security
Configuring Single Sign-On (SSO)
Identity Access Management
Organizations, Accounts, and Users Overview
Accounts and Users
Manage Accounts
Manage Users
Roles
Manage Roles
Role-Based Access Control to Connector Instances
Role-Based Connector Listing
Security
Manage Security Settings
Data Protection & Privacy
Data Protection and Privacy Overview
Encryption Key Management
Data Backups and Collections
Access Control
Access Control Overview
Bulk
About Bulk
Using Bulk
Troubleshooting Bulk
Best Practices for Bulk Queries
Retrieving Bulk Results with Special Characters
Events
Working with Events
Events Overview
Authenticate a Connector Instance with Events (UI)
Authenticate a Connector Instance with Events (API)
Triggering Events
Hash Verification
Knowledgebase
Event Retry and Queueing
Asynchronous API Requests
What Should You Check if Your Poller Returns No Events
Reset Last Poll Date
Why Would a Polling Job Fail to Return Events?
How to add filtering to Event Polling configurations
Configure Polling Interval at Resource Level
Resuming Polling Jobs after Auto-Disable
Best Practices
Getting the Most Recent Version of Swagger
Clearing UI Local Storage
How the Instance Configuration of "filter.response.nulls" Works
Troubleshooting Issues in SAP
Monitor the Health of Connectors
Custom Objects and Dynamic APIs
Configuring your System to Allow Access through a Range of IPs (Safelisting)
Home
Connectors
Knowledgebase
Revoking an OAuth Token and Reauthenticating an Connector Instance
Google Drive - What ID Can Be Used To Get The Root Folder of Documents Hub Connectors?
Disabling and Enabling Connector Instances
Using JSON with an XML-only Service
Connectwise - How to Set Incident Priority
Marketo: Error Handling for Failure to Create Duplicate Leads
Salesforce Sales Cloud - Querying Numeric Fields
Microsoft Dynamics CRM - 500 Errors While Authenticating a Connector Instance
How to Export an Element Instance
Quickbooks Online - Uploading Invoice Attachments
How to get your bulk call back in gzip format
Dropbox - Creating New File Links
Adobe Sign - Troubleshooting Provisioning Through the UI
Resetting 2FA Phone Number via API
File Compression for Streaming Data Download