-
- Resources and Terminology
-
-
-
-
- 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}}
-
- List API Request Logs
- List Authentication API Request Logs
- List Virtual Data Resources API Request Logs
- GET /audit-logs/common-resources/{commonResourceName}
- List Element Instance API Request Logs
- Retrieve the Logs of a Specific Element Instance
- List Element API Request Logs
- Retrieve the Logs of a Specific Element
- List Formula Instance API Request Logs
- List Formula API Request Logs
- Retrieve the Formula Template Logs of a Specific Trigger, Step, or Configuration
-
-
- List Organization Level Virtual Data Resources
- Retrieve a Specific Organization Resource
- Create a New Organization Resource
- Create a New Organization Resource Called objectName
- 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
-
- List Organization-Level Transformations by Element
- 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 Element
- Delete Organization Transformations for a VDR
-
- User Profile
- Authentication
- Authorization Headers, Organization Secret, and User Secret
- Base URL
- Error Codes
- Pagination
- Technical Restrictions
-
-
- Timeouts Imposed on Requests
- What is the Maximum Time Frame You Can Pull Data with the Metric APIs
- Size Limits for User and Organization Tokens
- Why Am I Not Getting Fields that Have an Empty Array in my Response Body
- Getting Started - How to Use Swagger Versions
- Is there a Length Limit on User Email Addresses?
- Getting Started - Supported TLS version
- Does Cloud Elements Support Any SSO Identity Providers?
- What data does Cloud Elements store?
- How do I reset my password?
- How Does Cursor Pagination Work?
- Do I need to refresh the Cloud Elements Tokens?
- What is an element token and how do I find it?
- What is an element instance?
- Is it possible to enable polling for child resources such as /incidents/{incidentId}/comments?
- What is the limit for polling configurations that a single instance can have?
- What is the time limit on a API request?
- Cloud Elements End Of Life Announcement
-
-
-
-
- About Authenticating Element Instances
- Authenticate an Element Instance (UI)
- Authenticate an Element Instance with Events (UI)
- Authenticate an Element Instance (API)
- Authenticate an Element Instance with Events (API)
- Timeframe for Exchanging An OAuth2 Code
- Revoked or Expired Element Authentication after a Password Change
- Provisioning an Instance with an Existing Refresh Token
- Revoking an OAuth Token and Reauthenticating an Element Instance
- Resetting 2FA Phone Number via API
- Automatic Disabling of Element Instances after Failed Token Refresh
- View Element API Docs
- Import and Export Elements
- Element Sharing
- Validate Element Instances
-
-
- Building a "Hello World" Element
- Creating a Generic 'Forwarding' API
- Resource Types
-
- Elements TLS v1.2/Two-Way SSL
- Requirements for Adding Webhook Support
- Handling Non-Standard Cursor Pagination
- Setting Parameters on Every Call with a Few Exceptions
- GET {objectName}/metadata
- Request Root Key and Response Root Key
- Custom Auth with Token Refresh
- Using Custom SSL Certificates
- How to Preserve Data from the Vendor Response with a Set Root Key
- How to Verify Basic Authorization Credentials Prior to Authenticating an Instance
- How to Reference User Configuration Parameters
- Creating a New Resource that Uploads a File
-
- Documents Elements - Tag and Path Names are Saved in our Database
- File Compression for Streaming Data Download
- How to Retrieve the Authentication Type Used for an Existing Instance
- Retrieve the Configuration of a Deleted Instance
- Updating an Element Instance Configuration via API
- What ID Can Be Used To Get The Root Folder of Documents Hub Elements?
- Disabling and Enabling Element Instances
- How to Export an Element Instance
- How to get your bulk call back in gzip format
-
-
-
-
- Transformation Settings for VDRs
- Virtual Data Resources - How to Convert a Date into the Desired Format
- VDRs - How to Filter without Writing JavaScript
- VDRs - How to Retrieve a List of All Available Fields in the Custom Javascript
- How Does the PUT and GET Calls Work for "/instances/{id}/objects/{objectName}/definitions"?
- VDRs - How to Escape the Values of an Array of Objects Containing Special Characters
- VDRs - Async Code Doesn't Finish Before Done is Called
- Mapping Arrays to Specific VDR Fields
- VDRs - How to Force the Request to Fail
- Custom Javascript Field Mapping and Bulk Jobs
- VDRs - Prerequisites to Map Custom Resources
- Does Deleting an Element Instance Also Delete the Associated Virtual Data Resource?
- How Does the API Call "/instances/{id}/objects/definitions" Work?
- VDRs - Mapping an Array of Strings
- Transforming POST Virtual Data Resource Responses Using Javascript
- Custom JavaScript Transformations on Virtual Data 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 Cloud Elements 2.0
- 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?
-
- Introduction to Formulas
-
- Upgrading a Formula to the V3 Engine
- Formula Builder - Can a formula be restored to a previous version?
- Formulas - Consuming Data from Incoming Events
- Javascript in Formulas
- Formula Builder - How to Access the Value for the Current Iteration in a Loop Step
- Sub-Formula Example that Checks if Executions are Still Running on Another Formula
- Cause of "Unable to verify the first certificate" error in an HTTP Request Step in Formulas
- What Format is Used for Cron Configuration in Formulas?
- Retrying with amqpRequest Step
- Automatic Cleanup of Temporary Formula Instances
- Searching Formula Executions
- Replaying Formula Executions Via API
- How to Reduce Formula Execution Retry Error Notification Noise
- How To Manually Trigger An Events-Based Formula
- How to Build a JSON Using Strings Containing Escape Characters
- How to Use Bulk Within a Formula
- How can I pass data between formula steps?
- Can you send notifications to a webhook in a formula step?
- Formulas - Executing Formula Steps Asynchronously
- Formulas: Why Does the Search Executions by Object ID Functionality Result in Several Executions in the Results?
- Formulas: How the GET /executions Call Paginates through Results
- Formulas - How to Aggregate Loop Step Results
- Formula Data Context Example
- Formula Instance Deactivation Criteria
- Formula Builder: Debugging Sub-Formulas From a Parent Formula
- Formula Builder: Separating Email Addresses in Notification Settings
- Formula Builder - How to set up a Variable as the Cron Trigger
- Formula Builder - Isolating Trigger Events
- Formula Builder - Ensuring Functionality with Step Name Changes
- Formula Builder - Stream Step Overriding File Name or Content Type
- Formula Builder - How to Break an Execution After a Given Step
- Headers in a httpRequest Formula Step
- Debugging limits on Large Formula Steps
-
-
- Managing Environments
- SAML-Based SSO from Identity Provider to Cloud Elements
- Standardized Authentication
-
-
- Ground2Cloud Overview
- Who This Ground2Cloud Manual is For
- Installing Ground2Cloud for Quickbooks Enterprise
- The Ground2Cloud GUI
- G2C FAQs
- Troubleshooting Ground2Cloud
- Cloud Elements On-Prem Config File
- Going Live with Ground2Cloud: Migrating G2C to Use Production Servers
- Cloud Elements On-Prem CLI
- G2C - Restarting The G2C Service
- Can I Use Ground2Cloud for Custom Elements?
- Using SAP Business One with Ground2Cloud
-
-
- Events - Why a Poller Would Make Multiple GET Calls for One Resource
- Events - Polled Event Hash Verification
- How to Enforce a Timezone in a Poller URL
- 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
-
- Getting the Most Recent Version of Swagger
- Promoting Custom Element Changes to Production
- Deployment Best Practices
- Clearing UI Local Storage
- How the Instance Configuration of "filter.response.nulls" Works
- Monitor the Health of Elements
- Custom Objects and Dynamic APIs
- Configuring your System to Allow Access through a Range of IPs (Allowlisting)
- Cloud Elements FAQ
- Error Message Details
-
-
- Production Changelog - November 2023
- Production Changelog - October 2022
- Production Changelog - September 2022
- Production Changelog - August 2022
- Production Changelog - July 2022
- Production Changelog - June 2022
- Production Changelog - May 2022
- Production Changelog - April 2022
- Production Changelog - March 2022
- Production Changelog - February 2022
- Production Changelog - January 2022
- Production Changelog - December 2021
- Production Changelog - November 2021
- Production Changelog - October 2021
- Production Changelog - September 2021
- Production Changelog - August 2021
- Production Changelog - July 2021
- Production Changelog - June 2021
- Production Changelog - May 2021
- Production Changelog - April 2021
- Production Changelog - March 2021
- Production Changelog - February 2021
- Production Changelog - January 2021
- Production Changelog - December 2020
- Production Changelog - November 2020
- Production Changelog - October 2020
- Production Changelog - August/September 2020
-
-
- Production Release Notes - Version v2.208.2346
- Production Release Notes - Version v2.208.2355
- Production Release Notes - Version v2.208.2286
- Production Release Notes - Version vhotfix-ENG-6619
- Production Release Notes - Version vhotfix-ENG-6104-stg
- Production Release Notes - Version vhotfix-SDR-4491
- Production Release Notes - Version v2.208.2128
- Production Release Notes - Version v2.208.2118
- Production Release Notes - Version vhotfix-ENG-5189-1
- Production Release Notes - Version vhotfix-SDR-4437
- Production Release Notes - Version vhotfix-ENG-4524
- Production Release Notes - Version v2.208.2060
- Production Release Notes - Version v2.208.2047
- Production Release Notes - Version v2.208.2015
- Production Release Notes - Version vhotfix-ENG-3947
- Production Release Notes - Version vhotfix-ENG-3652
- Production Release Notes - Version v2.208.1959
- Production Release Notes - Version v2.208.1948
- Production Release Notes - Version vhotfix-SDR-4262
- Production Release Notes - Version v2.208.1928
- Production Release Notes - Version vhotfix-ENG-2384-stg
- Production Release Notes - Version v2.208.1908
- Production Release Notes - Version v2.208.1901
- 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 - Version v2.208.2330
- Staging Release Notes - Version v2.208.2128
- Staging Release Notes - Version v2.208.2127
- Staging Release Notes - Version v2.208.2118
- Staging Release Notes - Version v2.208.2094
- Staging Release Notes - Version v2.208.2079
- Staging Release Notes - Version v2.208.2078
- Staging Release Notes - Version v2.208.2060
- Staging Release Notes - Version v2.208.2047
- Staging Release Notes - Version v2.208.2028
- Staging Release Notes - Version v2.208.2020
- Staging Release Notes - Version v2.208.2015
- Staging Release Notes - Version v2.208.2003
- Staging Release Notes - Version v2.208.1984
- Staging Release Notes - Version v2.208.1970
- Staging Release Notes - Version v2.208.1959
- Staging Release Notes - Version v2.208.1948
- Staging Release Notes - Version v2.208.1935
- Staging Release Notes - Version v2.208.1928
- Staging Release Notes - Version v2.208.1924
- Staging Release Notes - Version v2.208.1908
- Staging Release Notes - Version v2.208.1901
- 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 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
-
Citrix ShareFile
Citrix ShareFile
The Citrix ShareFile element is available in our Documents hub.
| Element Information | Details |
|---|---|
| Provider API Documentation | Citrix ShareFile API Documentation |
| Authentication | OAuth 2.0 |
| Events | Webhooks and polling |
| Bulk | Not supported. |
| Transformations | Not supported |