[]
v8.1
(Showing Draft Content)

Scheduler

Scheduler

[POST] /api/v2/scheduler/tasks/batch-delete

Batch delete the specified tasks.

Request Schema

RemoveTasksRequestModel

Response

Status Code: 200

Success

RemoveTasksResponseModel

Status Code: 400

Bad Request

SchedulerPluginErrorConsts

Models

Ƭ RemoveTasksResponseModel

Remove tasks response model

Name Type Description Example
removeTasksIdNullable Array<string> Removed tasks id. ["8F945F0E-C7F6-0BF0-C53A-985B325D30BB","20051330-1144-3470-5DEF-A0003B051A8B"]
errorsNullable ErrorContentViewModel Errors.

Ƭ ErrorContentViewModel

Error content model

Name Type Description Example
code TaskErrorCodeEnumViewModel
messageNullable string Error message
contextNullable any Error context

Ƭ TaskErrorCodeEnumViewModel

Enum:

  • PermissionRequiredErrorCode
  • DocumentNotFoundErrorCode
  • OwnerRequiredErrorCode
  • TaskInvalidErrorCode
  • TaskInvalidWithTimeErrorCode
  • TaskInvalidWithEmailErrorCode
  • TaskNotFoundErrorCode
  • InvalidTaskDataErrorCode
  • TaskInvalidWithIdErrorCode
  • TaskDatasourceAppendInvalidErrorCode
  • TaskDatasourceLocationInvalidErrorCode
  • TaskDatasourceOperationInvalidErrorCode
  • WritePermissionRequireErrorCode
  • DeletePermissionRequireErrorCode
  • DirectoryInvalidErrorCode
  • DirectorySameErrorCode
  • ReadPermissionRequireErrorCode
  • NotDeliveredErrorCode
  • NoManualAndOneTimeTaskPermissionErrorCode
  • NoFileShareDeliveryPermissionErrorCode
  • PortalUriNotSetErrorCode
  • PortalUriNotSetInDataSourceErrorCode
  • PortalUriNotSetInDatasetErrorCode
  • DuplicateScheduleTaskErrorCode
  • ExpiredTaskErrorCode
  • RemoveTaskFailedErrorCode
  • TemplateNotExistsErrorCode
  • NoExportReportErrorCode
  • CreateTaskRuntimeFailedErrorCode
  • RunTaskRuntimeFailedErrorCode
  • UpdateTaskRuntimeFailedErrorCode
  • DuplicateTaskRuntimeFailedErrorCode

Task error code enum view model

* PermissionRequiredErrorCode - 30001 - Permission Required.
* DocumentNotFoundErrorCode - 30002 - Document not found.
* OwnerRequiredErrorCode - 30003 - Administrator or document owner required.
* TaskInvalidErrorCode - 30004 - Failed to create task - task is invalid.
* TaskInvalidWithTimeErrorCode - 30005 - Failed to create task - Store until is earlier than start time.
* TaskInvalidWithEmailErrorCode - 30006 - Failed to create task - recipients email address outside your organization.
* TaskNotFoundErrorCode - 30007 - Task not found.
* InvalidTaskDataErrorCode - 30008 - Invalid task data provided.
* TaskInvalidWithIdErrorCode - 30009 - Task invalid.
* TaskDatasourceAppendInvalidErrorCode - 30010 - DataSource can't append data.
* TaskDatasourceLocationInvalidErrorCode - 30011 - Location not exists.
* TaskDatasourceOperationInvalidErrorCode - 30012 - Operation is invalid.
* WritePermissionRequireErrorCode - 30013 - Write Permission Required.
* DeletePermissionRequireErrorCode - 30014 - Delete Permission Required.
* DirectoryInvalidErrorCode - 30015 - Directory invalid.
* DirectorySameErrorCode - 30016 - Each schedule should correspond to a separate directory.
* ReadPermissionRequireErrorCode - 30017 - Read Permission Required.
* NotDeliveredErrorCode - 30018 - Not delivered.
* NoManualAndOneTimeTaskPermissionErrorCode - 30019 - No manual and one-time task permission.
* NoFileShareDeliveryPermissionErrorCode - 30020 - No file share delivery permission.
* PortalUriNotSetErrorCode - 30021 - Portal URI not set.
* PortalUriNotSetInDataSourceErrorCode - 30022 - Portal URI not set in data source.
* PortalUriNotSetInDatasetErrorCode - 30023 - Portal URI not set in dataset.
* DuplicateScheduleTaskErrorCode - 30024 - Duplicate schedule task.
* ExpiredTaskErrorCode - 30025 - Expired task.
* RemoveTaskFailedErrorCode - 30026 - Remove task failed.
* TemplateNotExistsErrorCode - 30027 - Template used in this task did not exist.
* NoExportReportErrorCode - 30028 - User has no permission to export report.
* CreateTaskRuntimeFailedErrorCode - 30029 - An unknown error occurred while creating a task.
* RunTaskRuntimeFailedErrorCode - 30030 - An unknown error occurred while running a task.
* UpdateTaskRuntimeFailedErrorCode - 30031 - An unknown error occurred while updating a task.
* DuplicateTaskRuntimeFailedErrorCode - 30032 - An unknown error occurred while duplicating a task.

Ƭ SchedulerPluginErrorConsts

Name Type Description Example

Ƭ RemoveTasksRequestModel

Remove tasks request model by taskIds and task-created userIds. At least one of taskIds or userIds is required.

Name Type Description Example
taskIdsNullable Array<string> Task id list. ["8F945F0E-C7F6-0BF0-C53A-985B325D30BB","20051330-1144-3470-5DEF-A0003B051A8B"]
userIdsNullable Array<string> Task created user id. ["5536F73E-13EA-9D92-DDD5-4077CA29F04D","E86F8321-A317-DE6B-FC0C-DC0F635AA7B8"]