Update Custom Endpoint Task

put

https://example.com/test/api/web/custom-endpoint-tasks/{CustomEndpointTaskId}

api/web/custom-endpoint-tasks/{CustomEndpointTaskId}

Updates an existing custom endpoint task except user name and password, based on the supplied model.

Path Params

CustomEndpointTaskId

int32

required

≥ 1

The ID of the custom endpoint task to update (CustomEndpointTaskId >= 1)

Body Params

The updated custom endpoint task model.

Report task used to schedule a report execution

EndpointId

int32

The unique database ID of the custom endpoint that the custom endpoint task belongs to.

ErrorMailUserAddress

string | null

Mail address for the user why should get error notifications.

Name

string

required

length ≥ 1

The name of the custom endpoint task

ScheduleId

int32

required

1 to 2147483647

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

Comment

string | null

An optional comment for the custom endpoint task.

ParentGroupId

int32 | null

The ID of the tasks parent group within the web portals group structure.

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