Skip to content
v3 API/
/
Generate a description of...

Generate a description of a schedule's recurrence

Request

POST /v3/schedules/rule-description
Security
API_Key
Bodyapplication/json
recurrenceRulestringrequired

An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.

POST
/v3/schedules/rule-description
curl -i -X POST \
  https://api.observepoint.com/v3/schedules/rule-description \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "recurrenceRule": "string"
  }'

Responses

Successful operation

Bodyapplication/json
descriptionstringrequired

A description of the schedule.

Response
{
  "description": "string"
}