[Index]
Model ref.: device/msgraph/CalendarView
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"allowNewTimeProposals": {
"type": "boolean",
"description": "True if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true."
},
"attendees": {
"type": "array",
"description": "The collection of attendees for the event.",
"items": {
"type": "object",
"description": "The collection of attendees for the event.",
"properties": {
"emailAddress": {
"type": "object",
"description": "Includes the name and SMTP address of the attendee.",
"properties": {
"address": {
"type": "string",
"description": "The email address of the person or entity."
},
"name": {
"type": "string",
"description": "The display name of the person or entity."
}
}
},
"proposedNewTime": {
"description": "An alternate date/time proposed by the attendee. Optional.",
"type": "object",
"properties": {
"end": {
"type": "object",
"description": "The date, time, and time zone that a period ends.",
"properties": {
"dateTime": {
"type": "string",
"description": "A single point of time in a combined date and time representation (e.g., 2017-08-29T04:00:00.0000000)."
},
"timeZone": {
"type": "string",
"description": "Represents a time zone, for example, \"Pacific Standard Time\"."
}
}
},
"start": {
"type": "object",
"description": "The date, time, and time zone that a period begins.",
"properties": {
"dateTime": {
"type": "string",
"description": "A single point of time in a combined date and time representation (e.g., 2017-08-29T04:00:00.0000000)."
},
"timeZone": {
"type": "string",
"description": "Represents a time zone, for example, \"Pacific Standard Time\"."
}
}
}
}
},
"status": {
"type": "object",
"description": "The attendee's response (none, accepted, declined, etc.) for the event and date-time that the response was sent.",
"properties": {
"response": {
"type": "string",
"description": "The response type. Possible values are: none, organizer, tentativelyAccepted, accepted, declined, notResponded.",
"choices": [
"none",
"organizer",
"tentativelyAccepted",
"accepted",
"declined",
"notResponded"
]
},
"time": {
"type": "string",
"description": "The date and time when the response was returned. ISO 8601 format and UTC time."
}
}
},
"type": {
"type": "string",
"description": "The attendee type: required, optional, resource.",
"choices": [
"required",
"optional",
"resource"
]
}
}
}
},
"body": {
"type": "object",
"description": "The body of the message associated with the event. It can be in HTML or text format.",
"properties": {
"content": {
"type": "string",
"description": "The content of the item."
},
"contentType": {
"type": "string",
"description": "The type of the content. Possible values are text and html.",
"choices": [
"text",
"html"
]
}
}
},
"bodyPreview": {
"type": "string",
"description": "The preview of the message associated with the event. It's in text format."
},
"cancelledOccurrences": {
"type": "array",
"description": "Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Read-only.",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"description": "The categories associated with the event.",
"items": {
"type": "string"
}
},
"changeKey": {
"type": "string",
"description": "Identifies the version of the event object. Read-only."
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time the event was created, in ISO 8601 format and UTC time."
},
"end": {
"type": "object",
"description": "The date, time, and time zone that the event ends.",
"properties": {
"dateTime": {
"type": "string",
"format": "date-time",
"description": "A single point of time in a combined date and time representation (e.g., 2017-08-29T04:00:00.0000000)."
},
"timeZone": {
"type": "string",
"description": "Represents a time zone, for example, \"Pacific Standard Time\"."
}
}
},
"endDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time the event ends, a copy of the end.dateTime property."
},
"hasAttachments": {
"type": "boolean",
"description": "Set to true if the event has attachments."
},
"hideAttendees": {
"type": "boolean",
"description": "When set to true, each attendee only sees themselves in the meeting request. The default is false."
},
"iCalUId": {
"type": "string",
"description": "A unique identifier for an event across calendars. Read-only."
},
"id": {
"type": "string",
"description": "Unique identifier for the event. Case-sensitive and read-only."
},
"importance": {
"type": "string",
"description": "The importance of the event.",
"choices": [
"low",
"normal",
"high"
]
},
"isAllDay": {
"type": "boolean",
"description": "Set to true if the event lasts all day."
},
"isCancelled": {
"type": "boolean",
"description": "Set to true if the event has been canceled."
},
"isDraft": {
"type": "boolean",
"description": "Set to true if the user has updated the meeting in Outlook but hasn't sent the updates."
},
"isOnlineMeeting": {
"type": "boolean",
"description": "True if this event has online meeting information (onlineMeeting points to a resource), false otherwise. Optional."
},
"isOrganizer": {
"type": "boolean",
"description": "Set to true if the calendar owner is the organizer of the event."
},
"isReminderOn": {
"type": "boolean",
"description": "Set to true if an alert is set to remind the user of the event."
},
"lastModifiedDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time the event was last modified, in ISO 8601 format and UTC time."
},
"location": {
"type": "object",
"description": "The location of the event.",
"properties": {
"address": {
"type": "object",
"description": "The street address of the location.",
"properties": {
"city": {
"type": "string",
"description": "The city."
},
"countryOrRegion": {
"type": "string",
"description": "The country or region. It's a free-format string value, for example, \"United States\"."
},
"postalCode": {
"type": "string",
"description": "The postal code."
},
"state": {
"type": "string",
"description": "The state."
},
"street": {
"type": "string",
"description": "The street."
}
}
},
"coordinates": {
"type": "object",
"description": "The geographic coordinates and elevation of the location.",
"properties": {
"accuracy": {
"type": [
"number",
"null"
],
"description": "The accuracy of the latitude and longitude."
},
"altitude": {
"type": [
"number",
"null"
],
"description": "The altitude of the location."
},
"altitudeAccuracy": {
"type": [
"number",
"null"
],
"description": "The accuracy of the altitude."
},
"latitude": {
"type": [
"number",
"null"
],
"description": "The latitude of the location."
},
"longitude": {
"type": [
"number",
"null"
],
"description": "The longitude of the location."
}
}
},
"displayName": {
"type": "string",
"description": "The name associated with the location."
},
"locationEmailAddress": {
"type": [
"string",
"null"
],
"description": "Optional email address of the location."
},
"locationUri": {
"type": [
"string",
"null"
],
"description": "Optional URI representing the location."
},
"locationType": {
"type": "string",
"description": "The type of location. Read-only.",
"choices": [
"default",
"conferenceRoom",
"homeAddress",
"businessAddress",
"geoCoordinates",
"streetAddress",
"hotel",
"restaurant",
"localBusiness",
"postalAddress"
]
},
"uniqueId": {
"type": [
"string",
"null"
],
"description": "For internal use only."
},
"uniqueIdType": {
"type": "string",
"description": "For internal use only.",
"choices": [
"unknown",
"private",
"public",
"recurringEvent"
]
}
}
},
"locations": {
"type": "array",
"description": "The locations where the event is held or attended from.",
"items": {
"type": "object",
"description": "The location of the event.",
"properties": {
"address": {
"type": "object",
"description": "The street address of the location.",
"properties": {
"city": {
"type": "string",
"description": "The city."
},
"countryOrRegion": {
"type": "string",
"description": "The country or region. It's a free-format string value, for example, \"United States\"."
},
"postalCode": {
"type": "string",
"description": "The postal code."
},
"state": {
"type": "string",
"description": "The state."
},
"street": {
"type": "string",
"description": "The street."
}
}
},
"coordinates": {
"type": "object",
"description": "The geographic coordinates and elevation of the location.",
"properties": {
"accuracy": {
"type": [
"number",
"null"
],
"description": "The accuracy of the latitude and longitude."
},
"altitude": {
"type": [
"number",
"null"
],
"description": "The altitude of the location."
},
"altitudeAccuracy": {
"type": [
"number",
"null"
],
"description": "The accuracy of the altitude."
},
"latitude": {
"type": [
"number",
"null"
],
"description": "The latitude of the location."
},
"longitude": {
"type": [
"number",
"null"
],
"description": "The longitude of the location."
}
}
},
"displayName": {
"type": "string",
"description": "The name associated with the location."
},
"locationEmailAddress": {
"type": [
"string",
"null"
],
"description": "Optional email address of the location."
},
"locationUri": {
"type": [
"string",
"null"
],
"description": "Optional URI representing the location."
},
"locationType": {
"type": "string",
"description": "The type of location. Read-only.",
"choices": [
"default",
"conferenceRoom",
"homeAddress",
"businessAddress",
"geoCoordinates",
"streetAddress",
"hotel",
"restaurant",
"localBusiness",
"postalAddress"
]
},
"uniqueId": {
"type": [
"string",
"null"
],
"description": "For internal use only."
},
"uniqueIdType": {
"type": "string",
"description": "For internal use only.",
"choices": [
"unknown",
"private",
"public",
"recurringEvent"
]
}
}
}
},
"onlineMeeting": {
"type": "object",
"description": "Information about the online meeting, such as the conference ID and join URL.",
"properties": {
"conferenceId": {
"type": [
"string",
"null"
],
"description": "The ID of the conference."
},
"joinUrl": {
"type": [
"string",
"null"
],
"description": "The external link that launches the online meeting."
},
"phones": {
"type": "array",
"description": "All of the phone numbers associated with this conference.",
"items": {
"type": "string"
}
},
"quickDial": {
"type": [
"string",
"null"
],
"description": "The preformatted quick dial for this call."
},
"tollFreeNumbers": {
"type": "array",
"description": "The toll free numbers that can be used to join the conference.",
"items": {
"type": "string"
}
},
"tollNumber": {
"type": [
"string",
"null"
],
"description": "The toll number that can be used to join the conference."
}
}
},
"onlineMeetingProvider": {
"type": "string",
"description": "Represents the online meeting service provider. Optional.",
"choices": [
"unknown",
"teamsForBusiness",
"skypeForBusiness",
"skypeForConsumer"
]
},
"onlineMeetingUrl": {
"type": "string",
"description": "A URL for an online meeting. Read-only. Will be deprecated."
},
"organizer": {
"type": "object",
"description": "The organizer of the event.",
"properties": {
"emailAddress": {
"type": "object",
"description": "The recipient's email address.",
"properties": {
"address": {
"type": "string",
"description": "The email address of the person or entity."
},
"name": {
"type": "string",
"description": "The display name of the person or entity."
}
}
}
}
},
"originalEndTimeZone": {
"type": "string",
"description": "The end time zone that was set when the event was created."
},
"originalStartDateTimeOffset": {
"type": [
"string",
"null"
],
"description": "Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. UTC."
},
"originalStartTimeZone": {
"type": "string",
"description": "The start time zone that was set when the event was created."
},
"recurrence": {
"type": "object",
"description": "The recurrence pattern for the event.",
"properties": {
"pattern": {
"type": "object",
"description": "The frequency of an event.",
"properties": {
"dayOfMonth": {
"type": [
"integer",
"null"
],
"description": "The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly."
},
"daysOfWeek": {
"type": "array",
"description": "A collection of the days of the week on which the event occurs. Required if type is weekly, relativeMonthly, or relativeYearly.",
"items": {
"type": "string",
"choices": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
}
},
"firstDayOfWeek": {
"type": "string",
"description": "The first day of the week. Default is sunday. Required if type is weekly.",
"choices": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
},
"index": {
"type": "string",
"description": "Specifies on which instance of the allowed days the event occurs. Optional and used if type is relativeMonthly or relativeYearly. Default is first.",
"choices": [
"first",
"second",
"third",
"fourth",
"last"
]
},
"interval": {
"type": "integer",
"description": "The number of units between occurrences. Required."
},
"month": {
"type": [
"integer",
"null"
],
"description": "The month in which the event occurs. This is a number from 1 to 12."
},
"type": {
"type": "string",
"description": "The recurrence pattern type. Required.",
"choices": [
"daily",
"weekly",
"absoluteMonthly",
"relativeMonthly",
"absoluteYearly",
"relativeYearly"
]
}
}
},
"range": {
"type": "object",
"description": "The duration of an event.",
"properties": {
"endDate": {
"type": [
"string",
"null"
],
"description": "The date to stop applying the recurrence pattern. Required if type is endDate."
},
"numberOfOccurrences": {
"type": [
"integer",
"null"
],
"description": "The number of times to repeat the event. Required and must be positive if type is numbered."
},
"recurrenceTimeZone": {
"type": [
"string",
"null"
],
"description": "Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used."
},
"startDate": {
"type": "string",
"description": "The date to start applying the recurrence pattern. Required."
},
"type": {
"type": "string",
"description": "The recurrence range. Required.",
"choices": [
"endDate",
"noEnd",
"numbered"
]
}
}
}
}
},
"reminderMinutesBeforeStart": {
"type": "integer",
"description": "The number of minutes before the event start time that the reminder alert occurs."
},
"responseRequested": {
"type": "boolean",
"description": "Default is true, which represents the organizer would like an invitee to send a response to the event."
},
"responseStatus": {
"type": "object",
"description": "Indicates the type of response sent in response to an event message.",
"properties": {
"response": {
"type": "string",
"description": "The response type. Possible values are: none, organizer, tentativelyAccepted, accepted, declined, notResponded.",
"choices": [
"none",
"organizer",
"tentativelyAccepted",
"accepted",
"declined",
"notResponded"
]
},
"time": {
"type": "string",
"description": "The date and time when the response was returned. ISO 8601 format and UTC time."
}
}
},
"sensitivity": {
"type": "string",
"description": "Possible values are: normal, personal, private, and confidential.",
"choices": [
"normal",
"personal",
"private",
"confidential"
]
},
"seriesMasterId": {
"type": "string",
"description": "The ID for the recurring series master item, if this event is part of a recurring series."
},
"showAs": {
"type": "string",
"description": "The status to show.",
"choices": [
"free",
"tentative",
"busy",
"oof",
"workingElsewhere",
"unknown"
]
},
"start": {
"type": "object",
"description": "The start date, time, and time zone of the event.",
"properties": {
"dateTime": {
"type": "string",
"format": "date-time",
"description": "A single point of time in a combined date and time representation (e.g., 2017-08-29T04:00:00.0000000)."
},
"timeZone": {
"type": "string",
"description": "Represents a time zone, for example, \"Pacific Standard Time\"."
}
}
},
"subject": {
"type": "string",
"description": "The text of the event's subject line."
},
"transactionId": {
"type": [
"string",
"null"
],
"description": "A custom identifier specified by a client app for the server to avoid redundant POST operations."
},
"type": {
"type": "string",
"description": "The event type. Read-only.",
"choices": [
"singleInstance",
"occurrence",
"exception",
"seriesMaster"
]
},
"webLink": {
"type": "string",
"description": "The URL to open the event in Outlook on the web."
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msgraph/CalendarView/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msgraph/CalendarView/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msgraph/CalendarView/[pkid1]", "/api/v0/device/msgraph/CalendarView/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msgraph/CalendarView/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msgraph/CalendarView |
|
{"hrefs": ["/api/device/msgraph/CalendarView/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msgraph/CalendarView |
|
{"hrefs": ["/api/device/msgraph/CalendarView/[pkid1]", "/api/device/msgraph/CalendarView/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msgraph/CalendarView; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msgraph/CalendarView/export/ |
|
{ "hrefs":["/api/device/msgraph/CalendarView/[pkid1]", "/api/device/msgraph/CalendarView/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/msgraph/CalendarView and the JSON format can be used to import instances of device/msgraph/CalendarView.
GET http://[host-proxy]/api/device/msgraph/CalendarView/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msgraph/CalendarView | POST | /api/device/msgraph/CalendarView/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msgraph/CalendarView/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msgraph/CalendarView/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msgraph/CalendarView/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msgraph/CalendarView/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msgraph/CalendarView/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msgraph/CalendarView/ |
|
The device/msgraph/CalendarView schema and all instances as JSON. |
(The list will return 0 to 3 device/msgraph/CalendarView instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "iCalUId",
"direction": "asc",
"current": "/api/device/msgraph/CalendarView/?skip=0&limit=3&order_by=iCalUId&direction=asc&traversal=down"
},
"operations": [
"list",
"list_room_mailboxes"
],
"meta": {
"model_type": "device/msgraph/CalendarView",
"summary_attrs": [
{
"name": "iCalUId",
"title": "Icaluid"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"list",
"list_room_mailboxes",
"get_calendar_view",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"schema_version": "1.0",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msgraph/CalendarView/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msgraph/CalendarView",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msgraph/CalendarView/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/msgraph/CalendarView/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msgraph/CalendarView/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msgraph/CalendarView/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/msgraph/CalendarView/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msgraph/CalendarView/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msgraph/CalendarView/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msgraph/CalendarView/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msgraph/CalendarView/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"list_room_mailboxes": {
"method": "POST",
"class": "custom",
"href": "/api/device/msgraph/CalendarView/+list_room_mailboxes/?hierarchy=[hierarchy]",
"support_async": true,
"title": "List Room Mailboxes"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msgraph/CalendarView/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msgraph/CalendarView/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msgraph/CalendarView. | GET | /api/device/msgraph/CalendarView/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msgraph/CalendarView as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List Room Mailboxes | POST | /api/device/msgraph/CalendarView/+list_room_mailboxes/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msgraph/CalendarView/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msgraph/CalendarView/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msgraph/CalendarView | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/msgraph/CalendarView; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msgraph/CalendarView/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/msgraph/CalendarView and the JSON format can be used to import instances of device/msgraph/CalendarView.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msgraph/CalendarView/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msgraph/CalendarView/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msgraph/CalendarView. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get Calendar View | POST | /api/device/msgraph/CalendarView/[pkid]/+get_calendar_view | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msgraph/CalendarView/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |