Get schedules

Get schedules in org

POST /api/schedule/getSchedules

Get schedules

cURL

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 '{}'

200

{
  "absoluteSchedules": [
    {
      "intervalList": [
        {
          "b": 123,
          "e": 123
        }
      ],
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "relativeDatetimeSchedules": [
    {
      "intervals": [
        {
          "localEndDateTime": "<string>",
          "localStartDateTime": "<string>"
        }
      ],
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "relativeSchedules": [
    {
      "pastSeconds": 123,
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>",
  "weeklySchedules": [
    {
      "intervalList": [
        {
          "minuteOfWeekStart": 123,
          "minuteOfWeekStop": 123
        }
      ],
      "mutable": true,
      "name": "<string>",
      "oneTimeUse": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

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

Show child attributes

error · boolean | null

errorMsg · string | null

relativeDatetimeSchedules · object[] | null

List of relative datetime intervals schedules

Show child attributes

relativeSchedules · object[] | null

List of relative schedules

Show child attributes

warningMsg · string | null

weeklySchedules · object[] | null

List of weekly repeating schedules

Show child attributes