Update Data Mart Task

put

https://example.com/test/api/web/datamart-tasks/{DataMartTaskId}

api/web/datamart-tasks/{DataMartTaskId}

Updates an existing data mart task based on the supplied model.
If the table is changed, the password is cleared and iteration parameters
are re-initialized from the new table configuration.

Path Params

DataMartTaskId

int32

required

≥ 1

The ID of the data mart task to update (DataMartTaskId >= 1).

Body Params

The updated data mart task model.

Report task used to schedule a report execution

TableId

int32

The unique database ID of the table that the data mart task belongs to.

ErrorMailTo

string | null

Mail address for the user why should get error notifications.

Name

string

required

length ≥ 1

The name of the report task

ScheduleId

int32

required

1 to 2147483647

The unique database ID of the schedule that the report task belongs to.

ExecutionMode

string

enum

Allowed:

Comment

string | null

Additional comment or description for the data mart task.

ParentGroupId

int32 | null

The unique database ID of the parent task group.
Null if the task has no parent group.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK