Skip to content

Commit 8bd4b6d

Browse files
Enhance documentation for task chains in REST APIs
Added prerequisites and request body details for running task chains using REST APIs. TO VERIFY if the input parameters json is correct. I took it from here: https://api.sap.com/api/DatasphereTasks/path/post_api_v1_datasphere_tasks_chains__spaceid__run__objectid_ and we don't have a chain with the parameters right now
1 parent 103db85 commit 8bd4b6d

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

docs/Acquiring-Preparing-Modeling-Data/Acquiring-and-Preparing-Data-in-the-Data-Builder/manage-tasks-using-rest-apis-274f273.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ The detailed documentation of the Data Sharing Cockpit REST APIs is available on
6060

6161

6262

63+
6364
## Task Chains
6465

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

74+
**Prerequisite:** The task chain must be active and deployed before it can be run.
75+
76+
**Header:** Set `Content-Type: application/json` in the request header.
77+
78+
**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 `{}`.
79+
7380
Example:
7481

75-
> ### Sample Code:
82+
> ### Sample Request:
83+
> ```
84+
> {
85+
> "inputParameters": {
86+
> "param1": "value1",
87+
> "param2": "value2"
88+
> }
89+
> }
90+
> ```
91+
92+
> ### Sample Response:
7693
> ```
7794
> {
7895
> "logId": 9999999
@@ -81,6 +98,7 @@ Example:
8198
8299
83100
101+
84102
## Logs
85103
86104
Get task log details and existing task log history of objects.

0 commit comments

Comments
 (0)