API documentationGeneralHealth checkGet Unimus health status. Method: GET CURL| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| curl -H "Accept: application/json" -H "Authorization: Bearer <token>" "http://<example.unimus>/api/v1/health" |
Success 200| Field | Type | Description |
|---|
| status | String | OK - Unimus is ready to handle all requests. LICENSING_UNREACHABLE - License server is unreachable. All request will proceed except add, remove and update device. ERROR - Unimus require user interaction to solve the problem. All requests will be refused. |
| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| title | Success response |
|---|
| HTTP/1.1 200 OK { } |
SchedulesSchedules - get scheduleGet an individual schedule. Method: GET CURL| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| curl -H "Accept: application/json" -H "Authorization: Bearer <token>" "http://<example.unimus>/api/v1/schedules/<scheduleId>" |
Parameter| Field | Type | Description |
|---|
| scheduleId | Number | The ID of the schedule |
Success 200| Field | Type | Description |
|---|
| id | Number | The ID of the schedule | | createTime | Number | Schedule creation time in seconds | | periodicity | String | Schedule periodicity. Possible values: MONTHLY, WEEKLY, DAILY, HOURLY | | dom | Number | Day of month | | dow | Number | Day of week | | hour | Number | Hour of day | | min | Number | Minute of hour | | name | String | Schedule pretty name |
| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| title | Success response |
|---|
| HTTP/1.1 200 OK { "data": {"id": 7, "createTime": 1511863250, "periodicity": "MONTHLY", "dom": 1, "dow": 1, "hour": 0, "min": 6, "name": "Every month, on day 1, at 00:06." } } |
Error 4xx| Name | Type | Description |
|---|
| timestamp | Number | Current timestamp | | code | Number | 404 | | error | String | HTTP code message | | message | String | Error message |
| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| title | Error response |
|---|
| HTTP/1.1 404 NOT FOUND { "timestamp": 1511862182524, "code": 404, "error": "Not Found", "message": "Schedule with id 11 not found" }
|
Schedules - get schedulesGet a list of all schedules in Unimus. Method: GET CURL| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| curl -H "Accept: application/json" -H "Authorization: Bearer <token>" "http://<example.unimus>/api/v1/schedules?page=0&size=20" |
Parameter| Name | Type | Description |
|---|
| pageIndex | Number | Page index (OPTIONAL) | | pageSize | Number | Page size (OPTIONAL) |
Success 200| Name | Type | Description |
|---|
| id | Number | The ID of the schedule | | createTime | Number | Schedule creation time in seconds | | periodicity | String | Schedule periodicity. Possible values: MONTHLY, WEEKLY, DAILY, HOURLY | | dom | Number | Day of month | | dow | Number | Day of week | | hour | Number | Hour of day | | min | Number | Minute of hour | | name | String | Schedule pretty name |
| Panel |
|---|
| borderColor | grey |
|---|
| borderStyle | solid |
|---|
| title | Success response |
|---|
| HTTP/1.1 200 OK { "data": [ {"id": 5, "createTime": 1511863239, "periodicity": "MONTHLY", "dom": 5, "dow": 1, "hour": 0, "min": 0, "name": "Every month, on day 5, at 00:00." }, {"id": 7, "createTime": 1511863250, "periodicity": "MONTHLY", "dom": 1, "dow": 1, "hour": 0, "min": 6, "name": "Every month, on day 1, at 00:06." } ], "paginator": {"totalCount": 7, "totalPages": 4, "page": 1, "size": 2 } }
|
|