Runtime API

DragOnce Runtime API User Guide 

DragOnce runtime API enables your application to interact with data stored in DragOnce. Through the RESTful API provided, developers can create, query, remove, modify and trigger pre-defined business rules. To facilitate the integration, different identifiers have been provided throughout the application management panel, including but not limited to storage IDs (equivalent to page and form IDs), column IDs (equivalent to widget IDs) and business rules ID (equivalent to workflow IDs). 

Obtain Authentication Info 

API keys and related info are required before using DragOnce Runtime API. Please follow the steps below to obtain the required info. 

1. Navigate to "Administration Panel" in DragOnce 

2. Navigate to "API Key" UI (If this page is not available, please contact support) 

3. Click on "New" button 

4. Select a target user 

5. Click on "New API Key" to generate key 

6. Configure the API & Environment Scope for the generated key 

7. Copy and save the required info (E-Mail, Subscriber ID, API Key(s)) on the screen 

8. Note: The API Key will be masked after save. It is important to keep it for further use. 

9. Click "Save" (The keys are not truly activated before save.) 

Obtain ID(s) 

IDs are required before performing runtime action. Please follow the steps below to obtain the required info. 

Obtain App / Environment ID 

1. Navigate to "App Management" in DragOnce 

2. Click on "ID" button between "Company logo" and "Side menu" 

3. Select at "Side menu" to navigate between App IDs List and Environment IDs List 

Obtain Page / Widget / Workflow / Report ID 

1. Navigate to "App Management" in DragOnce

2. Select a target App 

3. Click on "ID List" button at "Side menu" 

4. Select tabs at the top of the page to navigate between "Page IDs List", "Workflow IDs List" and "Report IDs List" 

Create Record 

This API allows creating a new single record. Please follow the steps below. 

1. Prepare IDs and parameters described in Init Record

2. Execute the network request (Init Record) to retrieve temporary record ID ( tmp_record_id ) 

3. (Optional) Use the above tmp_record_id to perform Upload File/ Upload Image

4. Prepare the parameters described in Commit Form Record

5. Execute the network request:  Commit Form Record

Retrieve Record(s)

Retrieve Records by Table 

To retrieve records through table widget. Please follow the steps below.

1. Prepare IDs and parameters as described in List Table Record 

Note: If need to retrieve records from other pages. Only the parameter page_number and list_mode can be changed. 

2. Apply the IDs 

3. Execute the network request 

Retrieve Record by Record ID 

To retrieve a single record through the form widget. Please follow the steps below. 

1. Prepare IDs and parameters as described in Get Form Record 

2. Apply the IDs and parameters 

3. Execute the network request: Get Form Record 

Update Record 

This API allows updating one single record. Please follow the steps below. 

Delegate / Undelegate / Undo / Withdraw 

1. Prepare the record ID of the target record 

2. Prepare the parameters described in Commit Form Record 

3. Execute the network request: Commit Form Record with the record ID ( record_id ) 

Save / Workflow actions / Others 

1. Prepare the record ID of the target record 

2. Prepare IDs and parameters described in Init Record 

3. Execute the network request (Init Record) with the record ID ( record_id ) to retrieve temporary record ID ( tmp_record_id ) for the target record 

4. (Optional) Use the above tmp_record_id to perform Upload File / Upload Image 

5. Prepare the parameters described in Commit Form Record 

6. Execute the network request: Commit Form Record with the temporary record ID ( tmp_record_id )

Delete Record(s) 

This API allows deleting one or multiple records. Please follow the steps below. 

1. Prepare the required IDs and parameters as described in Delete Form Record 

2. Apply the IDs 

3. Execute the network request: Delete Form Record 

DragOnce Runtime API Documentation 

This is the documentation for DragOnce Runtime API. 

Base Path: api.DragOnce.intra 

Version: v1 

Full Path: https://api.DragOnce.intra/v1 

Authentication 

The following headers are required in every request made to this API. 

Common Headers 

Common Parameters 

Upload File 

URL: POST: /runtime/file/upload 

Upload a file to a form record. 

Request: 

Type: multipart/form-data 

Parameters:

Response:  

Type: application/json

Example:

{ 

 "file_id": "123456789xxxxxx" 

} 

Download File 

URL: POST: /runtime/file/download 

Download specific file with file ID. 

Request: 

Type: application/x-www-form-urlencoded 

Parameters:  

Response:  

Type: image/png , application/pdf , etc. (Depends on the file) 

Upload Image 

URL: POST: /runtime/image/upload 

Upload an image to a form record. 

Request: 

Type: multipart/form-data

Parameters: 

Response: 

Type: application/json 

Example: 

{ 

 "image_id": "123456789xxxxxx" 

} 

Download Image 

URL: POST: /runtime/image/download 

Download an image with a given image ID. 

Request: 

Type: application/x-www-form-urlencoded

Parameters: 

Response: 

Type: image/png , image/jpeg , etc. (Depends on the file) 

Download Report 

URL: POST: /runtime/report/download 

Generate and download a report. 

Request: 

Type: application/x-www-form-urlencoded

Parameters: 

List Table Record 

URL: POST: /runtime/record/list/table 

List the records in a specific table.

Request: 

Type: application/x-www-form-urlencoded 

Parameters: