Skip to main content
POST
/
api
/
schedule
/
getSchedules
Get schedules
curl --request POST \
  --url https://api2.rhombussystems.com/api/schedule/getSchedules \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "absoluteSchedules": [
    {
      "intervalList": [
        {
          "b": 123,
          "e": 123
        }
      ],
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "strategy": "WEEKLY_REPEATING_MINUTES",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "relativeDatetimeSchedules": [
    {
      "intervals": [
        {
          "localEndDateTime": "<string>",
          "localStartDateTime": "<string>"
        }
      ],
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "strategy": "WEEKLY_REPEATING_MINUTES",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "relativeSchedules": [
    {
      "pastSeconds": 123,
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "strategy": "WEEKLY_REPEATING_MINUTES",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>",
  "weeklySchedules": [
    {
      "intervalList": [
        {
          "minuteOfWeekStart": 123,
          "minuteOfWeekStop": 123
        }
      ],
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "strategy": "WEEKLY_REPEATING_MINUTES",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting all schedules.

Response

200 - application/json

OK

Response object for getting all schedules.

absoluteSchedules
object[] | null

List of absolute schedules

error
boolean | null
errorMsg
string | null
relativeDatetimeSchedules
object[] | null

List of relative datetime intervals schedules

relativeSchedules
object[] | null

List of relative schedules

warningMsg
string | null
weeklySchedules
object[] | null

List of weekly repeating schedules