Rollup Calendar Resource

A rollup_calendar resource describes how a stream's base cycle intervals are available for roll-ups.

A rollup_calendar is defined by the collection of cycles it references. Each set of intervals described by a cycle must fit evenly into the parent cycle or an error will be raised when the rollup_calendar is PUT or POSTed.

Example:
A user wishes to roll-up one second interval data into one hour interval data, then into one day interval data. The user first creates three cycles:

• A one second cycle
• A one hour cycle
• A one day cycle

The user then creates a rollup_calendar that references the three cycles and then associates the rollup_calendar to a stream. When the stream's base cycle feed is updated that data will immediately be available as rolled-up data in the form defined by the rollup_calendar.

GET rollup_calendar

---

Return a list of rollup_calendars resources.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Parameters

none

Example Requests

/rollup_calendar

Response Body
{
  "message": "",
  "rollup_calendar": [
    {
      "uid": "44883840-e1b1-4645-b163-84a0ddce6467",
      "description": "RollupCalendar Description",
      "name": "Years, Months"
    },
    {
      "uid": "47c1cb97-b669-417d-a0a9-aedfeabfbc16",
      "description": "RollupCalendar Description",
      "name": "Years, Quarters, Months, Days, Hour, FiveMin"
    }
  ],
  "success": true
}

GET rollup_calendar/{rollup_calendarUid}

---

Return the rollup_calendar with the specified uid.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Parameters

none

Example Requests

/rollup_calendar/47c1cb97-b669-417d-a0a9-aedfeabfbc16

Response Body
{
  "message": "",
  "rollup_calendar": {
    "uid": "47c1cb97-b669-417d-a0a9-aedfeabfbc16",
    "cycle": [
      {
        "uid": "b0beb213-0661-49c3-a61c-710c5ac7d789",
        "name": "5 Minutes"
      },
      {
        "uid": "47902dcf-aa0f-4eb5-bb7d-058e37d5d098",
        "name": "Hours"
      },
      {
        "uid": "e44b4a14-f15b-483a-953b-f1715a494042",
        "name": "Days"
      },
      {
        "uid": "ba6a07e5-57b7-4f19-8df7-c791049c284a",
        "name": "Months"
      },
      {
        "uid": "22512ed5-a48a-45f9-b6dd-5f3a77385c61",
        "name": "Quarters"
      },
      {
        "uid": "df05653e-d86a-4406-81fd-b19351041943",
        "name": "Years"
      }
    ],
    "description": "RollupCalendar Description",
    "name": "Years, Quarters, Months, Days, Hour, FiveMin"
  },
  "success": true
}

GET rollup_calendar/new

---

Returns a default rollup_calendar entity with a unique UID. Does not persist the new rollup_calendar entity. It's the callers responsibility to PUT the new rollup_calendar and register it.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Parameters

none

Example Requests

/rollup_calendar/new

Response Body

{
  "message": "",
  "rollup_calendar": {
    "uid": "47c1cb97-b669-417d-a0a9-aedfeabfbc16",
    "cycle": [
    ],
    "description": "",
    "name": ""
  },
  "success": true
}

PUT rollup_calendar

---

Inserts a new rollup_calendar. The uid of the rollup_calendar can be blank. If it is blank a uid will be created on the server and the response body will contain the new uid.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Parameters

parentFolderUid

optional

The UID of the tools content repository folder to place this new rollup_calendar into. The new rollup_calendar will be placed into the root folder if this parameter is missing.

Example Requests

/rollup_calendar

Request Body
{
  "rollup_calendar": {
    "uid": "47c1cb97-b669-417d-a0a9-aedfeabfbc16",
    "cycle": [
      {
        "uid": "b0beb213-0661-49c3-a61c-710c5ac7d789",
        "name": "5 Minutes"
      },
      {
        "uid": "47902dcf-aa0f-4eb5-bb7d-058e37d5d098",
        "name": "Hours"
      },
      {
        "uid": "e44b4a14-f15b-483a-953b-f1715a494042",
        "name": "Days"
      },
      {
        "uid": "ba6a07e5-57b7-4f19-8df7-c791049c284a",
        "name": "Months"
      },
      {
        "uid": "22512ed5-a48a-45f9-b6dd-5f3a77385c61",
        "name": "Quarters"
      },
      {
        "uid": "df05653e-d86a-4406-81fd-b19351041943",
        "name": "Years"
      }
    ],
    "description": "RollupCalendar Description",
    "name": "Years, Quarters, Months, Days, Hour, FiveMin"
  }
}

POST rollup_calendar

---

Used to update rollup_calendar information.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Parameters

none

Example Requests

/rollup_calendar

Request Body
{
  "rollup_calendar": {
    "uid": "47c1cb97-b669-417d-a0a9-aedfeabfbc16",
    "cycle": [
      {
        "uid": "b0beb213-0661-49c3-a61c-710c5ac7d789",
        "name": "5 Minutes"
      },
      {
        "uid": "47902dcf-aa0f-4eb5-bb7d-058e37d5d098",
        "name": "Hours"
      },
      {
        "uid": "e44b4a14-f15b-483a-953b-f1715a494042",
        "name": "Days"
      },
      {
        "uid": "ba6a07e5-57b7-4f19-8df7-c791049c284a",
        "name": "Months"
      },
      {
        "uid": "22512ed5-a48a-45f9-b6dd-5f3a77385c61",
        "name": "Quarters"
      },
      {
        "uid": "df05653e-d86a-4406-81fd-b19351041943",
        "name": "Years"
      }
    ],
    "description": "RollupCalendar Description",
    "name": "Years, Quarters, Months, Days, Hour, FiveMin"
  }
}

DELETE rollup_calendar/{rollup_calendarUid}

---

Deletes a rollup_calendar and all resources that belong to it.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Parameters

none

Example Requests

/rollup_calendar/d251a8f2-f7b9-4df7-886d-b24c7f4929d4

Response Body
{
    "message" : "Deleted RollupCalendar with uid 'd251a8f2-f7b9-4df7-886d-b24c7f4929d4'",    "success" : true
}