openapi: 3.2.0 info: title: device-service Schedules API version: '1.0' servers: - url: https://ads-dev.aylanetworks.com/apiv1/ security: - sec0: [] tags: - name: Schedules paths: /schedules/all/by_user.json: get: summary: Get schedules for user description: This API returns schedules accessible by user. operationId: get-schedules-for-user responses: '200': description: OK content: application/json: examples: Result: value: "[\n {\n \"schedule\": {\n \"active\": true,\n \"day_occur_of_month\": [\n 1\n ],\n \"days_of_month\": [\n 1\n ],\n \"days_of_week\": [\n 1\n ],\n \"device_id\": 6592588,\n \"direction\": \"input\",\n \"display_name\": \"schedule1\",\n \"duration\": null,\n \"end_date\": \"\",\n \"end_time_each_day\": \"\",\n \"fixed_actions\": false,\n \"interval\": null,\n \"months_of_year\": [\n 1\n ],\n \"name\": \"schedule1\",\n \"start_date\": \"\",\n \"start_time_each_day\": \"21:00:00\",\n \"time_before_end\": null,\n \"utc\": false,\n \"version\": \"1\",\n \"key\": 36250927,\n \"metadata\": {\n \"sunrise_sunset\": true\n },\n \"schedule_actions\": []\n }\n },\n{...}\n]" schema: type: array items: type: object properties: schedule: type: object properties: active: type: boolean example: true default: true day_occur_of_month: type: array items: type: integer example: 1 default: 0 days_of_month: type: array items: type: integer example: 1 default: 0 days_of_week: type: array items: type: integer example: 1 default: 0 device_id: type: integer example: 6592588 default: 0 direction: type: string example: input display_name: type: string example: schedule1 duration: type: string end_date: type: string example: '' end_time_each_day: type: string example: '' fixed_actions: type: boolean example: false default: true interval: type: string months_of_year: type: array items: type: integer example: 1 default: 0 name: type: string example: schedule1 start_date: type: string example: '' start_time_each_day: type: string example: '21:00:00' time_before_end: type: string utc: type: boolean example: false default: true version: type: string example: '1' key: type: integer example: 36250927 default: 0 metadata: type: object properties: sunrise_sunset: type: boolean example: true default: true schedule_actions: type: array items: type: object properties: {} '401': content: {} description: Unauthorized '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Schedules /schedules/{scheduleId}.json: get: summary: Get schedule description: This API returns the specified schedule. operationId: get-schedule-by-id parameters: - name: scheduleId in: path description: Unique schedule identifier (Schedule key). schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: schedule: active: true day_occur_of_month: - 1 days_of_month: - 1 days_of_week: - 1 device_id: 6592588 direction: input display_name: schedule1 duration: null end_date: '' end_time_each_day: '' fixed_actions: false interval: null months_of_year: - 1 name: schedule1 start_date: '' start_time_each_day: '21:00:00' time_before_end: null utc: false version: '1' key: 36250927 metadata: sunrise_sunset: true schedule_actions: [] schema: type: object properties: schedule: type: object properties: active: type: boolean example: true default: true day_occur_of_month: type: array items: type: integer example: 1 default: 0 days_of_month: type: array items: type: integer example: 1 default: 0 days_of_week: type: array items: type: integer example: 1 default: 0 device_id: type: integer example: 6592588 default: 0 direction: type: string example: input display_name: type: string example: schedule1 duration: type: string end_date: type: string example: '' end_time_each_day: type: string example: '' fixed_actions: type: boolean example: false default: true interval: type: string months_of_year: type: array items: type: integer example: 1 default: 0 name: type: string example: schedule1 start_date: type: string example: '' start_time_each_day: type: string example: '21:00:00' time_before_end: type: string utc: type: boolean example: false default: true version: type: string example: '1' key: type: integer example: 36250927 default: 0 metadata: type: object properties: sunrise_sunset: type: boolean example: true default: true schedule_actions: type: array items: type: object properties: {} '401': content: {} description: Unauthorized '404': content: {} description: Not Found deprecated: false tags: - Schedules /schedules/{scheduleId}/clear.json: put: summary: Clear schedule description: This API clears a schedule. operationId: clear-schedule parameters: - name: scheduleId in: path description: Unique schedule identifier schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: schedule: active: true day_occur_of_month: - 1 days_of_month: - 1 days_of_week: - 1 device_id: 6592588 direction: input display_name: schedule1 duration: null end_date: '' end_time_each_day: '' fixed_actions: false interval: null months_of_year: - 1 name: schedule1 start_date: '' start_time_each_day: '21:00:00' time_before_end: null utc: false version: '1' key: 36250927 metadata: sunrise_sunset: true schedule_actions: [] schema: type: object properties: schedule: type: object properties: active: type: boolean example: true default: true day_occur_of_month: type: array items: type: integer example: 1 default: 0 days_of_month: type: array items: type: integer example: 1 default: 0 days_of_week: type: array items: type: integer example: 1 default: 0 device_id: type: integer example: 6592588 default: 0 direction: type: string example: input display_name: type: string example: schedule1 duration: type: string end_date: type: string example: '' end_time_each_day: type: string example: '' fixed_actions: type: boolean example: false default: true interval: type: string months_of_year: type: array items: type: integer example: 1 default: 0 name: type: string example: schedule1 start_date: type: string example: '' start_time_each_day: type: string example: '21:00:00' time_before_end: type: string utc: type: boolean example: false default: true version: type: string example: '1' key: type: integer example: 36250927 default: 0 metadata: type: object properties: sunrise_sunset: type: boolean example: true default: true schedule_actions: type: array items: type: object properties: {} '401': content: {} description: Unauthorized '404': content: {} description: Not Found deprecated: false tags: - Schedules /schedules/{scheduleId}/schedule_actions.json: post: summary: Create schedule action description: 'This API creates a schedule action. **NOTE**: Specify value to just one of the following parameters in the request body: in_range,' operationId: create-schedule-action parameters: - name: scheduleId in: path description: Unique schedule identifier schema: type: string required: true requestBody: content: application/json: schema: type: object properties: schedule_action: properties: name: type: string description: The name of the property this schedule_action is related with. type: type: string description: The schedule action type. Currently only the "SchedulePropertyAction" type is supported. default: SchedulePropertyAction base_type: type: string description: 'Base type can be any one of the following: “string”, “integer”, “boolean”, or “decimal”.' in_range: type: boolean description: Fire schedule action if the time is within the range specified. at_start: type: boolean description: Fire schedule action if the time is at the start of the range. at_end: type: boolean description: Fire schedule action if the time is at the end of the range. value: type: string description: Value to be set to the property when an event fires. required: - name - type - base_type - in_range - at_start - at_end - value type: object examples: New Example: summary: New Example value: schedule_action: type: SchedulePropertyAction name: Blue_LED base_type: boolean in_range: true at_start: false at_end: false value: '1' responses: '200': description: OK content: application/json: examples: Result: value: schedule_action: name: Blue_LED base_type: boolean schedule_id: 36250927 in_range: true at_start: false at_end: false type: SchedulePropertyAction active: true key: 36733791 value: 1 schema: type: object properties: schedule_action: type: object properties: name: type: string example: Blue_LED base_type: type: string example: boolean schedule_id: type: integer example: 36250927 default: 0 in_range: type: boolean example: true default: true at_start: type: boolean example: false default: true at_end: type: boolean example: false default: true type: type: string example: SchedulePropertyAction active: type: boolean example: true default: true key: type: integer example: 36733791 default: 0 value: type: integer example: 1 default: 0 '401': content: {} description: Unauthorized '404': content: {} description: Not Found '422': content: {} description: Unprocessable Entity deprecated: false tags: - Schedules get: summary: Get schedule actions description: This API returns an array of schedule actions associated with the schedule ID. operationId: get-schedule-action parameters: - name: scheduleId in: path description: Unique schedule identifier. schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: schedule_action: active: true at_end: false at_start: true base_type: string in_range: false name: oem_host_version schedule_id: 35961706 type: SchedulePropertyAction key: 36290711 value: '2' schema: type: object properties: schedule_action: type: object properties: active: type: boolean example: true default: true at_end: type: boolean example: false default: true at_start: type: boolean example: true default: true base_type: type: string example: string in_range: type: boolean example: false default: true name: type: string example: oem_host_version schedule_id: type: integer example: 35961706 default: 0 type: type: string example: SchedulePropertyAction key: type: integer example: 36290711 default: 0 value: type: string example: '2' '401': content: {} description: Unauthorized '404': content: {} description: Not Found deprecated: false tags: - Schedules /schedules/{scheduleId}/schedule_actions/find_by_name.json: get: summary: Get schedule action by name description: This API returns a schedule action. operationId: get-schedule-action-by-name parameters: - name: scheduleId in: path description: Unique schedule identifier. schema: type: string required: true - name: name in: query description: Schedule action name. schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: "[\n {\n \"schedule_action\": {\n \"active\": true,\n \"at_end\": false,\n \"at_start\": true,\n \"base_type\": \"boolean\",\n \"in_range\": false,\n \"name\": \"Blue_LED\",\n \"schedule_id\": 61,\n \"key\": 64,\n \"value\": 1\n }\n }\n]\n" schema: type: array items: type: object properties: schedule_action: type: object properties: active: type: boolean example: true default: true at_end: type: boolean example: false default: true at_start: type: boolean example: true default: true base_type: type: string example: boolean in_range: type: boolean example: false default: true name: type: string example: Blue_LED schedule_id: type: integer example: 61 default: 0 key: type: integer example: 64 default: 0 value: type: integer example: 1 default: 0 '401': content: {} description: Unauthorized '404': content: {} description: Not Found deprecated: false tags: - Schedules components: securitySchemes: sec0: type: apiKey in: header name: Authorization x-bearer-format: '' x-default: auth_token x-readme-fauxas: true x-provenance: method: searched source: https://docs.aylanetworks.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.aylanetworks.com/reference/add-device-to-group.md - https://docs.aylanetworks.com/reference/assign-dealer-to-group.md - https://docs.aylanetworks.com/reference/associate-a-role-label.md - https://docs.aylanetworks.com/reference/clear-schedule.md - https://docs.aylanetworks.com/reference/create-a-datapoint-by-device-id.md - https://docs.aylanetworks.com/reference/create-a-notification.md - https://docs.aylanetworks.com/reference/create-a-schedule.md - https://docs.aylanetworks.com/reference/create-associated-user-1.md - https://docs.aylanetworks.com/reference/create-datapoint-by-dsn.md - https://docs.aylanetworks.com/reference/create-datapoint-message-by-dsn.md - https://docs.aylanetworks.com/reference/create-datapoints-in-group-1.md - https://docs.aylanetworks.com/reference/create-datapoints-in-group.md - https://docs.aylanetworks.com/reference/create-datapoints.md - https://docs.aylanetworks.com/reference/create-device-metadata.md - https://docs.aylanetworks.com/reference/create-group.md - https://docs.aylanetworks.com/reference/create-notification-app.md - https://docs.aylanetworks.com/reference/create-notification-app1.md - https://docs.aylanetworks.com/reference/create-schedule-action.md - https://docs.aylanetworks.com/reference/create-template-1.md - https://docs.aylanetworks.com/reference/create-template-2.md - https://docs.aylanetworks.com/reference/create-template-properties.md - https://docs.aylanetworks.com/reference/create-template.md - https://docs.aylanetworks.com/reference/create-trigger-1.md - https://docs.aylanetworks.com/reference/create-trigger.md - https://docs.aylanetworks.com/reference/delete-device-address.md - https://docs.aylanetworks.com/reference/delete-device-metadata.md - https://docs.aylanetworks.com/reference/delete-group.md - https://docs.aylanetworks.com/reference/delete-notification-by-id.md - https://docs.aylanetworks.com/reference/delete-notification.md - https://docs.aylanetworks.com/reference/delete-role-label-by-id.md - https://docs.aylanetworks.com/reference/delete-schedule-action-by-id.md - https://docs.aylanetworks.com/reference/delete-trigger-apps-by-id.md - https://docs.aylanetworks.com/reference/delete-trigger-by-id.md - https://docs.aylanetworks.com/reference/disassociate-a-role-label-to-a-device.md - https://docs.aylanetworks.com/reference/enable-role-on-device.md - https://docs.aylanetworks.com/reference/factory-reset-device-id114.md - https://docs.aylanetworks.com/reference/get-a-property-by-name.md - https://docs.aylanetworks.com/reference/get-a-schedule-by-name.md - https://docs.aylanetworks.com/reference/get-all-notifications.md - https://docs.aylanetworks.com/reference/get-all-triggers.md - https://docs.aylanetworks.com/reference/get-associated-devices-1.md - https://docs.aylanetworks.com/reference/get-associated-devices-by-email.md - https://docs.aylanetworks.com/reference/get-associated-devices.md - https://docs.aylanetworks.com/reference/get-commands-1.md - https://docs.aylanetworks.com/reference/get-commands.md - https://docs.aylanetworks.com/reference/get-connection-history.md - https://docs.aylanetworks.com/reference/get-datapoint-by-device-id.md - https://docs.aylanetworks.com/reference/get-datapoint-by-dsn-id.md - https://docs.aylanetworks.com/reference/get-datapoints-by-dsn.md - https://docs.aylanetworks.com/reference/get-datapoints-in-group.md - https://docs.aylanetworks.com/reference/get-device-address.md - https://docs.aylanetworks.com/reference/get-device-by-device-id.md - https://docs.aylanetworks.com/reference/get-device-by-dsn-1.md - https://docs.aylanetworks.com/reference/get-device-by-dsn.md - https://docs.aylanetworks.com/reference/get-device-metadata-by-key.md - https://docs.aylanetworks.com/reference/get-device-metadata.md - https://docs.aylanetworks.com/reference/get-device-role-label.md - https://docs.aylanetworks.com/reference/get-group-by-id.md - https://docs.aylanetworks.com/reference/get-groups.md - https://docs.aylanetworks.com/reference/get-lan-data.md - https://docs.aylanetworks.com/reference/get-nodes-by-device-id-id117.md - https://docs.aylanetworks.com/reference/get-nodes-by-dsn-1.md - https://docs.aylanetworks.com/reference/get-nodes-by-dsn.md - https://docs.aylanetworks.com/reference/get-notification-app.md - https://docs.aylanetworks.com/reference/get-notification-by-id-1.md - https://docs.aylanetworks.com/reference/get-notification.md - https://docs.aylanetworks.com/reference/get-notifications.md - https://docs.aylanetworks.com/reference/get-properties-by-device-id.md - https://docs.aylanetworks.com/reference/get-properties-by-dsn.md - https://docs.aylanetworks.com/reference/get-registrable-device.md - https://docs.aylanetworks.com/reference/get-role-label.md - https://docs.aylanetworks.com/reference/get-schedule-action-by-id.md - https://docs.aylanetworks.com/reference/get-schedule-action-by-name.md - https://docs.aylanetworks.com/reference/get-schedule-action.md - https://docs.aylanetworks.com/reference/get-schedule-by-id.md - https://docs.aylanetworks.com/reference/get-schedules-for-user.md - https://docs.aylanetworks.com/reference/get-schedules.md - https://docs.aylanetworks.com/reference/get-template.md - https://docs.aylanetworks.com/reference/get-timezone-1.md - https://docs.aylanetworks.com/reference/get-timezone.md - https://docs.aylanetworks.com/reference/get-trigger-app.md - https://docs.aylanetworks.com/reference/get-trigger-apps.md - https://docs.aylanetworks.com/reference/get-trigger-by-id.md - https://docs.aylanetworks.com/reference/get-trigger.md - https://docs.aylanetworks.com/reference/gets-datapoint-by-device-id.md - https://docs.aylanetworks.com/reference/gets-property-by-device-di.md - https://docs.aylanetworks.com/reference/identify-zigbee-node-id115.md - https://docs.aylanetworks.com/reference/register-device-to-user.md - https://docs.aylanetworks.com/reference/register-device.md - https://docs.aylanetworks.com/reference/remove-device-from-group.md - https://docs.aylanetworks.com/reference/rename-device-by-device-id.md - https://docs.aylanetworks.com/reference/rename-group.md - https://docs.aylanetworks.com/reference/search-devices.md - https://docs.aylanetworks.com/reference/set-device-timezone.md - https://docs.aylanetworks.com/reference/transfer-registration.md - https://docs.aylanetworks.com/reference/unregister-a-device.md - https://docs.aylanetworks.com/reference/unregister-device.md - https://docs.aylanetworks.com/reference/update-device-address.md - https://docs.aylanetworks.com/reference/update-device-location-id116.md - https://docs.aylanetworks.com/reference/update-device-metadata.md - https://docs.aylanetworks.com/reference/update-notification.md - https://docs.aylanetworks.com/reference/update-role-label.md - https://docs.aylanetworks.com/reference/update-schedule-action.md - https://docs.aylanetworks.com/reference/update-schedule1.md - https://docs.aylanetworks.com/reference/update-trigger-app.md - https://docs.aylanetworks.com/reference/update-trigger1.md merge: pages: 106 deduped: 105 conflicts_kept_first: 0