Task Service API Documentation¶
SimOne Web Task Server
The Task Service (/api-task/) provides full lifecycle management for simulation tasks, including task creation and scheduling, runtime control, and batch execution via test plans.
Contents¶
| Section | Description |
|---|---|
| Service Status API (this page) | Get service health status |
| Task API | Create, query, start/stop, and delete tasks |
| Task Runtime API | Query and control the state of running tasks |
| Test Plan API | Create, execute, and query results of test plans |
| Appendix: Common Headers | Authentication and request header reference for all APIs |
2.1 Service Status API¶
2.1.1 Get Service Health Status¶
Path： /api-task/health
Method： GET
Headers：Headers
Request Parameters¶
None
Response Codes¶
| Code | Description |
|---|---|
| 200 | Ok |
Response Data¶
| Field | Description | Required | Type |
|---|---|---|---|
| version | Version | Yes | string |
| current | Current status | Yes | number |
| maximum | Maximum status | No | number |
| message | Current status message | No | string |
| level | Current service level | No | "info" | "error" | "warning" |
| code | Service error code | No | number |