SAP Help Portal
SAP Cloud Platform Open Connectors
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Resources
Connector Builder
OCNQL
Bulk
Security
Events
Best Practices
Table of Contents
Table of Contents
Toggle navigation
SAP Cloud Platform Open Connectors
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Resources
Connector Builder
OCNQL
Bulk
Security
Events
Best Practices
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Resources
Connector Builder
OCNQL
Bulk
Security
Events
Best Practices
Home
Glossary
Getting Started
Your First Integration
Connect to Salesforce and Shopify
Map and Transform the Salesforce and Shopify Data to a Single Contact Resource
Set Up a Formula to Sync Salesforce and Shopify Contacts
Get to Know SAP Cloud Platform Open Connectors
Take a Tour
Resources and Terminology
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 Resources 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
List Account-level Transformations by Connector on a Specific Resource
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
List 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 Resources API Request Logs
Retrieve the Logs of a Specific CO
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
Retrieve an Connector's Metadata
Retrieve a Specific Connector
List Authenticated Connector Instances of a Specific Connector
Create a Connector Instance
Organizations
Base /organizations APIs
Retrieve Organization
Update Organization Name
Organization Level Common Resource APIs
List Organization Level Common Resources
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
List Connector Objects and their Sources
Retrieve the Open API Specifications (API docs) for an Object
Retrieve an Connector Object's Metadata
User Profile
Authorization Headers, Organization Secret, and User Secret
Error Codes
Standardized Pagination
Base URLs and Data Centers
Role-Based Access Control to Connector Instances
Upcoming Usage Limits
Usage Limits
FAQ
What data does SAP Cloud Platform Open Connectors store?
How do I reset my password?
How Does Cursor Pagination Work?
Do I need to refresh the SAP Cloud Platform Open Connectors Tokens?
What is a connector token and how do I find it?
What is a connector instance?
Trial Tutorial
Your First Integration in 60 Minutes
Release Notes
Production Release Notes
Production Release Notes - Version 2.207
Production Release Notes - Version v2.208.45
Production Release Notes - Version v2.208.78.2
Production Release Notes - Version v2.208.119
Production Release Notes - Version v2.208.162
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
Production Release Notes - Version v2.208.6
Staging Release Notes
Staging Release Notes - Version vhotfix-EL-5549
Staging Release Notes - Version v2.208.1106
Staging Release Notes - Version 2.207
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.834
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.708
Staging Release Notes - Version v2.208.694
Staging Release Notes - Version v2.208.663
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.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.229
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
Working with Connectors
Introduction to Connectors
View Connector API Docs
Authenticate Connections with API Providers
Import and Export Connectors
Authenticate a Connector Instance (UI)
Authenticate a Connector Instance with Events (UI)
Authenticate a Connector Instance (API)
Authenticate an Connector Instance with Events (API)
Authenticated Connector Instances
Connectors Catalog
Sandbox Procurement
Shopify Sandbox
Dynamics 365 Operations Sandbox
SugarCRM Sandbox
Magento 2.0 Sandbox
Amazon Marketplace
Knowledgebase
How to revoke an OAuth Token, Reauthenticate an Connector Instance
Google Drive - What ID Can Be Used To Get The Root Folder of Documents Hub Connectors?
Disabling and Enabling Connector Instances
How can I use JSON with a service that only sends/accepts XML?
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
Netsuite CRM: Authenticating an instance
How to get your bulk call back in gzip format
Dropbox - Creating New File Links
Adobe Sign: Troubleshooting Provisioning Through the UI
How to Reset Phone Number For 2FA Via API
OAuth Proxies
How to Use OAuth Proxies with SAP Cloud Platform Open Connectors
Callback URLs for OAuth Proxies
Formulas
Introduction to Formulas
Introduction to 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
Introduction to Formulas
Common Resources
Defining Common Resources and Transformations
Introduction to Common Resources
Creating and Managing Common Resources
Mapping and Transforming Fields
Transforming COs Fields with the API
Migrating Resources and Transformations Between Environments
Connectors Request using JS Script & HTTP request
Using Common Resource Templates
Knowledgebase
Custom JavaScript Transformations on Common Resources
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 Cloud Platform 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?
Connector Builder
Build Connectors
Connector Builder Overview
Building a Connector with Connector Builder
Connector Builder: Information Tab
Connector Builder: Setup Properties
Connector Builder: Setup Authentication
Connector Builder: Setup Configuration and Parameters
Connector Builder: Setup Hooks
Connector Builder: Setup Events
Connector Builder: Resources
Extend Connectors
Extend Connectors
Knowledgebase
Connector Builder - How to Verify Basic Authorization Credentials Prior to Authenticating an Instance
Connector Builder - Additional Information Tab Explanation
Connector Builder - Request Root Key and Response Root Key
Connector Builder - Custom Auth with Token Refresh
Connector Builder - How to reference user configuration parameters
Connector Builder - Using Custom SSL Certificates
Connector Builder - How To Export and Import Extended Connector Resources
OCNQL
Querying with OCNQL
How Do You Escape Spaces in Field Names When Querying
Using the OCNQL Query Override Field
Bulk
Using Bulk
Bulk APIs - How to Join Multiple Objects
Security
Overview
Organizations, Accounts, and Users
Accounts and Users
Manage Accounts
Manage Users
Roles
Manage Roles
Security Settings
Manage Security Settings
Knowledgebase
How to Change the Email of the Org Owner
Reset User and Organization Secret Via the API
Cross-Origin Resource Sharing (CORS)
Data Protection and Privacy
Data Protection & Privacy
Events
Working with Events
Events Overview
Authenticate a Connector Instance with Events (UI)
Authenticate an 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
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
Whitelisting SAP Cloud Platform Open Connectors IP Addresses
Branding Your Experience
Home
Getting Started
Platform Reference
API Reference
Read about the SAP Cloud Platform Open Connectors APIs.
Accounts
(27)
Base /accounts APIs
(6)
Account Level Common Resources APIs
(8)
Account Level Transformation APIs
(6)
Connector and Formula Instance Account APIs
(2)
Account Level Users APIs
(5)
Audit Logs
(11)
GET /audit-logs
()
GET /audit-logs/authentication
()
GET /audit-logs/common-resources
()
GET /audit-logs/common-resources/{commonResourceName}
()
GET /audit-logs/element-instances
()
See More
Connectors
(6)
GET /elements
()
GET /elements/{id}/docs
()
GET /elements/{id}/metadata
()
GET /elements/{keyOrId}
()
GET /elements/{keyOrId}/instances
()
See More
Organizations
(21)
Base /organizations APIs
(2)
Organization Level Common Resource APIs
(8)
Organization Level Transformation APIs
(6)
Organization Level Users APIs
(5)
Users
(7)
Manage Users APIs
(4)
Roles
(3)
Instances
(2)
POST /instances
()
PATCH /instances/objects/{{objectName}}
()
Discovery APIs
(4)
GET /hubs/{hubName}/objects
()
GET /hubs/{hubName}/objects (v2)
()
GET /hubs/{hubName}/objects/{objectName}/docs
()
GET /hubs/{hubName}/objects/{objectName}/metadata
()