API

Interact with your workflows using APIs, enabling automation and integration with external systems

Introduction

The API tab in DBSync Cloud Workflow allows you to interact with your workflows programmatically, enabling automation and integration with external systems. Through a set of RESTful API endpoints, you can run tasks, check the status of workflows, and even interrupt tasks if needed. This powerful feature is designed to help you automate processes, integrate workflows with other applications, and provide more flexibility for managing your tasks outside of the DBSync platform.

The API tab provides essential tools to control and monitor workflows in real-time. Whether you're triggering specific tasks, checking task statuses, or halting tasks that are running longer than expected, the API endpoints allow for seamless communication between your systems and DBSync Cloud Workflow.

By leveraging the available API endpoints, you can create custom solutions that cater to your specific needs, automating critical business processes and improving operational efficiency.

In this tab, you'll find:

• Base URL: The URL to access the API for interacting with workflows.

• POST and GET Endpoints: To run tasks, retrieve task statuses, and interrupt tasks as necessary.

• Actions: Options to test, edit, or remove API configurations.

Here is a description for each of the fields in the API section of the screenshot you provided:

1. Base URL

• Description: This field displays the base URL for the API, which is the endpoint you will use to interact with the API for managing tasks.

• Example: https://api-platform3.dbsync.io/cw/api/v2 is the URL you will use for sending API requests to DBSync Cloud Workflow.

• Functionality: You append specific paths to this URL to interact with different API endpoints. For example, appending /project/{projectId}/task/{taskId}/run would allow you to run a specific task.

2. POST - /project/{projectId}/task/{taskId}/run

• Description: This API endpoint allows you to run a specific task within a project.

• Method: POST

• Example: POST /project/{projectId}/task/{taskId}/run will trigger the execution of the task specified by the taskId in the project identified by projectId.

• Functionality: You can use this endpoint to start a task programmatically, passing the necessary parameters such as projectId and taskId to execute the task.

3. GET - /status/{pid}

• Description: This API endpoint allows you to check the status of a task.

• Method: GET

• Example: GET /status/{pid} will return the current status of the task with the specified pid (process ID).

• Functionality: This is useful for monitoring the state of a task, such as whether it is running, completed, or encountered an error. The status could be vital for automated systems that need to track the progress of workflows.

4. GET - /interrupt/{pid}

• Description: This API endpoint allows you to interrupt or stop a running task.

• Method: GET

• Example: GET /interrupt/{pid} will stop the task identified by the process ID (pid).

• Functionality: This is useful when you need to terminate a task that is running longer than expected or if an error requires you to manually stop the task from continuing. It can help manage long-running tasks or handle unexpected situations.

5. Actions (Edit, Delete, and Test)

• Description: This section contains options to edit, delete, or test the API configurations.

• Operations:

  • Edit: Click the pencil icon to modify any settings related to the API configuration.

  • Delete: Click the trash can icon to remove the API configuration if it’s no longer needed.

  • Test (if available): You may have an option to test the API calls directly from this section to ensure that they are functioning as expected.

Additional Information

• Functionality: The API section allows users to manage tasks and their execution programmatically. Using the provided endpoints, developers can integrate workflow management into their own systems or automate processes using API calls.

• Authentication: You will typically need to authenticate your API requests using an API key or other authentication methods provided by DBSync. This is not shown directly in the screenshot but is often required for secure API interactions.