v5.0_Scheduler

Owned by Ramya Raman (Unlicensed)
Last updated: Mar 03, 2022
43 min read

GET scheduler/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all scheduler config in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config

Example Request

GET 

  1. https://192.168.10.53/api/5.0/scheduler/config

{ "data": [ { "uuid": "49d4ea94-1b79-4838-a123-d8198b025dae", "note": "utc_back", "created": "2022-01-12T11:45:08.759Z", "modified": "2022-02-08T12:23:29.308Z", "type": "Profile Change", "attributes": { "color": "#ffffff", "timezone": "f8e2f0da-b47c-4f00-a1cf-54524ee077a8", "active_from": "2022-01-10T00:00:00.000Z", "active_until": "Any", "entries": [ { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "11:30", "change_to_profile": "test" }, { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "11:31", "change_to_profile": "Default" } ], "group": "utc4" } }, { "uuid": "73324536-d8fb-42c0-83bd-5323d780cd07", "note": "utc_back", "created": "2022-01-12T11:46:51.989Z", "modified": "2022-02-08T12:23:29.308Z", "type": "Profile Change", "attributes": { "color": "#ffffff", "timezone": "f8e2f0da-b47c-4f00-a1cf-54524ee077a8", "active_from": "2022-01-10T00:00:00.000Z", "active_until": "Any", "entries": [ { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "12:30", "change_to_profile": "test" }, { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "12:31", "change_to_profile": "Default" } ], "group": "utc5" } }, { "uuid": "44dfefce-e6b5-4551-9aea-2e32e42ee615", "note": "utc_jump", "created": "2022-01-11T14:41:02.769Z", "modified": "2022-02-08T12:23:29.308Z", "type": "Profile Change", "attributes": { "color": "#ffffff", "timezone": "09fed967-581f-4723-9a0b-f61d493ad65b", "active_from": "2022-01-10T00:00:00.000Z", "active_until": "Any", "entries": [ { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "01:00", "change_to_profile": "test" }, { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "01:02", "change_to_profile": "Default" } ], "group": "utc3" } }, { "uuid": "73490d01-0b04-4528-8990-c1133fd4f9a4", "note": "utc_jump", "created": "2022-01-11T14:14:19.270Z", "modified": "2022-02-08T12:23:29.308Z", "type": "Profile Change", "attributes": { "color": "#ffffff", "timezone": "09fed967-581f-4723-9a0b-f61d493ad65b", "active_from": "2022-01-10T00:00:00.000Z", "active_until": "Any", "entries": [ { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "13:33", "change_to_profile": "test" }, { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "13:34", "change_to_profile": "Default" } ], "group": "utc2" } }, { "uuid": "5651be4e-2b67-4bda-921b-d6081eb92a76", "note": "utc_plus_1", "created": "2022-01-11T14:08:08.995Z", "modified": "2022-02-08T12:23:29.308Z", "type": "Profile Change", "attributes": { "color": "#ffffff", "timezone": "09fed967-581f-4723-9a0b-f61d493ad65b", "active_from": "2022-01-10T00:00:00.000Z", "active_until": "Any", "entries": [ { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "12:07", "change_to_profile": "test" }, { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "12:08", "change_to_profile": "Default" } ], "group": "utc1" } } ], "metadata": { "item_count": 5, "total_items": 5, "current_page": 1, "sort_by": [ { "field": "note", "direction": "ASC" } ], "links": { "current": "http://192.168.10.53/api/5.0/scheduler/config" } } }

 

 

GET scheduler/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single scheduler configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired scheduler.

Example Request

GET 

  1. https://192.168.10.53/api/5.0/scheduler/config/49d4ea94-1b79-4838-a123-d8198b025dae

{ "data": { "uuid": "49d4ea94-1b79-4838-a123-d8198b025dae", "note": "utc_back", "created": "2022-01-12T11:45:08.759Z", "modified": "2022-02-08T12:23:29.308Z", "type": "Profile Change", "attributes": { "color": "#ffffff", "timezone": "f8e2f0da-b47c-4f00-a1cf-54524ee077a8", "active_from": "2022-01-10T00:00:00.000Z", "active_until": "Any", "entries": [ { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "11:30", "change_to_profile": "test" }, { "days_of_week": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "time_of_day": "11:31", "change_to_profile": "Default" } ], "group": "utc4" } }, "metadata": {} }

 

 

GET scheduler/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by scheduler configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config/meta

Example Request

GET 

  1. https://192.168.10.53/api/5.0/scheduler/config/meta

{ "Types": [ "Profile Change" ] }

 

 

DELETE scheduler/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific scheduler configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the scheduler to be deleted.

Example Request

DELETE 

  1. https://192.168.10.53/api/5.0/scheduler/config/5be591e4-9d5b-4e1f-a43f-4bc4f15cc6c7

 

 

PUT scheduler/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a scheduler configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the scheduler to be edited.

Example Request

PUT 

  1. https://192.168.10.53/api/5.0/scheduler/config/5ff8aa32-da4d-4a18-9f5d-b49182f64b23

Body

Response

 

 

POST scheduler/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new scheduler, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config

Example Request

POST 

  1. https://192.168.10.53/api/5.0/scheduler/config

Body

Response

 

 

POST scheduler/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple scheduler, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config

Example Request

POST 

  1. https://192.168.10.53/api/5.0/scheduler/config

Body

Response

 

 

PUT scheduler/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multiple scheduler, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config

Example Request

PUT 

  1. https://192.168.10.53/api/5.0/scheduler/config

Body

Response

 

 

DELETE scheduler/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple scheduler configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/scheduler/config

Example Request

DELETE 

  1. https://192.168.10.53/api/5.0/scheduler/config

Body

Response