- V2
-
V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
-
SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
SchedulesApi
SchedulesApi
[GET] /api/schedules/tasks
Response
Status Code: 200
Success
[GET] /api/schedules/workers
Response
Status Code: 200
Success
[GET] /api/schedules/cancel/{taskId}
Parameters
| Name | Type | Located In |
|---|---|---|
| taskIdRequired | string | path |
Response
Status Code: 200
Success
Models
Ƭ TaskInfo
| Name | Type | Description | Example |
|---|---|---|---|
| taskID | TaskID | ||
| workerUrlNullable | string | ||
| workerIDNullable | string | ||
| initiatorNullable | string | ||
| documentNameNullable | string | ||
| documentIdNullable | string | ||
| documentTypeNullable | string | ||
| startTime | ISO DateTime Sting | ||
| endTimeNullable | ISO DateTime Sting | ||
| progressNullable | string | ||
| errorMessageNullable | string | ||
| descriptionNullable | string | ||
| breakStatus | TaskStatus | ||
| status | TaskStatus |
Ƭ TaskID
| Name | Type | Description | Example |
|---|---|---|---|
| parent | TaskID | ||
| idNullable | string |
Ƭ TaskStatus
Enum:
NotStartedWaitingForActivationWaitingToRunStartedReadingResultVerifyingCanceledFailedFinished
Ƭ WorkerInfo
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | ||
| urlNullable | string | ||
| lastSeen | ISO DateTime Sting | ||
| tasksInProgress | int32 | ||
| displayNameNullable | string | ||
| specializationsNullable | Array<string> |