Skip to content

Enhance documentation for task chains in REST APIs #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smarchesini-avvale wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

Enhance documentation for task chains in REST APIs #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion ...-and-Preparing-Data-in-the-Data-Builder/manage-tasks-using-rest-apis-274f273.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ The detailed documentation of the Data Sharing Cockpit REST APIs is available on




## Task Chains

Run task chains.
Expand All @@ -70,9 +71,25 @@ To run a task chain, use the POST request with the API <code>api/v1/datasphere/t
https://<tenant_url>/api/v1/datasphere/tasks/chains/<space_id>/run/<objectid>
```

**Prerequisite:** The task chain must be active and deployed before it can be run.

**Header:** Set `Content-Type: application/json` in the request header.

**Request Body:** You can optionally pass input parameters for the task chain. This works only if the task chain is defined with input parameters. If no input parameters are needed, you can send an empty JSON object `{}`.

Example:

> ### Sample Code:
> ### Sample Request:
> ```
> {
> "inputParameters": {
> "param1": "value1",
> "param2": "value2"
> }
> }
> ```

> ### Sample Response:
> ```
> {
> "logId": 9999999
Expand All @@ -81,6 +98,7 @@ Example:




## Logs

Get task log details and existing task log history of objects.
Expand Down
Loading