Create Custom Endpoint Task

post

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

api/web/custom-endpoint-tasks

Creates a new custom endpoint task based on the supplied model and initializes it with a default iteration.
The username and password are automatically set from the currently authenticated user session.

Body Params

The 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

200OK