diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a5c9fbb68510..62576c13b20d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,6 @@ Thank you for your interest in Microsoft Graph documentation! * [Ways to contribute](#ways-to-contribute) * [Before we can accept your pull request](#before-we-can-accept-your-pull-request) -* [Repository organization](#repository-organization) * [Use GitHub, Git, and this repository](#use-github-git-and-this-repository) * [How to use Markdown to format your topic](#how-to-use-markdown-to-format-your-topic) * [Standard Markdown](#standard-markdown) @@ -15,6 +14,8 @@ Thank you for your interest in Microsoft Graph documentation! You can contribute to [Microsoft Graph documentation](http://graph.microsoft.io) in these ways: * Contribute to articles via the [public Office developer docs repo](https://github.com/OfficeDev/microsoft-graph-docs) + * Send separate pull requests into /beta and/or /v1.0 branches. This step is required to ensure that version branches are update to date with the latest changes. + * In addition, send separate pull requests to /master branch. This step is to ensure the Microsoft Grph website documentation site gets updated with the latest changes. * Report documentation bugs via [GitHub Issues](https://github.com/OfficeDev/microsoft-graph-docs/issues) * Add documentation requests to the [Office Developer Platform UserVoice](http://officespdev.uservoice.com) @@ -40,12 +41,6 @@ You can download the Contribution License Agreement (CLA) [here](https://github. Once we receive and process your CLA, we'll do our best to review your pull requests within 10 business days. -## Repository organization - -The content in the microsoft-graph-docs repository is grouped first by article language, then by topic. The README.md file at the root of each topic directory specifies the structure of the articles within the topic. - -Articles within each topic are named by MSDN GUID, not by title. This is a side effect of our document management process and can't be changed at this time. We highly recommend using the table of contents within each topic directory to navigate to the files you wish to view or edit. For more information, please see [README.md](https://github.com/OfficeDev/microsoft-graph-docs/blob/master/README.md). - ## Use GitHub, Git, and this repository **Note:** Most of the information in this section can be found in [GitHub Help] [] articles. If you're familiar with Git and GitHub, skip to the **Contribute and edit content** section for the particulars of the code/content flow of this repository. diff --git a/README.md b/README.md index 8f6e87e940a55..73ec8985d0026 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Thank you for your interest in Microsoft Graph documentation! ## Ways to contribute -You can contribute to [Microsoft Graph documentation](http://graph.microsoft.io) in these ways: +You can contribute to [Microsoft Graph documentation](http://graph.microsoft.io/docs) in these ways: * Contribute to articles via the [public Office developer docs repo](https://github.com/OfficeDev/microsoft-graph-docs) * Report documentation bugs via [GitHub Issues](https://github.com/OfficeDev/microsoft-graph-docs/issues) diff --git a/api-reference/beta/api/administrativeunit_delete.md b/api-reference/beta/api/administrativeunit_delete.md new file mode 100644 index 0000000000000..1d7466a4f253b --- /dev/null +++ b/api-reference/beta/api/administrativeunit_delete.md @@ -0,0 +1,53 @@ +# Delete administrativeUnit +Delete an [administrativeUnit](../resources/administrativeunit.md). + +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +DELETE /administrativeUnits/ + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. + + +## Response +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +DELETE https://graph.microsoft.com/beta/administrativeUnits/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 204 No Content +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/administrativeunit_delete_members.md b/api-reference/beta/api/administrativeunit_delete_members.md new file mode 100644 index 0000000000000..ea932e6988a29 --- /dev/null +++ b/api-reference/beta/api/administrativeunit_delete_members.md @@ -0,0 +1,37 @@ +# Remove a member + +Use this API to remove a member (user or group) from an administrative unit. + +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +DELETE /administrativeUnits//members//$ref +``` +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +## Example +##### Request +Here is an example of the request. In the example below, id1 represents the identifier for the target administrative unit, and id2 represents the unique identifier for the member user or group to be removed from the targetted administrative unit. + +```http +DELETE https://graph.microsoft.com/beta/administrativeUnits//members//$ref +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/administrativeunit_delete_scopedadministrators.md b/api-reference/beta/api/administrativeunit_delete_scopedadministrators.md new file mode 100644 index 0000000000000..0692d0ba03ebe --- /dev/null +++ b/api-reference/beta/api/administrativeunit_delete_scopedadministrators.md @@ -0,0 +1,53 @@ +# Delete scoped-role administrators +Delete a scoped-role administrator from an adminstrative unit. + +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +DELETE /administrativeUnits//scopedAdministrators/ + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. + + +## Response +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +DELETE https://graph.microsoft.com/beta/administrativeUnits//scopedAdministrators/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 204 No Content +``` + + + \ No newline at end of file diff --git a/api-reference/v1.0/api/outlookitem_get.md b/api-reference/beta/api/administrativeunit_get.md similarity index 51% rename from api-reference/v1.0/api/outlookitem_get.md rename to api-reference/beta/api/administrativeunit_get.md index abab792389850..a47d9d74dead8 100644 --- a/api-reference/v1.0/api/outlookitem_get.md +++ b/api-reference/beta/api/administrativeunit_get.md @@ -1,52 +1,52 @@ -# Get outlookItem +# Get administrativeUnit -Retrieve the properties and relationships of outlookitem object. -### Prerequisites -One of the following **scopes** is required to execute this API: -### HTTP request +Retrieve the properties and relationships of an [administrativeUnit](../resources/administrativeunit.md) object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All*. + +## HTTP request ```http - +GET /administrativeUnits/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | -### Request body +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and [outlookItem](../resources/outlookitem.md) object in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and [administrativeUnit](../resources/administrativeunit.md) object in the response body. +## Example ##### Request Here is an example of the request. ```http - +GET https://graph.microsoft.com/beta/administrativeUnits/ ``` ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 185 +Content-length: 134 { - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value", - "changeKey": "changeKey-value", - "categories": [ - "categories-value" - ], + "displayName": "displayName-value", + "description": "description-value", + "visibility": "visibility-value", "id": "id-value" } ``` @@ -55,7 +55,7 @@ Content-length: 185 2015-10-25 14:57:30 UTC --> +```http +GET /administrativeUnits//scopedAdministrators/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and the requested [scopedRoleMembership](../resources/scopedrolemembership.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/administrativeUnits//scopedAdministrators/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 307 + +{ + "id": "id-value", + "roleId": "roleId-value", + "administrativeUnitId": "administrativeUnitId-value", + "roleMemberInfo": { + "id": "id-value", + "displayName": "displayName-value", + "userPrincipalName": "userPrincipalName-value" + } +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/user_list_joinedgroups.md b/api-reference/beta/api/administrativeunit_list.md similarity index 52% rename from api-reference/beta/api/user_list_joinedgroups.md rename to api-reference/beta/api/administrativeunit_list.md index 07d9764ef0c25..cf33e2264e0ac 100644 --- a/api-reference/beta/api/user_list_joinedgroups.md +++ b/api-reference/beta/api/administrativeunit_list.md @@ -1,60 +1,56 @@ -# List joinedGroups +# List administrativeUnits -Retrieve a list of group objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of [administrativeUnit](../resources/administrativeunit.md) objects. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All*. + +## HTTP request ```http -GET /users//joinedGroups -GET /drive/root/createdByUser/joinedGroups -GET /drive/root/lastModifiedByUser/joinedGroups +GET /administrativeUnits ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [Group](../resources/group.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [administrativeUnit](../resources/administrativeunit.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http -GET https://graph.microsoft.com/beta/me/joinedGroups +GET https://graph.microsoft.com/beta/administrativeUnits ``` ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 272 +Content-length: 179 { "value": [ { - "description": "description-value", "displayName": "displayName-value", - "groupTypes": [ - "groupTypes-value" - ], - "mail": "mail-value", - "mailEnabled": true, - "mailNickname": "mailNickname-value" + "description": "description-value", + "visibility": "visibility-value", + "id": "id-value" } ] } @@ -64,7 +60,7 @@ Content-length: 272 2015-10-25 14:57:30 UTC --> +```http +GET /administrativeUnits//scopedAdministrators +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [scopedRoleMembership](../resources/scopedrolemembership.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/administrativeUnits//scopedAdministrators +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 307 + +{ + "value": [ + { + "id": "id-value", + "roleId": "roleId-value", + "administrativeUnitId": "administrativeUnitId-value", + "roleMemberInfo": { + "id": "id-value", + "displayName": "displayName-value", + "userPrincipalName": "userPrincipalName-value" + } + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/administrativeunit_post_administrativeunits.md b/api-reference/beta/api/administrativeunit_post_administrativeunits.md new file mode 100644 index 0000000000000..835c6c915864d --- /dev/null +++ b/api-reference/beta/api/administrativeunit_post_administrativeunits.md @@ -0,0 +1,75 @@ +# Create administrativeUnit + +Use this API to create a new [administrativeUnit](../resources/administrativeunit.md). +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +POST /administrativeUnits + +``` +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| +## Request body +In the request body, supply a JSON representation of [administrativeUnit](../resources/administrativeunit.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [administrativeUnit](../resources/administrativeunit.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/administrativeUnits +Content-type: application/json +Content-length: 150 + +{ + "administrativeUnit": { + "displayName": "displayName-value", + "description": "description-value", + "visibility": "visibility-value" + } +} +``` +In the request body, supply a JSON representation of [administrativeUnit](../resources/administrativeunit.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 172 + +{ + "administrativeUnit": { + "displayName": "displayName-value", + "description": "description-value", + "visibility": "visibility-value", + "id": "id-value" + } +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/administrativeunit_post_members.md b/api-reference/beta/api/administrativeunit_post_members.md new file mode 100644 index 0000000000000..5feb2a3398a76 --- /dev/null +++ b/api-reference/beta/api/administrativeunit_post_members.md @@ -0,0 +1,47 @@ +# Add a member + +Use this API to add a member (user or group) to an administrative unit. + +`NOTE: Currently it's only possible to add one member at a time to an administrative unit.` + +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +POST /administrativeUnits//members/$ref +``` +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +In the request body, supply a JSON representation of a [user](../resources/user.md), [group](../resources/group.md) or [directoryObject](../resources/directoryObject.md) to be added. + +## Response +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/administrativeUnits//members/$ref +Content-type: application/json +Content-length: 109 + +{ + "@odata.id":"https://graph.microsoft.com/beta/groups/%3Cid%3E" +} + +``` +In the request body, supply a JSON representation of the `id` of the [user](../resources/user.md) or [group](../resources/group.md) object you want to add. + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/administrativeunit_post_scopedadministrators.md b/api-reference/beta/api/administrativeunit_post_scopedadministrators.md new file mode 100644 index 0000000000000..346ae4c0e4fe4 --- /dev/null +++ b/api-reference/beta/api/administrativeunit_post_scopedadministrators.md @@ -0,0 +1,78 @@ +# Create scopedRoleMembership + +Use this API to create a new [scopedRoleMembership](../resources/scopedrolemembership.md). NOTE: Only the *User account administrator* and *Helpdesk administrator* roles are supported for scoped-role memberships. + +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +POST /administrativeUnits//scopedAdministrators +``` +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +In the request body, supply a JSON representation of [scopedRoleMembership](../resources/scopedrolemembership.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [scopedRoleMembership](../resources/scopedrolemembership.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/administrativeUnits//scopedAdministrators +Content-type: application/json +Content-length: 272 + +{ + "roleId": "roleId-value", + "roleMemberInfo": { + "id": "id-value" + } +} +``` +In the request body, supply a JSON representation of [scopedRoleMembership](../resources/scopedrolemembership.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 294 + +{ + "@odata.context":"https://graph.microsoft.com/beta/$metadata#scopedRoleMemberships/$entity", + "administrativeUnitId": "administrativeUnitId-value", + "roleId": "roleId-value", + "roleMemberInfo": { + "id": "id-value", + "displayName": "displayName-value", + "userPrincipalName": "userPrincipalName-value" + }, + "id": "id-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/administrativeunit_update.md b/api-reference/beta/api/administrativeunit_update.md new file mode 100644 index 0000000000000..3db5c619d96ea --- /dev/null +++ b/api-reference/beta/api/administrativeunit_update.md @@ -0,0 +1,66 @@ +# Update administrativeunit + +Update the properties of an [administrativeUnit](../resources/administrativeunit.md) object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request + +```http +PATCH /administrativeUnits/ +``` +## Optional request headers +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|description|string|Description for the administrative unit.| +|displayName|string|Display name for the administrative unit.| +|visibility|string|Visibility for the administrative unit. If not set then the default is "public". Can be set to "HiddenMembership", which hides the membership from non-members.| + +## Response +If successful, this method returns a `200 OK` response code and updated [administrativeUnit](../resources/administrativeunit.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/administrativeUnits/ +Content-type: application/json +Content-length: 114 + +{ + "displayName": "displayName-value", + "description": "description-value", + "visibility": "visibility-value" +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 204 No content +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/anonymousipriskevent_get.md b/api-reference/beta/api/anonymousipriskevent_get.md new file mode 100644 index 0000000000000..d6f178173d2fe --- /dev/null +++ b/api-reference/beta/api/anonymousipriskevent_get.md @@ -0,0 +1,69 @@ +# Get anonymousIpRiskEvent + +Retrieve the properties and relationships of an anonymousipriskevent object. +## Prerequisites +The following **scopes** are required to execute this API: +*IdentityRiskEvent.Read.All* +## HTTP request + +```http +GET /anonymousIpRiskEvents/ +``` + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | +| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [anonymousIpRiskEvent](../resources/anonymousipriskevent.md) object in the value of response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/v1.0/anonymousIpRiskEvents/2016-01-29T00:00:56.22556656a56d0b2-3c51-7c5e-bc1a-1ccdb3bd9c71 +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 237 + +{ + "closedDateTime": "2016-01-29T20:03:57.7872426Z", + "createdDateTime": "2016-01-29T00:01:49.126468Z", + "id": "2016-01-29T00:00:56.22556656a56d0b2-3c51-7c5e-bc1a-1ccdb3bd9c71", + "ipAddress": null, + "location": null, + "riskEventDateTime": "2016-01-29T00:00:56.2255665Z", + "riskEventStatus": "remediated", + "riskLevel": "medium", + "riskType": "AnonymousIpRiskEvent", + "userDisplayName": "Jon Doe", + "userId": "6a56d0b2-3c51-7c5e-bc1a-1ccdb3bd9c71", + "userPrincipalName": "jon@contoso.com" +} +``` + + + diff --git a/api-reference/beta/api/anonymousipriskevent_list.md b/api-reference/beta/api/anonymousipriskevent_list.md new file mode 100644 index 0000000000000..1ee11a077b757 --- /dev/null +++ b/api-reference/beta/api/anonymousipriskevent_list.md @@ -0,0 +1,74 @@ +# List anonymousIpRiskEvents + +Retrieve a list of anonymousipriskevent objects. +## Prerequisites +The following **scopes** are required to execute this API: +*IdentityRiskEvent.Read.All* +## HTTP request + +```http +GET /anonymousIpRiskEvents +``` + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | +| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [anonymousIpRiskEvent](../resources/anonymousipriskevent.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/v1.0/anonymousIpRiskEvents +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 290 + +{ + "value": [ + { + "closedDateTime": "2016-01-29T20:03:57.7872426Z", + "createdDateTime": "2016-01-29T00:01:49.126468Z", + "id": "2016-01-29T00:00:56.22556656a56d0b2-3c51-7c5e-bc1a-1ccdb3bd9c71", + "ipAddress": null, + "location": null, + "riskEventDateTime": "2016-01-29T00:00:56.2255665Z", + "riskEventStatus": "remediated", + "riskLevel": "medium", + "riskType": "AnonymousIpRiskEvent", + "userDisplayName": "Jon Doe", + "userId": "6a56d0b2-3c51-7c5e-bc1a-1ccdb3bd9c71", + "userPrincipalName": "jon@contoso.com" + } + ] +} +``` + + + diff --git a/api-reference/beta/api/application_delete.md b/api-reference/beta/api/application_delete.md index bd219a01905d7..0a022cf49fd59 100644 --- a/api-reference/beta/api/application_delete.md +++ b/api-reference/beta/api/application_delete.md @@ -1,27 +1,27 @@ # Delete application Delete application. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http DELETE /applications/ ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http GET /applications/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [application](../resources/application.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 636 diff --git a/api-reference/beta/api/application_list_extensionproperties.md b/api-reference/beta/api/application_list_extensionproperties.md index 5246cc26d74f5..6f3ef8bd94dce 100644 --- a/api-reference/beta/api/application_list_extensionproperties.md +++ b/api-reference/beta/api/application_list_extensionproperties.md @@ -1,26 +1,26 @@ # List extensionProperties Retrieve a list of extensionproperty objects. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http GET /applications//extensionProperties ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [extensionProperty](../resources/extensionproperty.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 269 diff --git a/api-reference/beta/api/application_list_owners.md b/api-reference/beta/api/application_list_owners.md index a49ef9e44e2a5..128adb85c6b7c 100644 --- a/api-reference/beta/api/application_list_owners.md +++ b/api-reference/beta/api/application_list_owners.md @@ -1,26 +1,26 @@ # List owners Retrieve a list of directoryobject objects. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http GET /applications//owners ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 55 diff --git a/api-reference/beta/api/application_post_applications.md b/api-reference/beta/api/application_post_applications.md index 6d8cceac11a10..0ba03571589a4 100644 --- a/api-reference/beta/api/application_post_applications.md +++ b/api-reference/beta/api/application_post_applications.md @@ -1,27 +1,28 @@ # Create Application Use this API to create a new Application. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request + +## HTTP request ```http - - +POST /applications ``` -### Request headers + +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +| Authorization | string | Bearer {token}. Required. | -### Request body +## Request body In the request body, supply a JSON representation of [application](../resources/application.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [application](../resources/application.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 717 @@ -122,4 +121,4 @@ Content-length: 717 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/application_post_extensionproperties.md b/api-reference/beta/api/application_post_extensionproperties.md index cc45b8efa7caa..bf121d920c06f 100644 --- a/api-reference/beta/api/application_post_extensionproperties.md +++ b/api-reference/beta/api/application_post_extensionproperties.md @@ -1,27 +1,27 @@ # Create extensionProperty Use this API to create a new extensionProperty. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http POST /applications//extensionProperties ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply a JSON representation of [extensionProperty](../resources/extensionproperty.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [extensionProperty](../resources/extensionproperty.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 253 diff --git a/api-reference/beta/api/application_post_owners.md b/api-reference/beta/api/application_post_owners.md index d00bcb33db512..0cdbf72a1d61a 100644 --- a/api-reference/beta/api/application_post_owners.md +++ b/api-reference/beta/api/application_post_owners.md @@ -1,27 +1,27 @@ # Create owner Use this API to create a new owner. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http POST /applications//owners ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 51 diff --git a/api-reference/beta/api/application_restore.md b/api-reference/beta/api/application_restore.md index 6d5459ca32fd8..e93039eda7a97 100644 --- a/api-reference/beta/api/application_restore.md +++ b/api-reference/beta/api/application_restore.md @@ -1,30 +1,30 @@ # application: restore -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request ```http -POST /applications//Microsoft.Graph.restore +POST /applications//restore ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:---------------|:--------|:----------| |identifierUris|String|| -### Response +## Response If successful, this method returns `200, OK` response code and [application](../resources/application.md) object in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. @@ -33,7 +33,7 @@ Here is an example of the request. "name": "application_restore" }--> ```http -POST https://graph.microsoft.com/beta/applications//Microsoft.Graph.restore +POST https://graph.microsoft.com/beta/applications//restore Content-type: application/json Content-length: 56 @@ -48,7 +48,7 @@ Content-length: 56 Here is an example of the response. ```http @@ -90,9 +90,9 @@ Content-length: 2150 } ], "knownClientApplications": [ - "knownClientApplications-value" + "guid" ], - "mainLogo": "mainLogo-value", + "mainLogo": "stream", "logoutUrl": "logoutUrl-value", "oauth2AllowImplicitFlow": true, "oauth2AllowUrlPathMatching": true, @@ -148,4 +148,4 @@ Content-length: 2150 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/application_update.md b/api-reference/beta/api/application_update.md index d43d58995028c..98f1e61e6b8d2 100644 --- a/api-reference/beta/api/application_update.md +++ b/api-reference/beta/api/application_update.md @@ -1,19 +1,19 @@ # Update application Update the properties of application object. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http PATCH /applications/ ``` -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| @@ -40,9 +40,9 @@ In the request body, supply the values for relevant fields that should be update |requiredResourceAccess|requiredResourceAccess|Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience. **Notes**: Requires version 1.5, not nullable.| |samlMetadataUrl|String|The URL to the SAML metadata for the application.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [application](../resources/application.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 636 diff --git a/api-reference/beta/api/approleassignment_delete.md b/api-reference/beta/api/approleassignment_delete.md index 1e447e7ae423c..2bc846247b53f 100644 --- a/api-reference/beta/api/approleassignment_delete.md +++ b/api-reference/beta/api/approleassignment_delete.md @@ -1,9 +1,9 @@ # Delete appRoleAssignment Delete appRoleAssignment. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http DELETE /users//appRoleAssignments/ @@ -11,19 +11,19 @@ DELETE /servicePrincipals//appRoleAssignedTo DELETE /groups//appRoleAssignments/ ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http GET /users//appRoleAssignments/ GET /servicePrincipals//appRoleAssignedTo GET /groups//appRoleAssignments/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [appRoleAssignment](../resources/approleassignment.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 253 diff --git a/api-reference/beta/api/approleassignment_update.md b/api-reference/beta/api/approleassignment_update.md index 932afd1ec40bf..4b94cef13c900 100644 --- a/api-reference/beta/api/approleassignment_update.md +++ b/api-reference/beta/api/approleassignment_update.md @@ -1,21 +1,21 @@ # Update approleassignment Update the properties of approleassignment object. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http PATCH /users//appRoleAssignments/ PATCH /servicePrincipals//appRoleAssignedTo PATCH /groups//appRoleAssignments/ ``` -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| @@ -28,9 +28,9 @@ In the request body, supply the values for relevant fields that should be update |resourceDisplayName|String|The display name of the resource to which the assignment was made.| |resourceId|Guid|The unique identifier (**objectId**) for the target resource (service principal) for which the assignment was made.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [appRoleAssignment](../resources/approleassignment.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 253 diff --git a/api-reference/beta/api/attachment_delete.md b/api-reference/beta/api/attachment_delete.md index e0f60ae2120a0..f68d0977b196b 100644 --- a/api-reference/beta/api/attachment_delete.md +++ b/api-reference/beta/api/attachment_delete.md @@ -1,29 +1,72 @@ # Delete attachment -Delete attachment. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Delete an attachment from a calendar event, mail message, or group post. +## Prerequisites +One of the following **scopes** is required to execute this API: + +* If accessing attachments in Messages: *Mail.ReadWrite* +* If accessing attachments in Events: *Calendars.ReadWrite* +* If accessing attachments in Group Events or Posts: *Group.ReadWrite.All* + +## HTTP request +Attachments for an [event](../resources/event.md) in the user's or group's default [calendar](../resources/calendar.md). ```http +DELETE /me/events//attachments/ DELETE /users//events//attachments/ DELETE /groups//events//attachments/ -DELETE /users//messages//attachments/ +DELETE /me/calendar//events//attachments/ +DELETE /users//calendar/events//attachments/ +DELETE /groups//calendar/events//attachments/ +``` +Attachments for an [event](../resources/event.md) in a [calendar](../resources/calendar.md) belonging to the user's default [calendarGroup](../resources/calendargroup.md). +```http +DELETE /me/calendars//events//attachments/ +DELETE /users//calendars//events//attachments/ + +DELETE /me/calendargroup/calendars//events//attachments/ +DELETE /users//calendargroup/calendars//events//attachments/ +``` +Attachments for an [event](../resources/event.md) in a [calendar](../resources/calendar.md) belonging to a user's [calendarGroup](../resources/calendargroup.md). +```http +DELETE /me/calendargroups//calendars//events//attachments/ +DELETE /users//calendargroups//calendars//events//attachments/ ``` -### Request headers +Attachments for a [message](../resources/message.md) in a user's mailbox. +```http +DELETE /me/messages//attachments/ +DELETE /users//messages//attachments/ +``` +Attachments for a [message](../resources/message.md) contained in a top level [mailFolder](../resources/mailfolder.md) in a user's mailbox. +```http +DELETE /me/mailFolders//messages//attachments/ +DELETE /users//mailFolders//messages//attachments/ +``` +Attachments for a [message](../resources/message.md) contained in a child folder of a [mailFolder](../resources/mailfolder.md) in a user's mailbox. The +example below shows one level of nesting, but a message can be located in a child of a child and so on. +```http +DELETE /me/mailFolders//childFolders//.../messages//attachments/ +DELETE /users//mailFolders//childFolders//messages//attachments/ +``` +Attachments for a [post](../resources/post.md) in a [thread](../resources/conversationthread.md) belonging to a [conversation](../resources/conversation.md) of a group. +```http +DELETE /groups//threads//posts//attachments/ +DELETE /groups//conversations//threads//posts//attachments/ +``` +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/attachment_get.md b/api-reference/beta/api/attachment_get.md index 2a292784c417e..3e2a9fa379801 100644 --- a/api-reference/beta/api/attachment_get.md +++ b/api-reference/beta/api/attachment_get.md @@ -1,47 +1,128 @@ # Get attachment Retrieve the properties and relationships of attachment object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: + +* If accessing attachments in Messages: *Mail.Read* +* If accessing attachments in Events: *Calendars.Read* +* If accessing attachments in Group Events or Posts: *Group.Read.All* + +## HTTP request +Attachments for an [event](../resources/event.md) in the user's or group's default [calendar](../resources/calendar.md). ```http +GET /me/events//attachments/ GET /users//events//attachments/ GET /groups//events//attachments/ + +GET /me/calendar//events//attachments/ +GET /users//calendar/events//attachments/ +GET /groups//calendar/events//attachments/ +``` +Attachments for an [event](../resources/event.md) in a [calendar](../resources/calendar.md) belonging to the user's default [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendars//events//attachments/ +GET /users//calendars//events//attachments/ + +GET /me/calendargroup/calendars//events//attachments/ +GET /users//calendargroup/calendars//events//attachments/ +``` +Attachments for an [event](../resources/event.md) in a [calendar](../resources/calendar.md) belonging to a user's [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendargroups//calendars//events//attachments/ +GET /users//calendargroups//calendars//events//attachments/ +``` +Attachments for a [message](../resources/message.md) in a user's mailbox. +```http +GET /me/messages//attachments/ GET /users//messages//attachments/ ``` -### Optional query parameters +Attachments for a [message](../resources/message.md) contained in a top level [mailFolder](../resources/mailfolder.md) in a user's mailbox. +```http +GET /me/mailFolders//messages//attachments/ +GET /users//mailFolders//messages//attachments/ +``` +Attachments for a [message](../resources/message.md) contained in a child folder of a [mailFolder](../resources/mailfolder.md) in a user's mailbox. The +example below shows one level of nesting, but a message can be located in a child of a child and so on. +```http +GET /me/mailFolders//childFolders//.../messages//attachments/ +GET /users//mailFolders//childFolders//messages//attachments/ +``` +Attachments for a [post](../resources/post.md) in a [thread](../resources/conversationthread.md) belonging to a [conversation](../resources/conversation.md) of a group. +```http +GET /groups//threads//posts//attachments/ +GET /groups//conversations//threads//posts//attachments/ +``` +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [attachment](../resources/attachment.md) object in the response body. -### Example +## Example (file attachment) + ##### Request Here is an example of the request. ```http GET https://graph.microsoft.com/beta/me/events//attachments/ ``` + ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 199 + +{ + "contentType": "contentType-value", + "contentLocation": "contentLocation-value", + "contentBytes": "contentBytes-value", + "contentId": "null", + "lastModifiedDateTime": "2016-01-01T12:00:00Z", + "id": "id-value", + "isInline": false, + "isContactPhoto": false, + "name": "name-value", + "size": 99 +} +``` +## Example (item attachment) + +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/events//attachments/ +``` + +##### Response + +```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 162 { "lastModifiedDateTime": "datetime-value", @@ -53,6 +134,47 @@ Content-length: 162 } ``` + +## Example (reference attachment) + +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/events/AAMkAGE1M88AADUv0uAAAG=/attachments/AAMkAGE1Mg72tgf7hJp0PICVGCc0g= +``` + +##### Response + +```http +HTTP/1.1 200 OK +Content-type: application/json + +{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#users/ddfcd489-628b-40d7-b48b-57002df800e5/events/AAMkAGE1M88AADUv0uAAAG%3D/attachments/$entity", + "@odata.type": "#microsoft.graph.referenceAttachment", + "id": "AAMkAGE1Mg72tgf7hJp0PCGVCIc0g=", + "lastModifiedDateTime": "2016-03-12T06:04:38Z", + "name": "Personal pictures", + "contentType": null, + "size": 382, + "isInline": false, + "sourceUrl": "https://contoso.com/personal/mario_contoso_net/Documents/Pics", + "providerType": "oneDriveConsumer", + "thumbnailUrl": null, + "previewUrl": null, + "permission": "edit", + "isFolder": true +} +``` + \ No newline at end of file +}--> diff --git a/api-reference/beta/api/attachment_update.md b/api-reference/beta/api/attachment_update.md deleted file mode 100644 index e90c860f5dda2..0000000000000 --- a/api-reference/beta/api/attachment_update.md +++ /dev/null @@ -1,80 +0,0 @@ -# Update attachment - -Update the properties of attachment object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -PATCH /users//events//attachments/ -PATCH /groups//events//attachments/ -PATCH /users//messages//attachments/ -``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. - -| Property | Type |Description| -|:---------------|:--------|:----------| -|contentType|String|| -|isInline|Boolean|| -|lastModifiedDateTime|DateTimeOffset|| -|name|String|| -|size|Int32|| - -### Response -If successful, this method returns a `200 OK` response code and updated [attachment](../resources/attachment.md) object in the response body. -### Example -##### Request -Here is an example of the request. - -```http -PATCH https://graph.microsoft.com/beta/me/events//attachments/ -Content-type: application/json -Content-length: 142 - -{ - "lastModifiedDateTime": "datetime-value", - "name": "name-value", - "contentType": "contentType-value", - "size": 99, - "isInline": true -} -``` -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 162 - -{ - "lastModifiedDateTime": "datetime-value", - "name": "name-value", - "contentType": "contentType-value", - "size": 99, - "isInline": true, - "id": "id-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/baseItem_getByUrl.md b/api-reference/beta/api/baseItem_getByUrl.md new file mode 100644 index 0000000000000..2a3dad0dc1007 --- /dev/null +++ b/api-reference/beta/api/baseItem_getByUrl.md @@ -0,0 +1,57 @@ +# Get a SharePoint resource by URL + +Returns metadata for a SharePoint site, site collection, or list from a SharePoint URL. + +## Prerequisites + +One of the following scopes is required to execute this request: + +* Sites.Read.All +* Sites.ReadWrite.All + +### HTTP request + +```http +GET https://graph.microsoft.com/beta/sharepoint:/{item-path} +``` + +### Request parameters + +In the request URL, provide the following parameters with values. + +| Parameter | Type | Description +|:--------------|:-------|:---------------------------------------------------- +| **item-path** | string | A relative path within the default site collection (eg. /teams/hr/Documents) + +### Example + +#### Request + + + +```http +GET https://graph.microsoft.com/beta/sharepoint:/{item-path} +``` + +##### Response + + + +```json +HTTP/1.1 200 OK +Content-type: application/json + +{ + "id": "d297964f-d325-424b-a002-f54048a4622e", + "name": "OneDrive / SharePoint Team", + "description": "Collaboration site for the OneDrive and SharePoint team" +} +``` + + diff --git a/api-reference/beta/api/bucket_delete.md b/api-reference/beta/api/bucket_delete.md index b7cb77396572a..1fb0bf72cc571 100644 --- a/api-reference/beta/api/bucket_delete.md +++ b/api-reference/beta/api/bucket_delete.md @@ -1,31 +1,31 @@ # Delete bucket Delete bucket. -### Prerequisites -The following **scopes** are required to execute this API: +## Prerequisites +One of the following **scopes** is required to execute this API: + +Group.ReadWrite.All -Group.ReadWrite.All AND Tasks.ReadWrite - -### HTTP request +## HTTP request ```http DELETE /buckets/ ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Value should be set to "Bearer (access-token)" | | If-Match | string | Value should be set to the ETag of the object | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http GET /buckets/ ``` -### Optional query parameters +## Optional query parameters None -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Value should be set to "Bearer (access-token)" | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [bucket](../resources/bucket.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http GET /buckets//tasks ``` -### Optional query parameters +## Optional query parameters None -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Value should be set to "Bearer (access-token)" | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [task](../resources/task.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http POST /buckets ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Value should be set to "Bearer (access-token)" | -### Request body +## Request body In the request body, supply a JSON representation of [bucket](../resources/bucket.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [bucket](../resources/bucket.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http PATCH /buckets/ ``` -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Value should be set to "Bearer (access-token)" | | If-Match | string | Value should be set to the ETag of the object | | Prefer | string | Value should be set to "return=representation" so that the updated object is returned in the response. This is advised so that the client can get the new ETag value of the updated object without doing an additional GET | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| @@ -27,9 +27,9 @@ In the request body, supply the values for relevant fields that should be update |orderHint|String|Used to set the relative order of the buckets in the task board view. Consider three buckets in the order of: `'E'`, `'F'`, `'G'`. To make `'F'` the first bucket, set its `'orderHint'` to smaller than that of `'x'`. The comparison is an ordinal string comparison.| |planId|String|Plan id to which the bucket belongs.| -### Response +## Response If successful, this method returns a `204 No Content` response code. -### Example +## Example ##### Request Here is an example of the request. +A user's [calendar](../resources/calendar.md) other than the default calendar in the default [calendarGroup](../resources/calendargroup.md). ```http -DELETE /users//calendar -DELETE /groups//calendar -DELETE /drive/root/createdByUser/calendar +DELETE /me/calendars/ +DELETE /users//calendars/ +DELETE /me/calendarGroup/calendars/ +DELETE /users//calendarGroup/calendars/ ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +A [calendar](../resources/calendar.md) other than the default calendar, in a specific [calendarGroup](../resources/calendargroup.md). +```http +DELETE /me/calendarGroups//calendars/ +DELETE /users//calendarGroups//calendars/ +``` +## Request headers +| Name | Type | Description| +|:---------------|:---------|:----------| +| Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendar_get.md b/api-reference/beta/api/calendar_get.md index 996a3371edcbc..51028620e5026 100644 --- a/api-reference/beta/api/calendar_get.md +++ b/api-reference/beta/api/calendar_get.md @@ -1,28 +1,42 @@ # Get calendar Retrieve the properties and relationships of calendar object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request +A user's or group's default [calendar](../resources/calendar.md). ```http +GET /me/calendar GET /users//calendar GET /groups//calendar -GET /drive/root/createdByUser/calendar ``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +A user's [calendar](../resources/calendar.md) in the default [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendars/ +GET /users//calendars/ -### Request headers +GET /me/calendarGroup/calendars/ +GET /users//calendarGroup/calendars/ +``` +A user's [calendar](../resources/calendar.md) in a specific [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendarGroups//calendars/ +GET /users//calendarGroups//calendars/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [calendar](../resources/calendar.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 98 - { - "name": "name-value", - "color": { - }, - "changeKey": "changeKey-value", - "id": "id-value" + "@odata.context": "https://graph.microsoft.com/beta/$metadata#me/calendars/$entity", + "@odata.id": "https://graph.microsoft.com/beta/users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/calendars('AAMkAGI2TGuLAAA=')", + "id": "AAMkAGI2TGuLAAA=", + "name": "Calendar", + "color": "auto", + "isDefaultCalendar": false, + "changeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w==", + "canShare":true, + "canViewPrivateItems":true, + "isShared":false, + "isSharedWithMe":false, + "canEdit":true, + "owner":{ + "name":"Fanny Downs", + "address":"fannyd@adatum.onmicrosoft.com" + } } + ``` \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendar_list_calendarview.md b/api-reference/beta/api/calendar_list_calendarview.md index 5104b0e28c66d..71567a698e247 100644 --- a/api-reference/beta/api/calendar_list_calendarview.md +++ b/api-reference/beta/api/calendar_list_calendarview.md @@ -1,28 +1,57 @@ # List calendarView -Retrieve a list of event objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, +from the user's primary calendar `(../me/calendarview)` or from a specified calendar. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* + +## HTTP request +A user's or group's default [calendar](../resources/calendar.md). ```http -GET /users//calendar/calendarView -GET /groups//calendar/calendarView -GET /drive/root/createdByUser/calendar/calendarView +GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /groups//calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} ``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +A user's [calendar](../resources/calendar.md) in the default [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendars//calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendars//calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} -### Request body +GET /me/calendarGroup/calendars//calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendarGroup/calendars//calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +``` + +A user's [calendar](../resources/calendar.md) in a specific [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendarGroups//calendars//calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendarGroups//calendars//calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} +``` + +## Query parameters + +In the request URL, provide the following required query parameters with values. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|startDateTime|String|The start date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T19:00:00.0000000".| +|endDateTime|String|The end date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T20:00:00.0000000".| + +This method also supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Prefer | outlook.timezone="Eastern Standard Time". Optional. Use this to specify the time zone for start and end times in the response. If not specified, the response are returned in UTC. | + +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Event](../resources/event.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 354 @@ -50,8 +80,7 @@ Content-length: 354 "originalStartTimeZone": "originalStartTimeZone-value", "originalEndTimeZone": "originalEndTimeZone-value", "responseStatus": { - "response": { - }, + "response": "response-value", "time": "datetime-value" }, "iCalUId": "iCalUId-value", @@ -70,4 +99,4 @@ Content-length: 354 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendar_list_events.md b/api-reference/beta/api/calendar_list_events.md index a76b4ce6bbf21..a18aab0e5fed2 100644 --- a/api-reference/beta/api/calendar_list_events.md +++ b/api-reference/beta/api/calendar_list_events.md @@ -1,28 +1,47 @@ # List events -Retrieve a list of event objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of events in a calendar. The list contains single instance meetings and series masters. + +To get expanded event instances, you can [get the calendar view](calendar_list_calendarview.md), or +[get the instances of an event](event_list_instances.md). + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request +A user's or group's default [calendar](../resources/calendar.md). ```http +GET /me/calendar/events GET /users//calendar/events GET /groups//calendar/events -GET /drive/root/createdByUser/calendar/events ``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +A user's [calendar](../resources/calendar.md) in the default [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendars//events +GET /users//calendars//events -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +GET /me/calendarGroup/calendars//events +GET /users//calendarGroup/calendars//events +``` +A user's [calendar](../resources/calendar.md) in a specific [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendarGroups//calendars//events +GET /users//calendarGroups//calendars//events +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Prefer | outlook.timezone="Eastern Standard Time". Optional. Use this to specify the time zone for start and end times in the response. If not specified, the response are returned in UTC. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Event](../resources/event.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 354 @@ -50,8 +70,7 @@ Content-length: 354 "originalStartTimeZone": "originalStartTimeZone-value", "originalEndTimeZone": "originalEndTimeZone-value", "responseStatus": { - "response": { - }, + "response": "", "time": "datetime-value" }, "iCalUId": "iCalUId-value", @@ -70,4 +89,4 @@ Content-length: 354 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendar_post_events.md b/api-reference/beta/api/calendar_post_events.md index ec6c1250488fe..c4005b7e6019e 100644 --- a/api-reference/beta/api/calendar_post_events.md +++ b/api-reference/beta/api/calendar_post_events.md @@ -1,29 +1,44 @@ # Create Event -Use this API to create a new Event. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Use this API to create a new Event in the default or the specified calendar. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request +A user's or group's default [calendar](../resources/calendar.md). ```http +POST /me/calendar/events POST /users//calendar/events POST /groups//calendar/events -POST /drive/root/createdByUser/calendar/events +``` +A user's [calendar](../resources/calendar.md) in the default [calendarGroup](../resources/calendargroup.md). +```http +POST /me/calendars//events +POST /users//calendars//events +POST /me/calendarGroup/calendars//events +POST /users//calendarGroup/calendars//events +``` +A user's [calendar](../resources/calendar.md) in a specific [calendarGroup](../resources/calendargroup.md). +```http +POST /me/calendarGroups//calendars//events +POST /users//calendarGroups//calendars//events ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply a JSON representation of [Event](../resources/event.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [Event](../resources/event.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 285 @@ -64,8 +78,7 @@ Content-length: 285 "originalStartTimeZone": "originalStartTimeZone-value", "originalEndTimeZone": "originalEndTimeZone-value", "responseStatus": { - "response": { - }, + "response": "", "time": "datetime-value" }, "iCalUId": "iCalUId-value", @@ -82,4 +95,4 @@ Content-length: 285 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendar_update.md b/api-reference/beta/api/calendar_update.md index 9147703161c0a..139364765d514 100644 --- a/api-reference/beta/api/calendar_update.md +++ b/api-reference/beta/api/calendar_update.md @@ -1,32 +1,48 @@ # Update calendar Update the properties of calendar object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request +A user's or group's default [calendar](../resources/calendar.md). ```http +PATCH /me/calendar PATCH /users//calendar PATCH /groups//calendar -PATCH /drive/root/createdByUser/calendar ``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +A user's [calendar](../resources/calendar.md) in the default [calendarGroup](../resources/calendargroup.md). +```http +PATCH /me/calendars/ +PATCH /users//calendars/ + +PATCH /me/calendarGroup/calendars/ +PATCH /users//calendarGroup/calendars/ +``` +A user's [calendar](../resources/calendar.md) in a specific [calendarGroup](../resources/calendargroup.md). +```http +PATCH /me/calendarGroups//calendars/ +PATCH /users//calendarGroups//calendars/ +``` +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|changeKey|String|Identifies the version of the calendar object. Every time the calendar is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.| -|color|String|Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1 Possible values are: `LightBlue`, `LightGreen`, `LightOrange`, `LightGray`, `LightYellow`, `LightTeal`, `LightPink`, `LightBrown`, `LightRed`, `MaxColor`, `Auto`.| +|color|String|Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1| +|isDefaultCalendar|Boolean|True if this calendar is the user's default calendar, false otherwise.| |name|String|The calendar name.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [calendar](../resources/calendar.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 98 { - "name": "name-value", - "color": { - }, - "changeKey": "changeKey-value", - "id": "id-value" + "@odata.context":"https://graph.microsoft.com/beta/$metadata#me/calendars/$entity", + "@odata.id":"https://graph.microsoft.com/beta/users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/calendars('AAMkADJmMVAAA=')", + "id":"AAMkADJmMVAAA=", + "name":"Social events", + "color":"auto", + "isDefaultCalendar":false, + "changeKey":"DxYSthXJXEWwAQSYQnXvIgAAIxGttg==", + "canShare":true, + "canViewPrivateItems":true, + "isShared":false, + "isSharedWithMe":false, + "canEdit":true, + "owner":{ + "name":"Fanny Downs", + "address":"fannyd@adatum.onmicrosoft.com" + } } ``` @@ -73,4 +96,4 @@ Content-length: 98 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendargroup_delete.md b/api-reference/beta/api/calendargroup_delete.md index 5d0f8516eb35d..4160d9b950f2b 100644 --- a/api-reference/beta/api/calendargroup_delete.md +++ b/api-reference/beta/api/calendargroup_delete.md @@ -1,29 +1,32 @@ # Delete calendarGroup -Delete calendarGroup. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Delete a calendar group other than the default calendar group. + +**Note** Outlook.com supports only the default calendar group which is accessible by the /me/calendars shortcut. You cannot +delete any calendar group in Outlook.com. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request ```http +DELETE /me/calendarGroups/ DELETE /users//calendarGroups/ -DELETE /drive/root/createdByUser/calendarGroups/ -DELETE /drive/root/lastModifiedByUser/calendarGroups/ - ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendargroup_get.md b/api-reference/beta/api/calendargroup_get.md index 92b79d01c66df..0b92c70500a31 100644 --- a/api-reference/beta/api/calendargroup_get.md +++ b/api-reference/beta/api/calendargroup_get.md @@ -1,28 +1,28 @@ # Get calendarGroup -Retrieve the properties and relationships of calendargroup object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve the properties and relationships of a calendar group object. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request +Any [calendarGroup](../resources/calendargroup.md) of a user. ```http +GET /me/calendarGroups/ GET /users//calendarGroups/ -GET /drive/root/createdByUser/calendarGroups/ -GET /drive/root/lastModifiedByUser/calendarGroups/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [calendarGroup](../resources/calendargroup.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 110 { "name": "name-value", - "classId": "classId-value", + "classId": "11b0131d-43c8-4bbb-b2c8-e80f9a50834a", "changeKey": "changeKey-value", "id": "id-value" } @@ -59,4 +60,4 @@ Content-length: 110 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendargroup_list_calendars.md b/api-reference/beta/api/calendargroup_list_calendars.md index 23f5ef70172d3..012aa0794ae70 100644 --- a/api-reference/beta/api/calendargroup_list_calendars.md +++ b/api-reference/beta/api/calendargroup_list_calendars.md @@ -1,28 +1,32 @@ # List calendars -Retrieve a list of calendar objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of calendars belonging to a calendar group. +## Prerequisites +One of the following **scopes** is required to execute this API: _Calendars.Read_ +## HTTP request +A user's default [calendarGroup](../resources/calendargroup.md). ```http +GET /me/calendarGroup/calendars +GET /users//calendarGroup/calendars +``` +Any [calendarGroup](../resources/calendargroup.md) of a user. +```http +GET /me/calendarGroups//calendars GET /users//calendarGroups//calendars -GET /drive/root/createdByUser/calendarGroups//calendars -GET /drive/root/lastModifiedByUser/calendarGroups//calendars ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Calendar](../resources/calendar.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 147 @@ -65,4 +70,4 @@ Content-length: 147 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendargroup_post_calendars.md b/api-reference/beta/api/calendargroup_post_calendars.md index 48798258536dc..20daf55d53ba9 100644 --- a/api-reference/beta/api/calendargroup_post_calendars.md +++ b/api-reference/beta/api/calendargroup_post_calendars.md @@ -1,29 +1,34 @@ # Create Calendar -Use this API to create a new Calendar. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Use this API to create a new Calendar in a calendar group. +## Prerequisites +One of the following **scopes** is required to execute this API: _Calendars.ReadWrite_ +## HTTP request +A user's default [calendarGroup](../resources/calendargroup.md). ```http +POST /me/calendarGroup/calendars +POST /users//calendarGroup/calendars +``` +Any [calendarGroup](../resources/calendargroup.md) of a user. +```http +POST /me/calendarGroups//calendars POST /users//calendarGroups//calendars -POST /drive/root/createdByUser/calendarGroups//calendars -POST /drive/root/lastModifiedByUser/calendarGroups//calendars - ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply a JSON representation of [Calendar](../resources/calendar.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [Calendar](../resources/calendar.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 98 @@ -71,4 +76,4 @@ Content-length: 98 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/calendargroup_update.md b/api-reference/beta/api/calendargroup_update.md index f24127ece0b37..4b20c5ad2965f 100644 --- a/api-reference/beta/api/calendargroup_update.md +++ b/api-reference/beta/api/calendargroup_update.md @@ -1,32 +1,31 @@ # Update calendargroup Update the properties of calendargroup object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: _Calendars.ReadWrite_ +## HTTP request +Any [calendarGroup](../resources/calendargroup.md) of a user. ```http +PATCH /me/calendarGroups/ PATCH /users//calendarGroups/ -PATCH /drive/root/createdByUser/calendarGroups/ -PATCH /drive/root/lastModifiedByUser/calendarGroups/ ``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|changeKey|String|Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.| -|classId|Guid|The class identifier.| |name|String|The group name.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [calendarGroup](../resources/calendargroup.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 110 { "name": "name-value", - "classId": "classId-value", + "classId": "11b0131d-43c8-4bbb-b2c8-e80f9a50834a", "changeKey": "changeKey-value", "id": "id-value" } @@ -71,4 +69,4 @@ Content-length: 110 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/chart_delete.md b/api-reference/beta/api/chart_delete.md new file mode 100644 index 0000000000000..1d1173edc0182 --- /dev/null +++ b/api-reference/beta/api/chart_delete.md @@ -0,0 +1,54 @@ +# Chart: delete + +Deletes the chart object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/delete + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body + +## Response +If successful, this method returns `200, OK` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/delete +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chart_get.md b/api-reference/beta/api/chart_get.md new file mode 100644 index 0000000000000..6c4cb3194599d --- /dev/null +++ b/api-reference/beta/api/chart_get.md @@ -0,0 +1,61 @@ +# Get Chart + +Retrieve the properties and relationships of chart object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts() +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [Chart](../resources/chart.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts() +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 52 + +{ + "id": "id-value", + "height": 99, + "left": 99 +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chart_image.md b/api-reference/beta/api/chart_image.md new file mode 100644 index 0000000000000..f81345d012aad --- /dev/null +++ b/api-reference/beta/api/chart_image.md @@ -0,0 +1,70 @@ +# Chart: Image + +Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/Image(width=0,height=0,fittingMode='fit') + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|height|number|Optional. The desired height of the resulting image.| +|width|number|Optional. The desired width of the resulting image.| +|fittingMode|string|Optional. The method used to scale the chart to the specified to the specified dimensions (if both height and width are set)." Possible values are: `Fit`, `FitAndCenter`, `Fill`.| + +## Response +If successful, this method returns `200, OK` response code and base-64 image string in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/Image(width=0,height=0,fittingMode='fit') +Content-type: application/json +Content-length: 77 + +{ + "height": { + }, + "width": { + }, + "fittingMode": "fittingMode-value" +} +``` + +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 3 + +{ +"value" : "base-64 chart image string" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/user_list_photos.md b/api-reference/beta/api/chart_list.md similarity index 59% rename from api-reference/beta/api/user_list_photos.md rename to api-reference/beta/api/chart_list.md index 8c57f5ba42541..aa0f4402c6488 100644 --- a/api-reference/beta/api/user_list_photos.md +++ b/api-reference/beta/api/chart_list.md @@ -1,55 +1,55 @@ -# List photos +# List ChartCollection -Retrieve a list of photo objects. -### Prerequisites +Retrieve a list of chart objects. +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http -GET /users//photos -GET /drive/root/createdByUser/photos -GET /drive/root/lastModifiedByUser/photos +GET /workbook/worksheets()/charts ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | -### Request body + +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [Photo](../resources/photo.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [Chart](../resources/chart.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http -GET https://graph.microsoft.com/beta/me/photos +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts ``` ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 94 +Content-length: 93 { "value": [ { + "id": "id-value", "height": 99, - "width": 99, - "id": "id-value" + "left": 99 } ] } @@ -59,7 +59,7 @@ Content-length: 94 2015-10-25 14:57:30 UTC --> +```http +GET /workbook/worksheets()/charts()/series +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [ChartSeries](../resources/chartseries.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 59 + +{ + "value": [ + { + "name": "name-value" + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chart_post_series.md b/api-reference/beta/api/chart_post_series.md new file mode 100644 index 0000000000000..5214f68b4097d --- /dev/null +++ b/api-reference/beta/api/chart_post_series.md @@ -0,0 +1,67 @@ +# Create ChartSeries + +Use this API to create a new ChartSeries. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/series + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply a JSON representation of [ChartSeries](../resources/chartseries.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [ChartSeries](../resources/chartseries.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series +Content-type: application/json +Content-length: 26 + +{ + "name": "name-value" +} +``` +In the request body, supply a JSON representation of [ChartSeries](../resources/chartseries.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 26 + +{ + "name": "name-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chart_setdata.md b/api-reference/beta/api/chart_setdata.md new file mode 100644 index 0000000000000..93417b43d631c --- /dev/null +++ b/api-reference/beta/api/chart_setdata.md @@ -0,0 +1,67 @@ +# Chart: setData + +Resets the source data for the chart. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/setData + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|sourceData|string|The Range object corresponding to the source data.| +|seriesBy|string|Optional. Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. Possible values are: `Auto`, `Columns`, `Rows`.| + +## Response +If successful, this method returns `200, OK` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/setData +Content-type: application/json +Content-length: 70 + +{ + "sourceData": "sourceData-value", + "seriesBy": "seriesBy-value" +} +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chart_setposition.md b/api-reference/beta/api/chart_setposition.md new file mode 100644 index 0000000000000..9a765382c790c --- /dev/null +++ b/api-reference/beta/api/chart_setposition.md @@ -0,0 +1,67 @@ +# Chart: setPosition + +Positions the chart relative to cells on the worksheet. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/setPosition + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|startCell|string|The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.| +|endCell|string|Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.| + +## Response +If successful, this method returns `200, OK` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/setPosition +Content-type: application/json +Content-length: 66 + +{ + "startCell": "startCell-value", + "endCell": "endCell-value" +} +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chart_update.md b/api-reference/beta/api/chart_update.md new file mode 100644 index 0000000000000..39bb20dab39b3 --- /dev/null +++ b/api-reference/beta/api/chart_update.md @@ -0,0 +1,75 @@ +# Update chart + +Update the properties of chart object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts() +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|height|double|Represents the height, in points, of the chart object.| +|left|double|The distance, in points, from the left side of the chart to the worksheet origin.| +|name|string|Represents the name of a chart object.| +|top|double|Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| +|width|double|Represents the width, in points, of the chart object.| + +## Response +If successful, this method returns a `200 OK` response code and updated [Chart](../resources/chart.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts() +Content-type: application/json +Content-length: 52 + +{ + "id": "id-value", + "height": 99, + "left": 99 +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 52 + +{ + "id": "id-value", + "height": 99, + "left": 99 +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartaxis_get.md b/api-reference/beta/api/chartaxis_get.md new file mode 100644 index 0000000000000..54defb39b91ea --- /dev/null +++ b/api-reference/beta/api/chartaxis_get.md @@ -0,0 +1,66 @@ +# Get ChartAxis + +Retrieve the properties and relationships of chartaxis object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/axes/valueaxis +GET /workbook/worksheets()/charts()/axes/seriesaxis +GET /workbook/worksheets()/charts()/axes/categoryaxis +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartAxis](../resources/chartaxis.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 64 + +{ + "majorUnit": { + }, + "maximum": { + }, + "minimum": { + } +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartaxis_update.md b/api-reference/beta/api/chartaxis_update.md new file mode 100644 index 0000000000000..0092dba13e8de --- /dev/null +++ b/api-reference/beta/api/chartaxis_update.md @@ -0,0 +1,82 @@ +# Update chartaxis + +Update the properties of chartaxis object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/axes/valueaxis +PATCH /workbook/worksheets()/charts()/axes/seriesaxis +PATCH /workbook/worksheets()/charts()/axes/categoryaxis +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|majorUnit|object|Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.| +|maximum|object|Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| +|minimum|object|Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| +|minorUnit|object|Represents the interval between two minor tick marks. "Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartAxis](../resources/chartaxis.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis +Content-type: application/json +Content-length: 64 + +{ + "majorUnit": { + }, + "maximum": { + }, + "minimum": { + } +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 64 + +{ + "majorUnit": { + }, + "maximum": { + }, + "minimum": { + } +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartaxistitle_get.md b/api-reference/beta/api/chartaxistitle_get.md new file mode 100644 index 0000000000000..cd1bf2fdcbeb5 --- /dev/null +++ b/api-reference/beta/api/chartaxistitle_get.md @@ -0,0 +1,62 @@ +# Get ChartAxisTitle + +Retrieve the properties and relationships of chartaxistitle object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/axes/valueaxis/title +GET /workbook/worksheets()/charts()/axes/seriesaxis/title +GET /workbook/worksheets()/charts()/axes/categoryaxis/title +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartAxisTitle](../resources/chartaxistitle.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis/title +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 45 + +{ + "text": "text-value", + "visible": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartaxistitle_update.md b/api-reference/beta/api/chartaxistitle_update.md new file mode 100644 index 0000000000000..8e9e9a0f8f3a4 --- /dev/null +++ b/api-reference/beta/api/chartaxistitle_update.md @@ -0,0 +1,72 @@ +# Update chartaxistitle + +Update the properties of chartaxistitle object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/axes/valueaxis/title +PATCH /workbook/worksheets()/charts()/axes/seriesaxis/title +PATCH /workbook/worksheets()/charts()/axes/categoryaxis/title +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|text|string|Represents the axis title.| +|visible|boolean|A boolean that specifies the visibility of an axis title.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartAxisTitle](../resources/chartaxistitle.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis/title +Content-type: application/json +Content-length: 45 + +{ + "text": "text-value", + "visible": true +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 45 + +{ + "text": "text-value", + "visible": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartcollection_add.md b/api-reference/beta/api/chartcollection_add.md new file mode 100644 index 0000000000000..89d6cfaceba98 --- /dev/null +++ b/api-reference/beta/api/chartcollection_add.md @@ -0,0 +1,77 @@ +# ChartCollection: add + +Creates a new chart. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|type|string|Represents the type of a chart. Possible values are: `ColumnClustered`, `ColumnStacked`, `ColumnStacked100`, `BarClustered`, `BarStacked`, `BarStacked100`, `LineStacked`, `LineStacked100`, `LineMarkers`, `LineMarkersStacked`, `LineMarkersStacked100`, `PieOfPie`, `etc.`.| +|sourceData|string|The Range object corresponding to the source data.| +|seriesBy|string|Optional. Specifies the way columns or rows are used as data series on the chart. Possible values are: `Auto`, `Columns`, `Rows`.| + +## Response +If successful, this method returns `200, OK` response code and [Chart](../resources/chart.md) object in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts +Content-type: application/json +Content-length: 94 + +{ + "type": "type-value", + "sourceData": "sourceData-value", + "seriesBy": "seriesBy-value" +} +``` + +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 52 + +{ + "id": "id-value", + "height": 99, + "left": 99 +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/eventmessage_copy.md b/api-reference/beta/api/chartcollection_itemat.md similarity index 55% rename from api-reference/beta/api/eventmessage_copy.md rename to api-reference/beta/api/chartcollection_itemat.md index 568183037be20..9556e9459edc9 100644 --- a/api-reference/beta/api/eventmessage_copy.md +++ b/api-reference/beta/api/chartcollection_itemat.md @@ -1,44 +1,46 @@ -# eventMessage: copy +# ChartCollection: ItemAt - -### Prerequisites +Gets a chart based on its position in the collection. +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http - +POST /workbook/worksheets()/charts/ItemAt ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | -### Request body + +## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:---------------|:--------|:----------| -|destinationId|String|| +|index|number|Index value of the object to be retrieved. Zero-indexed.| -### Response -If successful, this method returns `200, OK` response code and [Message](../resources/message.md) object in the response body. +## Response +If successful, this method returns `200, OK` response code and [Chart](../resources/chart.md) object in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. ```http - +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts/ItemAt Content-type: application/json -Content-length: 44 +Content-length: 20 { - "destinationId": "destinationId-value" + "index": { + } } ``` @@ -47,23 +49,17 @@ Here is an example of the response. Note: The response object shown here may be ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 248 +Content-length: 52 { - "receivedDateTime": "datetime-value", - "sentDateTime": "datetime-value", - "hasAttachments": true, - "subject": "subject-value", - "body": { - "contentType": { - }, - "content": "content-value" - }, - "bodyPreview": "bodyPreview-value" + "id": "id-value", + "height": 99, + "left": 99 } ``` @@ -71,7 +67,7 @@ Content-length: 248 2015-10-25 14:57:30 UTC --> +```http +GET /workbook/worksheets()/charts()/datalabels +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartDataLabels](../resources/chartdatalabels.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/datalabels +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 134 + +{ + "position": "position-value", + "showValue": true, + "showSeriesName": true, + "showCategoryName": true, + "showLegendKey": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartdatalabels_update.md b/api-reference/beta/api/chartdatalabels_update.md new file mode 100644 index 0000000000000..97d0cad3be06a --- /dev/null +++ b/api-reference/beta/api/chartdatalabels_update.md @@ -0,0 +1,82 @@ +# Update chartdatalabels + +Update the properties of chartdatalabels object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/datalabels +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|position|string|DataLabelPosition value that represents the position of the data label. Possible values are: `None`, `Center`, `InsideEnd`, `InsideBase`, `OutsideEnd`, `Left`, `Right`, `Top`, `Bottom`, `BestFit`, `Callout`.| +|separator|string|String representing the separator used for the data labels on a chart.| +|showBubbleSize|boolean|Boolean value representing if the data label bubble size is visible or not.| +|showCategoryName|boolean|Boolean value representing if the data label category name is visible or not.| +|showLegendKey|boolean|Boolean value representing if the data label legend key is visible or not.| +|showPercentage|boolean|Boolean value representing if the data label percentage is visible or not.| +|showSeriesName|boolean|Boolean value representing if the data label series name is visible or not.| +|showValue|boolean|Boolean value representing if the data label value is visible or not.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartDataLabels](../resources/chartdatalabels.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/datalabels +Content-type: application/json +Content-length: 134 + +{ + "position": "position-value", + "showValue": true, + "showSeriesName": true, + "showCategoryName": true, + "showLegendKey": true +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 134 + +{ + "position": "position-value", + "showValue": true, + "showSeriesName": true, + "showCategoryName": true, + "showLegendKey": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartfill_clear.md b/api-reference/beta/api/chartfill_clear.md new file mode 100644 index 0000000000000..1a493b339e19e --- /dev/null +++ b/api-reference/beta/api/chartfill_clear.md @@ -0,0 +1,56 @@ +# ChartFill: clear + +Clear the fill color of a chart element. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/format/fill/clear +POST /workbook/worksheets()/charts()/title/format/fill/clear +POST /workbook/worksheets()/charts()/legend/format/fill/clear + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body + +## Response +If successful, this method returns `200, OK` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/format/fill/clear +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartfill_setsolidcolor.md b/api-reference/beta/api/chartfill_setsolidcolor.md new file mode 100644 index 0000000000000..2152360c22d86 --- /dev/null +++ b/api-reference/beta/api/chartfill_setsolidcolor.md @@ -0,0 +1,67 @@ +# ChartFill: setSolidColor + +Sets the fill formatting of a chart element to a uniform color. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/format/fill/setSolidColor +POST /workbook/worksheets()/charts()/title/format/fill/setSolidColor +POST /workbook/worksheets()/charts()/legend/format/fill/setSolidColor + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").| + +## Response +If successful, this method returns `200, OK` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/format/fill/setSolidColor +Content-type: application/json +Content-length: 28 + +{ + "color": "color-value" +} +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartfont_get.md b/api-reference/beta/api/chartfont_get.md new file mode 100644 index 0000000000000..b98351e16a3fc --- /dev/null +++ b/api-reference/beta/api/chartfont_get.md @@ -0,0 +1,66 @@ +# Get ChartFont + +Retrieve the properties and relationships of chartfont object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/axes/valueaxis/format/font +GET /workbook/worksheets()/charts()/axes/seriesaxis/format/font +GET /workbook/worksheets()/charts()/axes/categoryaxis/format/font +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartFont](../resources/chartfont.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis/format/font +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 134 + +{ + "bold": true, + "color": "color-value", + "italic": true, + "name": "name-value", + "size": 99, + "underline": "underline-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartfont_update.md b/api-reference/beta/api/chartfont_update.md new file mode 100644 index 0000000000000..da59a57cec4ab --- /dev/null +++ b/api-reference/beta/api/chartfont_update.md @@ -0,0 +1,84 @@ +# Update chartfont + +Update the properties of chartfont object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/axes/valueaxis/format/font +PATCH /workbook/worksheets()/charts()/axes/seriesaxis/format/font +PATCH /workbook/worksheets()/charts()/axes/categoryaxis/format/font +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|bold|boolean|Represents the bold status of font.| +|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.| +|italic|boolean|Represents the italic status of the font.| +|name|string|Font name (e.g. "Calibri")| +|size|double|Size of the font (e.g. 11)| +|underline|string|Type of underline applied to the font. Possible values are: `None`, `Single`.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartFont](../resources/chartfont.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis/format/font +Content-type: application/json +Content-length: 134 + +{ + "bold": true, + "color": "color-value", + "italic": true, + "name": "name-value", + "size": 99, + "underline": "underline-value" +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 134 + +{ + "bold": true, + "color": "color-value", + "italic": true, + "name": "name-value", + "size": 99, + "underline": "underline-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartgridlines_get.md b/api-reference/beta/api/chartgridlines_get.md new file mode 100644 index 0000000000000..21dfdb9da6182 --- /dev/null +++ b/api-reference/beta/api/chartgridlines_get.md @@ -0,0 +1,61 @@ +# Get ChartGridlines + +Retrieve the properties and relationships of chartgridlines object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/axes/valueaxis/minorgridlines +GET /workbook/worksheets()/charts()/axes/valueaxis/majorgridlines +GET /workbook/worksheets()/charts()/axes/seriesaxis/majorgridlines +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartGridlines](../resources/chartgridlines.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis/minorgridlines +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 21 + +{ + "visible": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartgridlines_update.md b/api-reference/beta/api/chartgridlines_update.md new file mode 100644 index 0000000000000..7eaa77ef4c888 --- /dev/null +++ b/api-reference/beta/api/chartgridlines_update.md @@ -0,0 +1,69 @@ +# Update chartgridlines + +Update the properties of chartgridlines object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/axes/valueaxis/minorgridlines +PATCH /workbook/worksheets()/charts()/axes/valueaxis/majorgridlines +PATCH /workbook/worksheets()/charts()/axes/seriesaxis/majorgridlines +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|visible|boolean|Boolean value representing if the axis gridlines are visible or not.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartGridlines](../resources/chartgridlines.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/valueaxis/minorgridlines +Content-type: application/json +Content-length: 21 + +{ + "visible": true +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 21 + +{ + "visible": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartlegend_get.md b/api-reference/beta/api/chartlegend_get.md new file mode 100644 index 0000000000000..64ea794bfa8b1 --- /dev/null +++ b/api-reference/beta/api/chartlegend_get.md @@ -0,0 +1,61 @@ +# Get ChartLegend + +Retrieve the properties and relationships of chartlegend object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/legend +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartLegend](../resources/chartlegend.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/legend +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 72 + +{ + "visible": true, + "position": "position-value", + "overlay": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartlegend_update.md b/api-reference/beta/api/chartlegend_update.md new file mode 100644 index 0000000000000..f41bbb2c058ad --- /dev/null +++ b/api-reference/beta/api/chartlegend_update.md @@ -0,0 +1,73 @@ +# Update chartlegend + +Update the properties of chartlegend object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/legend +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|overlay|boolean|Boolean value for whether the chart legend should overlap with the main body of the chart.| +|position|string|Represents the position of the legend on the chart. Possible values are: `Top`, `Bottom`, `Left`, `Right`, `Corner`, `Custom`.| +|visible|boolean|A boolean value the represents the visibility of a ChartLegend object.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartLegend](../resources/chartlegend.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/legend +Content-type: application/json +Content-length: 72 + +{ + "visible": true, + "position": "position-value", + "overlay": true +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 72 + +{ + "visible": true, + "position": "position-value", + "overlay": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartlineformat_clear.md b/api-reference/beta/api/chartlineformat_clear.md new file mode 100644 index 0000000000000..fb6e377c73d04 --- /dev/null +++ b/api-reference/beta/api/chartlineformat_clear.md @@ -0,0 +1,56 @@ +# ChartLineFormat: clear + +Clear the line format of a chart element. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/axes/seriesaxis/format/line/clear +POST /workbook/worksheets()/charts()/axes/categoryaxis/format/line/clear +POST /workbook/worksheets()/charts()/axes/seriesaxis/majorgridlines/format/line/clear + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body + +## Response +If successful, this method returns `200, OK` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/seriesaxis/format/line/clear +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartlineformat_get.md b/api-reference/beta/api/chartlineformat_get.md new file mode 100644 index 0000000000000..1461ab9ac6833 --- /dev/null +++ b/api-reference/beta/api/chartlineformat_get.md @@ -0,0 +1,61 @@ +# Get ChartLineFormat + +Retrieve the properties and relationships of chartlineformat object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/axes/seriesaxis/format/line +GET /workbook/worksheets()/charts()/axes/categoryaxis/format/line +GET /workbook/worksheets()/charts()/axes/seriesaxis/majorgridlines/format/line +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartLineFormat](../resources/chartlineformat.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/seriesaxis/format/line +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 28 + +{ + "color": "color-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartlineformat_update.md b/api-reference/beta/api/chartlineformat_update.md new file mode 100644 index 0000000000000..7eeede6afb61a --- /dev/null +++ b/api-reference/beta/api/chartlineformat_update.md @@ -0,0 +1,69 @@ +# Update chartlineformat + +Update the properties of chartlineformat object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/axes/seriesaxis/format/line +PATCH /workbook/worksheets()/charts()/axes/categoryaxis/format/line +PATCH /workbook/worksheets()/charts()/axes/seriesaxis/majorgridlines/format/line +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|color|string|HTML color code representing the color of lines in the chart.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartLineFormat](../resources/chartlineformat.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/axes/seriesaxis/format/line +Content-type: application/json +Content-length: 28 + +{ + "color": "color-value" +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 28 + +{ + "color": "color-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartpoint_get.md b/api-reference/beta/api/chartpoint_get.md new file mode 100644 index 0000000000000..d0f523585c82f --- /dev/null +++ b/api-reference/beta/api/chartpoint_get.md @@ -0,0 +1,60 @@ +# Get ChartPoint + +Retrieve the properties and relationships of chartpoint object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/series()/points() +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartPoint](../resources/chartpoint.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series()/points() +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 20 + +{ + "value": { + } +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartpoint_list.md b/api-reference/beta/api/chartpoint_list.md new file mode 100644 index 0000000000000..ed0978b8f2e09 --- /dev/null +++ b/api-reference/beta/api/chartpoint_list.md @@ -0,0 +1,65 @@ +# List ChartPointsCollection + +Retrieve a list of chartpoint objects. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/series()/points +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [ChartPoint](../resources/chartpoint.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series()/points +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 57 + +{ + "value": [ + { + "value": { + } + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartpointscollection_itemat.md b/api-reference/beta/api/chartpointscollection_itemat.md new file mode 100644 index 0000000000000..73e9f32a77835 --- /dev/null +++ b/api-reference/beta/api/chartpointscollection_itemat.md @@ -0,0 +1,73 @@ +# ChartPointsCollection: ItemAt + +Retrieve a point based on its position within the series. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/series()/points/ItemAt + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +## Response +If successful, this method returns `200, OK` response code and [ChartPoint](../resources/chartpoint.md) object in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series()/points/ItemAt +Content-type: application/json +Content-length: 20 + +{ + "index": { + } +} +``` + +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 20 + +{ + "value": { + } +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartseries_get.md b/api-reference/beta/api/chartseries_get.md new file mode 100644 index 0000000000000..a1ab4025afb11 --- /dev/null +++ b/api-reference/beta/api/chartseries_get.md @@ -0,0 +1,59 @@ +# Get ChartSeries + +Retrieve the properties and relationships of chartseries object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/series() +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartSeries](../resources/chartseries.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series() +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 26 + +{ + "name": "name-value" +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartseries_list.md b/api-reference/beta/api/chartseries_list.md new file mode 100644 index 0000000000000..bc62de5afcf01 --- /dev/null +++ b/api-reference/beta/api/chartseries_list.md @@ -0,0 +1,64 @@ +# List ChartSeriesCollection + +Retrieve a list of chartseries objects. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/series +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [ChartSeries](../resources/chartseries.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 59 + +{ + "value": [ + { + "name": "name-value" + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartseries_list_points.md b/api-reference/beta/api/chartseries_list_points.md new file mode 100644 index 0000000000000..32087f6c4d8c4 --- /dev/null +++ b/api-reference/beta/api/chartseries_list_points.md @@ -0,0 +1,63 @@ +# List points + +Retrieve a list of chartpoints objects. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +GET /workbook/worksheets()/charts()/series()/points +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [ChartPoints](../resources/chartpoint.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series()/points +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 32 + +{ + "value": [ + { + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/chartseries_post_points.md b/api-reference/beta/api/chartseries_post_points.md new file mode 100644 index 0000000000000..c9fa06c9f0ed5 --- /dev/null +++ b/api-reference/beta/api/chartseries_post_points.md @@ -0,0 +1,65 @@ +# Create ChartPoints + +Use this API to create a new ChartPoints. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +POST /workbook/worksheets()/charts()/series()/points + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply a JSON representation of [ChartPoints](../resources/chartpoint.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [ChartPoints](../resources/chartpoint.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series()/points +Content-type: application/json +Content-length: 3 + +{ +} +``` +In the request body, supply a JSON representation of [ChartPoints](../resources/chartpoint.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 3 + +{ +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/outlookitem_update.md b/api-reference/beta/api/chartseries_update.md similarity index 55% rename from api-reference/beta/api/outlookitem_update.md rename to api-reference/beta/api/chartseries_update.md index 02542afff1004..15a27a6f527ef 100644 --- a/api-reference/beta/api/outlookitem_update.md +++ b/api-reference/beta/api/chartseries_update.md @@ -1,49 +1,42 @@ -# Update outlookitem +# Update chartseries -Update the properties of outlookitem object. -### Prerequisites +Update the properties of chartseries object. +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http - +PATCH /workbook/worksheets()/charts()/series() ``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|categories|String|| -|changeKey|String|| -|createdDateTime|DateTimeOffset|| -|lastModifiedDateTime|DateTimeOffset|| +|name|string|Represents the name of a series in a chart.| -### Response -If successful, this method returns a `200 OK` response code and updated [outlookItem](../resources/outlookitem.md) object in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and updated [ChartSeries](../resources/chartseries.md) object in the response body. +## Example ##### Request Here is an example of the request. ```http - +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series() Content-type: application/json -Content-length: 165 +Content-length: 26 { - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value", - "changeKey": "changeKey-value", - "categories": [ - "categories-value" - ] + "name": "name-value" } ``` ##### Response @@ -51,20 +44,15 @@ Here is an example of the response. Note: The response object shown here may be ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 185 +Content-length: 26 { - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value", - "changeKey": "changeKey-value", - "categories": [ - "categories-value" - ], - "id": "id-value" + "name": "name-value" } ``` @@ -72,7 +60,7 @@ Content-length: 185 2015-10-25 14:57:30 UTC --> ```http -POST /devices//Microsoft.Graph.getMemberObjects +POST /workbook/worksheets()/charts()/series/ItemAt ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer | + -### Request body +## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| +|index|number|Index value of the object to be retrieved. Zero-indexed.| -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. +## Response +If successful, this method returns `200, OK` response code and [ChartSeries](../resources/chartseries.md) object in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. ```http -POST https://graph.microsoft.com/beta/devices//getMemberObjects +POST https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/series/ItemAt Content-type: application/json -Content-length: 33 +Content-length: 20 { - "securityEnabledOnly": true + "index": { + } } ``` @@ -47,17 +49,15 @@ Here is an example of the response. Note: The response object shown here may be ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 39 +Content-length: 26 { - "value": [ - "string-value" - ] + "name": "name-value" } ``` @@ -65,7 +65,7 @@ Content-length: 39 2015-10-25 14:57:30 UTC --> +```http +GET /workbook/worksheets()/charts()/title +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer | + + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [ChartTitle](../resources/charttitle.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/title +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 64 + +{ + "overlay": true, + "text": "text-value", + "visible": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/charttitle_update.md b/api-reference/beta/api/charttitle_update.md new file mode 100644 index 0000000000000..3a41c80957d7d --- /dev/null +++ b/api-reference/beta/api/charttitle_update.md @@ -0,0 +1,73 @@ +# Update charttitle + +Update the properties of charttitle object. +## Prerequisites +The following **scopes** are required to execute this API: +## HTTP request + +```http +PATCH /workbook/worksheets()/charts()/title +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer | + + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|overlay|boolean|Boolean value representing if the chart title will overlay the chart or not.| +|text|string|Represents the title text of a chart.| +|visible|boolean|A boolean value the represents the visibility of a chart title object.| + +## Response +If successful, this method returns a `200 OK` response code and updated [ChartTitle](../resources/charttitle.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/me/drive/items//workbook/worksheets()/charts()/title +Content-type: application/json +Content-length: 64 + +{ + "overlay": true, + "text": "text-value", + "visible": true +} +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 64 + +{ + "overlay": true, + "text": "text-value", + "visible": true +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/connector_get.md b/api-reference/beta/api/connector_get.md new file mode 100644 index 0000000000000..efac56889aa17 --- /dev/null +++ b/api-reference/beta/api/connector_get.md @@ -0,0 +1,61 @@ +# Get connector + +Retrieve the properties of a connector object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +GET /connectorGroups//members/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [connector](../resources/connector.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/{ver}/connectors/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 124 + +{ + "id": "id-value", + "machineName": "machineName-value", + "externalIp": "externalIp-value", + "status": "status-value" +} +``` + + + diff --git a/api-reference/beta/api/connector_list.md b/api-reference/beta/api/connector_list.md new file mode 100644 index 0000000000000..4315f5c2e63f6 --- /dev/null +++ b/api-reference/beta/api/connector_list.md @@ -0,0 +1,66 @@ +# List connectors + +Retrieve a list of connector objects. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +GET /connectors +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [connector](../resources/connector.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/{ver}/connectors +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 169 + +{ + "value": [ + { + "id": "id-value", + "machineName": "machineName-value", + "externalIp": "externalIp-value", + "status": "status-value" + } + ] +} +``` + + + diff --git a/api-reference/beta/api/connector_list_memberof.md b/api-reference/beta/api/connector_list_memberof.md new file mode 100644 index 0000000000000..4506f7b8a89c4 --- /dev/null +++ b/api-reference/beta/api/connector_list_memberof.md @@ -0,0 +1,66 @@ +# List memberOf + +Retrieve the connectorgroup the connector is a member of. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +GET /connectors//memberOf +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [connectorGroup](../resources/connectorgroup.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/{ver}/connectors//memberOf +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 164 + +{ + "value": [ + { + "id": "id-value", + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": true + } + ] +} +``` + + + diff --git a/api-reference/beta/api/connector_post_memberof.md b/api-reference/beta/api/connector_post_memberof.md new file mode 100644 index 0000000000000..b4db914f05014 --- /dev/null +++ b/api-reference/beta/api/connector_post_memberof.md @@ -0,0 +1,69 @@ +# Add Connector to connectorGroup + +Use this API to add a connector to a new connectorGroup. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +POST /connectors//memberOf + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer. Required| + +## Request body +In the request body, supply a JSON representation of [connectorGroup](../resources/connectorgroup.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [connectorGroup](../resources/connectorgroup.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/{ver}/connectors//memberOf +Content-type: application/json +Content-length: 99 + +{ + "@odata.id": "https://graph.microsoft.com/%7Bver%7D/connectorGroups/%3Cid%3E" +} +``` +In the request body, supply a JSON representation of [connectorGroup](../resources/connectorgroup.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 119 + +{ + "id": "id-value", + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": false +} +``` + + + diff --git a/api-reference/beta/api/connectorgroup_delete.md b/api-reference/beta/api/connectorgroup_delete.md new file mode 100644 index 0000000000000..269893eeff7f1 --- /dev/null +++ b/api-reference/beta/api/connectorgroup_delete.md @@ -0,0 +1,54 @@ +# Delete connectorGroup + +Delete a connectorGroup. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* + +> **Note:** The connector group must not have any connectors associated with it. + +## HTTP request + +```http +DELETE /connectorGroups/ +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. + + +## Response +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +DELETE https://graph.microsoft.com/{ver}/connectorGroups/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 204 No Content +``` + + + diff --git a/api-reference/beta/api/connectorgroup_get.md b/api-reference/beta/api/connectorgroup_get.md new file mode 100644 index 0000000000000..e9f93c94f16fa --- /dev/null +++ b/api-reference/beta/api/connectorgroup_get.md @@ -0,0 +1,61 @@ +# Get connectorGroup + +Retrieve the properties of a connectorGroup object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +GET /connectorGroups/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [connectorGroup](../resources/connectorgroup.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/{ver}/connectorGroups/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 119 + +{ + "id": "id-value", + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": true +} +``` + + + diff --git a/api-reference/beta/api/connectorgroup_list.md b/api-reference/beta/api/connectorgroup_list.md new file mode 100644 index 0000000000000..390eda3c84c3c --- /dev/null +++ b/api-reference/beta/api/connectorgroup_list.md @@ -0,0 +1,66 @@ +# List connectorGroups + +Retrieve a list of connectorgroup objects. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +GET /connectorGroups +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [connectorGroup](../resources/connectorgroup.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/{ver}/connectorGroups +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 164 + +{ + "value": [ + { + "id": "id-value", + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": true + } + ] +} +``` + + + diff --git a/api-reference/beta/api/application_list.md b/api-reference/beta/api/connectorgroup_list_applications.md similarity index 51% rename from api-reference/beta/api/application_list.md rename to api-reference/beta/api/connectorgroup_list_applications.md index 94f68bb893a79..3578ccbadb56f 100644 --- a/api-reference/beta/api/application_list.md +++ b/api-reference/beta/api/connectorgroup_list_applications.md @@ -1,26 +1,26 @@ # List applications -Retrieve a list of application objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of application objects associated with the connectorGroup. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request ```http -GET /applications +GET /connectorGroups//applications ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [application](../resources/application.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http -GET https://graph.microsoft.com/beta/applications +GET https://graph.microsoft.com/{ver}/connectorGroups//applications ``` ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. @@ -39,41 +39,22 @@ Here is an example of the response. Note: The response object shown here may be "isCollection": true } --> ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 781 +Content-length: 420 { "value": [ { - "addIns": [ - { - "id": "id-value", - "type": "type-value", - "properties": [ - { - "key": "key-value", - "value": "value-value" - } - ] - } - ], "appId": "appId-value", - "appRoles": [ - { - "allowedMemberTypes": [ - "allowedMemberTypes-value" - ], - "description": "description-value", - "displayName": "displayName-value", - "id": "id-value", - "isEnabled": true, - "origin": "origin-value", - "value": "value-value" - } - ], - "availableToOtherOrganizations": true, - "displayName": "displayName-value", - "errorUrl": "errorUrl-value" + "onPremisesPublishing": { + "externalUrl": "externalUrl-value", + "internalUrl": "internalUrl-value", + "externalAuthenticationType": "externalAuthenticationType-value", + "customDomainCertificate": "customDomainCertificate-value", + "isTranslateHostHeaderEnabled": true, + "isOnPremPublishingEnabled": true + } } ] } @@ -87,4 +68,4 @@ Content-length: 781 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/connectorgroup_list_members.md b/api-reference/beta/api/connectorgroup_list_members.md new file mode 100644 index 0000000000000..d316934486eed --- /dev/null +++ b/api-reference/beta/api/connectorgroup_list_members.md @@ -0,0 +1,66 @@ +# List members + +Retrieve a list of connector objects associated with a connectorGroup. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +GET /connectorGroups//members +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer. Required| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [connector](../resources/connector.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/{ver}/connectorGroups//members +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 169 + +{ + "value": [ + { + "id": "id-value", + "machineName": "machineName-value", + "externalIp": "externalIp-value", + "status": "status-value" + } + ] +} +``` + + + diff --git a/api-reference/beta/api/connectorgroup_post_applications.md b/api-reference/beta/api/connectorgroup_post_applications.md new file mode 100644 index 0000000000000..6e8665e97782d --- /dev/null +++ b/api-reference/beta/api/connectorgroup_post_applications.md @@ -0,0 +1,74 @@ +# Create application + +Use this API to create a new application. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +POST /connectorGroups//applications + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer. Required| + +## Request body +In the request body, supply a JSON representation of [application](../resources/application.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [application](../resources/application.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/{ver}/connectorGroups//applications +Content-type: application/json +Content-length: 329 + +{ + "@odata.id": "https://graph.microsoft.com/%7Bver%7D/applications/%7Bid%7D" +} +``` +In the request body, supply a JSON representation of [application](../resources/application.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 355 + +{ + "appId": "appId-value", + "onPremisesPublishing": { + "externalUrl": "externalUrl-value", + "internalUrl": "internalUrl-value", + "externalAuthenticationType": "externalAuthenticationType-value", + "customDomainCertificate": "customDomainCertificate-value", + "isTranslateHostHeaderEnabled": true, + "isOnPremPublishingEnabled": true + } +} +``` + + + diff --git a/api-reference/beta/api/connectorgroup_post_connectorgroups.md b/api-reference/beta/api/connectorgroup_post_connectorgroups.md new file mode 100644 index 0000000000000..1948b0d00ece5 --- /dev/null +++ b/api-reference/beta/api/connectorgroup_post_connectorgroups.md @@ -0,0 +1,71 @@ +# Create connectorGroup + +Use this API to create a new connectorGroup. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +POST /connectorGroups + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer. Requried| + +## Request body +In the request body, supply a JSON representation of [connectorGroup](../resources/connectorgroup.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [connectorGroup](../resources/connectorgroup.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/{ver}/connectorGroups +Content-type: application/json +Content-length: 99 + +{ + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": false +} +``` +In the request body, supply a JSON representation of [connectorGroup](../resources/connectorgroup.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 119 + +{ + "id": "id-value", + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": false +} +``` + + + diff --git a/api-reference/beta/api/connectorgroup_post_members.md b/api-reference/beta/api/connectorgroup_post_members.md new file mode 100644 index 0000000000000..631a24e642cae --- /dev/null +++ b/api-reference/beta/api/connectorgroup_post_members.md @@ -0,0 +1,69 @@ +# Add connector to connectorGroup + +Use this API to add a connector to a connectorGroup. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request + +```http +POST /connectorGroups//members/$ref +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer. Required| + + +## Request body +In the request body, supply a JSON representation of a link to a [connector](../resources/connector.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [connector](../resources/connector.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/{ver}/connectorGroups//members/$ref +Content-type: application/json +Content-length: 104 + +{ + "@odata.id": "https://graph.microsoft.com/%7Bver%7D/connector/%3Cid%3E" +} +``` +In the request body, supply a JSON representation of a link to a [connector](../resources/connector.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 124 + +{ + "id": "id-value", + "machineName": "machineName-value", + "externalIp": "externalIp-value", + "status": "status-value" +} +``` + + + diff --git a/api-reference/v1.0/api/outlookitem_update.md b/api-reference/beta/api/connectorgroup_update.md similarity index 51% rename from api-reference/v1.0/api/outlookitem_update.md rename to api-reference/beta/api/connectorgroup_update.md index 1f1864a49e6a8..9ec38e3816369 100644 --- a/api-reference/v1.0/api/outlookitem_update.md +++ b/api-reference/beta/api/connectorgroup_update.md @@ -1,49 +1,44 @@ -# Update outlookitem +# Update connectorGroups -Update the properties of outlookitem object. -### Prerequisites -One of the following **scopes** is required to execute this API: -### HTTP request +Update the properties of connectorgroup object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All Or Directory.AccessAsUser.All* +## HTTP request ```http - +PATCH /connectorGroups/ ``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer. Required| + -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|categories|String|| -|changeKey|String|| -|createdDateTime|DateTimeOffset|| -|lastModifiedDateTime|DateTimeOffset|| +|connectorGroupType|string| Possible values are: `applicationProxy`.| +|name|String|The name of the connectorGroup.| -### Response -If successful, this method returns a `200 OK` response code and updated [outlookItem](../resources/outlookitem.md) object in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and updated [connectorGroup](../resources/connectorgroup.md) object in the response body. +## Example ##### Request Here is an example of the request. ```http - +PATCH https://graph.microsoft.com/{ver}/connectorGroups/ Content-type: application/json -Content-length: 165 +Content-length: 99 { - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value", - "changeKey": "changeKey-value", - "categories": [ - "categories-value" - ] + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", } ``` ##### Response @@ -51,20 +46,18 @@ Here is an example of the response. Note: The response object shown here may be ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 185 +Content-length: 119 { - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value", - "changeKey": "changeKey-value", - "categories": [ - "categories-value" - ], - "id": "id-value" + "id": "id-value", + "name": "name-value", + "connectorGroupType": "connectorGroupType-value", + "isDefault": true } ``` @@ -72,8 +65,8 @@ Content-length: 185 2015-10-25 14:57:30 UTC --> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/contact_delete.md b/api-reference/beta/api/contact_delete.md index 676250fed47b5..9b597468cef91 100644 --- a/api-reference/beta/api/contact_delete.md +++ b/api-reference/beta/api/contact_delete.md @@ -1,33 +1,40 @@ # Delete contact Delete contact. -### Prerequisites -The following **scopes** are required to execute this API: +## Prerequisites +One of the following **scopes** is required to execute this API: *Contacts.ReadWrite* -### HTTP request +## HTTP request +A [contact](../resources/contact.md) from user's default [contactFolder](../resources/contactfolder.md). ```http DELETE /me/contacts/ -DELETE /users//contacts/ -DELETE /users//contacts/ -DELETE /me/contactFolders//contacts/ -DELETE /users//contactFolders//contacts/ -DELETE /users//contactFolders//contacts/ - +DELETE /users//contacts/ +``` +A [contact](../resources/contact.md) from a user's top level [contactFolder](../resources/contactfolder.md). +```http +DELETE /me/contactFolders//contacts/ +DELETE /users//contactFolders//contacts/ +``` +A [contact](../resources/contact.md) contained in a child folder of a [contactFolder](../resources/mailfolder.md). The +example below shows one level of nesting, but a contact can be located in a child of a child and so on. +```http +DELETE /me/contactFolder//childFolders//.../contacts/ +DELETE /users//contactFolders//childFolders//contacts/ ``` -### Request headers +## Request headers | Header | Value | |:---------------|:--------| | Authorization | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. +A [contact](../resources/contact.md) from user's default [contactFolder](../resources/contactfolder.md). ```http GET /me/contacts/ -GET /users//contacts/ -GET /users//contacts/ -GET /me/contactfolders//contacts/ -GET /users//contactfolders//contacts/ -GET /users//contactFolders//contacts/ +GET /users//contacts/ ``` -### Optional query parameters +A [contact](../resources/contact.md) from a user's top level [contactFolder](../resources/contactfolder.md). +```http +GET /me/contactfolders//contacts/ +GET /users//contactfolders//contacts/ +``` +A [contact](../resources/contact.md) contained in a child folder of a [contactFolder](../resources/mailfolder.md). The +example below shows one level of nesting, but a contact can be located in a child of a child and so on. +```http +GET /me/contactFolder//childFolders//.../contacts/ +GET /users//contactFolders//childFolders//contacts/ +``` +## Optional query parameters |Name|Value|Description| |:---------------|:--------|:-------| |$expand|string|Comma-separated list of relationships to expand and include in the response. See relationships table of [contact](../resources/contact.md) object for supported names. | |$select|string|Comma-separated list of properties to include in the response.| -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [contact](../resources/contact.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 210 - Content-length: 1977 + { "id": "AAMkAGI2THk0AAA=", "createdDateTime": "2014-10-19T23:08:24Z", @@ -85,25 +93,31 @@ Content-length: 1977 "department": "Sales & Marketing", "officeLocation": "20/1101", "profession": null, - "businessHomePage": "http://www.contoso.com/", "assistantName": null, "manager": null, - "homePhones": [], - "businessPhones": [ - "+1 918 555 0101" - ], - "homeAddress": {}, - "businessAddress": { - "street": "10 Contoso Way", - "city": "Redmond", - "state": "WA", - "countryOrRegion": "USA", - "postalCode": "98075" - }, - "otherAddress": {}, + "phones": [{ + "type": "business", + "number": "+1 918 555 0101" + }], + "postalAddresses": [{ + "type": "business", + "postOfficeBox": "P.O. Box 100", + "street": "123 Some street", + "city": "Seattle", + "state": "WA", + "countryOrRegion": "USA", + "postalCode": "98121" + }], "spouseName": null, "personalNotes": null, - "children": [] + "children": [], + "gender": null, + "websites": [{ + "type": "work", + "address": "http://www.contoso.com/", + "name": "Contoso" + }], + "weddingAnniversary": null } ``` diff --git a/api-reference/beta/api/contact_list_extensions.md b/api-reference/beta/api/contact_list_extensions.md index 03d1b72a8871d..c9b646639bc8b 100644 --- a/api-reference/beta/api/contact_list_extensions.md +++ b/api-reference/beta/api/contact_list_extensions.md @@ -1,28 +1,28 @@ # List extensions Retrieve a list of extension objects. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http GET /users//contacts//extensions GET /drive/root/createdByUser/contacts//extensions GET /drive/root/lastModifiedByUser/contacts//extensions ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Extension](../resources/extension.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 55 diff --git a/api-reference/beta/api/contact_post_extensions.md b/api-reference/beta/api/contact_post_extensions.md deleted file mode 100644 index cc2547ebdc57e..0000000000000 --- a/api-reference/beta/api/contact_post_extensions.md +++ /dev/null @@ -1,66 +0,0 @@ -# Create Extension - -Use this API to create a new Extension. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /users//contacts//extensions -POST /drive/root/createdByUser/contacts//extensions -POST /drive/root/lastModifiedByUser/contacts//extensions - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [Extension](../resources/extension.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [Extension](../resources/extension.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/me/contacts//extensions -Content-type: application/json -Content-length: 3 - -{ -} -``` -In the request body, supply a JSON representation of [extension](../resources/extension.md) object. -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 22 - -{ - "id": "id-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/contact_update.md b/api-reference/beta/api/contact_update.md index 7ce7ded695685..e9c9accd866fd 100644 --- a/api-reference/beta/api/contact_update.md +++ b/api-reference/beta/api/contact_update.md @@ -1,69 +1,74 @@ # Update contact Update the properties of contact object. -### Prerequisites -The following **scopes** are required to execute this API: +## Prerequisites +One of the following **scopes** is required to execute this API: *Contacts.ReadWrite* -### HTTP request +## HTTP request +A [contact](../resources/contact.md) from user's default [contactFolder](../resources/contactfolder.md). ```http PATCH /me/contacts/ -PATCH /users//contacts/ -PATCH /users//contacts/ -PATCH /me/contactFolders//contacts/ -PATCH /users//contactFolders//contacts/ -PATCH /users//contactFolders//contacts/ +PATCH /users//contacts/ ``` -### Request headers +A [contact](../resources/contact.md) from a user's top level [contactFolder](../resources/contactfolder.md). +```http +PATCH /me/contactFolders//contacts/ +PATCH /users//contactFolders//contacts/ +``` +A [contact](../resources/contact.md) contained in a child folder of a [contactFolder](../resources/mailfolder.md). The +example below shows one level of nesting, but a contact can be located in a child of a child and so on. +```http +PATCH /me/contactFolder//childFolders//.../contacts/ +PATCH /users//contactFolders//childFolders//contacts/ +``` +## Request headers | Header | Value | |:---------------|:--------| | Authorization | Bearer . Required. | -| Content-Type | application/json | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| |assistantName|String|The name of the contact's assistant.| |birthday|DateTimeOffset|The contact's birthday.| -|businessAddress|[PhysicalAddress](../resources/physicaladdress.md)|The contact's business address.| -|businessHomePage|String|The business home page of the contact.| -|businessPhones|String|The contact's business phone numbers.| |categories|String|The categories associated with the contact.| -|changeKey|String|Identifies the version of the contact. Every time the contact is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.| |children|String|| |companyName|String|The name of the contact's company.| |department|String|The contact's department.| |displayName|String|The contact's display name.| |emailAddresses|[EmailAddress](../resources/emailaddress.md) collection|The contact's email addresses.| |fileAs|String|The name the contact is filed under.| +|gender |String |The contact's gender. | |generation|String|The contact's generation.| |givenName|String|The contact's given name.| -|homeAddress|[PhysicalAddress](../resources/physicaladdress.md)|The contact's home address.| -|homePhones|String collection|The contact's home phone numbers.| |imAddresses|String|The contact's instant messaging (IM) addresses.| |initials|String|The contact's initials.| |jobTitle|String|The contact’s job title.| |manager|String|The name of the contact's manager. |middleName|String|The contact's middle name.| -|mobilePhone|String|The contact's mobile phone number.| |nickName|String|The contact's nickname.| |officeLocation|String|The location of the contact's office.| -|otherAddress|[PhysicalAddress](../resources/physicaladdress.md)|Other addresses for the contact.| |parentFolderId|String|The ID of the contact's parent folder.| |personalNotes|String|The user's notes about the contact.| +|phones |[phone](../resources/phone.md) collection |Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone. | +|postalAddresses |[physicalAddress](../resources/physicalAddress.md) collection |Addresses associated with the contact, for example, home address and business address. | |profession|String|The contact's profession.| |spouseName|String|The name of the contact's spouse.| |surname|String|The contact's surname.| |title|String|The contact's title.| +|websites |[website](../resources/website.md) collection|Web sites associated with the contact. | +|weddingAnniversary |Date |The contact's wedding anniversary. | |yomiCompanyName|String|The phonetic Japanese company name of the contact. This property is optional.| |yomiGivenName|String|The phonetic Japanese given name (first name) of the contact. This property is optional.| |yomiSurname|String|The phonetic Japanese surname (last name) of the contact. This property is optional.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [contact](../resources/contact.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +DELETE /me/contactFolders/ DELETE /users//contactFolders/ -DELETE /drive/root/createdByUser/contactFolders/ -DELETE /drive/root/lastModifiedByUser/contactFolders/ - ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/contactfolder_get.md b/api-reference/beta/api/contactfolder_get.md index 07794162000d0..d0187733a92d9 100644 --- a/api-reference/beta/api/contactfolder_get.md +++ b/api-reference/beta/api/contactfolder_get.md @@ -1,28 +1,27 @@ # Get contactFolder -Retrieve the properties and relationships of contactfolder object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get a contact folder by using the contact folder ID. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Contacts.ReadWrite; Contacts.Read* +## HTTP request ```http +GET /me/contactFolders/ GET /users//contactFolders/ -GET /drive/root/createdByUser/contactFolders/ -GET /drive/root/lastModifiedByUser/contactFolders/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [contactFolder](../resources/contactfolder.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 104 { - "parentFolderId": "parentFolderId-value", - "displayName": "displayName-value", - "id": "id-value" + "displayName": "Finance", + "id": "AAMkAGI2TKI5AAA=", + "parentFolderId": "AAMkAGI2AAEOAAA=", + "wellKnownName": null } ``` @@ -58,4 +59,4 @@ Content-length: 104 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/contactfolder_list_childfolders.md b/api-reference/beta/api/contactfolder_list_childfolders.md index 478f1ed8044ca..d5eb11b98082d 100644 --- a/api-reference/beta/api/contactfolder_list_childfolders.md +++ b/api-reference/beta/api/contactfolder_list_childfolders.md @@ -1,28 +1,27 @@ # List childFolders -Retrieve a list of contactfolder objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get a collection of child folders under the specified contact folder. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Contacts.Read; Contacts.ReadWrite* +## HTTP request ```http +GET /me/contactFolders//childFolders GET /users//contactFolders//childFolders -GET /drive/root/createdByUser/contactFolders//childFolders -GET /drive/root/lastModifiedByUser/contactFolders//childFolders ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [ContactFolder](../resources/contactfolder.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 145 @@ -63,4 +63,4 @@ Content-length: 145 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/contactfolder_list_contacts.md b/api-reference/beta/api/contactfolder_list_contacts.md index 0747187c089d5..ed5a2737251f8 100644 --- a/api-reference/beta/api/contactfolder_list_contacts.md +++ b/api-reference/beta/api/contactfolder_list_contacts.md @@ -1,28 +1,31 @@ # List contacts -Retrieve a list of contact objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get all the contacts in the signed-in user's mailbox (.../me/contacts), or from the specified contact folder. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Contacts.Read; Contacts.ReadWrite* +## HTTP request ```http +GET /me/contacts +GET /users//contacts + +GET /me/contactFolders//contacts GET /users//contactFolders//contacts -GET /drive/root/createdByUser/contactFolders//contacts -GET /drive/root/lastModifiedByUser/contactFolders//contacts ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Contact](../resources/contact.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 263 @@ -66,4 +70,4 @@ Content-length: 263 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/contactfolder_post_childfolders.md b/api-reference/beta/api/contactfolder_post_childfolders.md index c8f7554776f80..288ffc3592ff8 100644 --- a/api-reference/beta/api/contactfolder_post_childfolders.md +++ b/api-reference/beta/api/contactfolder_post_childfolders.md @@ -1,29 +1,31 @@ # Create ContactFolder -Use this API to create a new ContactFolder. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Create a new contactFolder as a child of a specified folder. + +You can also [create a new contactFolder under the user's default contact folder](user_post_contactfolders.md). +## Prerequisites +One of the following **scopes** is required to execute this API: +*Contacts.ReadWrite* +## HTTP request ```http +POST /me/contactFolders//childFolders POST /users//contactFolders//childFolders -POST /drive/root/createdByUser/contactFolders//childFolders -POST /drive/root/lastModifiedByUser/contactFolders//childFolders - ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply a JSON representation of [ContactFolder](../resources/contactfolder.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [ContactFolder](../resources/contactfolder.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 104 @@ -67,4 +69,4 @@ Content-length: 104 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/contactfolder_post_contacts.md b/api-reference/beta/api/contactfolder_post_contacts.md index 2a5208a1eb0e9..ae708eafc087d 100644 --- a/api-reference/beta/api/contactfolder_post_contacts.md +++ b/api-reference/beta/api/contactfolder_post_contacts.md @@ -1,29 +1,33 @@ # Create Contact -Use this API to create a new Contact. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Add a contact to the root Contacts folder or to the `contacts` endpoint of another contact folder. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Contacts.ReadWrite* +## HTTP request ```http -POST /users//contactFolders//contacts -POST /drive/root/createdByUser/contactFolders//contacts -POST /drive/root/lastModifiedByUser/contactFolders//contacts +POST /me/contacts +POST /users//contacts +POST /me/contactFolders//contacts +POST /users//contactFolders//contacts ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply a JSON representation of [Contact](../resources/contact.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [Contact](../resources/contact.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 210 diff --git a/api-reference/beta/api/contactfolder_update.md b/api-reference/beta/api/contactfolder_update.md index 3b72d6f12b42a..71e0c7965e303 100644 --- a/api-reference/beta/api/contactfolder_update.md +++ b/api-reference/beta/api/contactfolder_update.md @@ -1,31 +1,34 @@ # Update contactfolder Update the properties of contactfolder object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Contacts.ReadWrite* +## HTTP request ```http +PATCH /me/contactFolders/ PATCH /users//contactFolders/ -PATCH /drive/root/createdByUser/contactFolders/ -PATCH /drive/root/lastModifiedByUser/contactFolders/ ``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| |displayName|String|The folder's display name.| |parentFolderId|String|The ID of the folder's parent folder.| +|wellKnownName|string|The name of the folder if the folder is a recognized folder. Currently `contacts` is the only recognized contacts folder.| -### Response + +## Response If successful, this method returns a `200 OK` response code and updated [contactFolder](../resources/contactfolder.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 104 { "parentFolderId": "parentFolderId-value", "displayName": "displayName-value", + "wellKnownName": "wellKnownName-value", "id": "id-value" } ``` @@ -68,4 +73,4 @@ Content-length: 104 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversation_delete.md b/api-reference/beta/api/conversation_delete.md index f4ebcf2c05176..2084b08d8b9ac 100644 --- a/api-reference/beta/api/conversation_delete.md +++ b/api-reference/beta/api/conversation_delete.md @@ -1,29 +1,28 @@ # Delete conversation Delete conversation. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All* + +## HTTP request ```http DELETE /groups//conversations/ -DELETE /users//joinedGroups//conversations/ -DELETE /drive/root/createdByUser/joinedGroups//conversations/ - ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversation_get.md b/api-reference/beta/api/conversation_get.md index ad2bd318402a4..8f5aff250a797 100644 --- a/api-reference/beta/api/conversation_get.md +++ b/api-reference/beta/api/conversation_get.md @@ -1,28 +1,27 @@ # Get conversation Retrieve the properties and relationships of conversation object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All; Group.Read.All* +## HTTP request ```http GET /groups//conversations/ -GET /users//joinedGroups//conversations/ -GET /drive/root/createdByUser/joinedGroups//conversations/ + ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [conversation](../resources/conversation.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 201 @@ -63,4 +63,4 @@ Content-length: 201 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversation_list_threads.md b/api-reference/beta/api/conversation_list_threads.md index 840fe3b5776e2..2303f3fffe1bb 100644 --- a/api-reference/beta/api/conversation_list_threads.md +++ b/api-reference/beta/api/conversation_list_threads.md @@ -1,28 +1,28 @@ # List threads -Retrieve a list of conversationthread objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get all the threads in a group conversation. +Note: You can also [get all the threads of a group](group_list_threads.md). + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All; Group.Read.All* +## HTTP request ```http GET /groups//conversations//threads -GET /users//joinedGroups//conversations//threads -GET /drive/root/createdByUser/joinedGroups//conversations//threads ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [ConversationThread](../resources/conversationthread.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [conversationThread](../resources/conversationthread.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 536 @@ -82,4 +83,4 @@ Content-length: 536 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversation_post_threads.md b/api-reference/beta/api/conversation_post_threads.md index b77b5f5f7f5c3..a27d5355cb7d5 100644 --- a/api-reference/beta/api/conversation_post_threads.md +++ b/api-reference/beta/api/conversation_post_threads.md @@ -1,29 +1,33 @@ # Create thread -Use this API to create a new thread. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Create a new thread in the specified conversation. + +A thread and post are created as specified. Use [reply thread](conversationthread_reply.md) to further post +to that thread. Or, if you get the post ID, you can also [reply](post_reply.md) to that post in that thread. + +Note: You can also [start a new conversation by first creating a thread](group_post_threads.md). + +## Prerequisites +The following **scopes** are required to execute this API: +*Group.ReadWrite.All* +## HTTP request ```http POST /groups//conversations//threads -POST /users//joinedGroups//conversations//threads -POST /drive/root/createdByUser/joinedGroups//conversations//threads - ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply a JSON representation of [ConversationThread](../resources/conversationthread.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [ConversationThread](../resources/conversationthread.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 201 Created Content-type: application/json -Content-length: 419 +Content-length: 346 { - "toRecipients": [ - { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - } - ], - "topic": "topic-value", - "hasAttachments": true, - "lastDeliveredDateTime": "datetime-value", - "uniqueSenders": [ - "uniqueSenders-value" - ], - "ccRecipients": [ - { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - } - ] + "id": "thread-id-value" } ``` @@ -106,4 +76,4 @@ Content-length: 419 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversation_update.md b/api-reference/beta/api/conversation_update.md deleted file mode 100644 index 8e77226c99efd..0000000000000 --- a/api-reference/beta/api/conversation_update.md +++ /dev/null @@ -1,84 +0,0 @@ -# Update conversation - -Update the properties of conversation object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -PATCH /groups//conversations/ -PATCH /users//joinedGroups//conversations/ -PATCH /drive/root/createdByUser/joinedGroups//conversations/ -``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. - -| Property | Type |Description| -|:---------------|:--------|:----------| -|hasAttachments|Boolean|Indicates whether the Conversation has at least one attachment.| -|lastDeliveredDateTime|DateTimeOffset|| -|preview|String|| -|topic|String|The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.| -|uniqueSenders|String|All the users that sent a message to this Conversation.| - -### Response -If successful, this method returns a `200 OK` response code and updated [conversation](../resources/conversation.md) object in the response body. -### Example -##### Request -Here is an example of the request. - -```http -PATCH https://graph.microsoft.com/beta/groups//conversations/ -Content-type: application/json -Content-length: 181 - -{ - "topic": "topic-value", - "hasAttachments": true, - "lastDeliveredDateTime": "datetime-value", - "uniqueSenders": [ - "uniqueSenders-value" - ], - "preview": "preview-value" -} -``` -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 201 - -{ - "topic": "topic-value", - "hasAttachments": true, - "lastDeliveredDateTime": "datetime-value", - "uniqueSenders": [ - "uniqueSenders-value" - ], - "preview": "preview-value", - "id": "id-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/conversationthread_delete.md b/api-reference/beta/api/conversationthread_delete.md index 86d37c8da12df..91fe461b94546 100644 --- a/api-reference/beta/api/conversationthread_delete.md +++ b/api-reference/beta/api/conversationthread_delete.md @@ -1,29 +1,30 @@ # Delete conversationThread Delete conversationThread. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All* + +## HTTP request ```http DELETE /groups//threads/ DELETE /groups//conversations//threads/ -DELETE /users//joinedGroups//threads/ ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http GET /groups//threads/ GET /groups//conversations//threads/ -GET /users//joinedGroups//threads/ + ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [conversationThread](../resources/conversationthread.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 419 @@ -77,4 +80,4 @@ Content-length: 419 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversationthread_list_posts.md b/api-reference/beta/api/conversationthread_list_posts.md index efb003f59cbc1..b20838c4134d0 100644 --- a/api-reference/beta/api/conversationthread_list_posts.md +++ b/api-reference/beta/api/conversationthread_list_posts.md @@ -1,28 +1,31 @@ # List posts -Retrieve a list of post objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get the posts of the specified thread. You can specify both the parent conversation and the thread, or, +you can specify the thread without referencing the parent conversation. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All; Group.Read.All* + +## HTTP request ```http GET /groups//threads//posts GET /groups//conversations//threads//posts -GET /users//joinedGroups//threads//posts + ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Post](../resources/post.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 523 @@ -48,8 +52,7 @@ Content-length: 523 "value": [ { "body": { - "contentType": { - }, + "contentType": "", "content": "content-value" }, "receivedDateTime": "datetime-value", @@ -80,4 +83,4 @@ Content-length: 523 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversationthread_post_posts.md b/api-reference/beta/api/conversationthread_post_posts.md deleted file mode 100644 index ed9a141ccfad9..0000000000000 --- a/api-reference/beta/api/conversationthread_post_posts.md +++ /dev/null @@ -1,105 +0,0 @@ -# Create Post - -Use this API to create a new Post. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /groups//threads//posts -POST /groups//conversations//threads//posts -POST /users//joinedGroups//threads//posts - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [Post](../resources/post.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [Post](../resources/post.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/groups//threads//posts -Content-type: application/json -Content-length: 414 - -{ - "body": { - "contentType": { - }, - "content": "content-value" - }, - "receivedDateTime": "datetime-value", - "hasAttachments": true, - "from": { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - }, - "sender": { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - }, - "conversationThreadId": "conversationThreadId-value" -} -``` -In the request body, supply a JSON representation of [post](../resources/post.md) object. -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 414 - -{ - "body": { - "contentType": { - }, - "content": "content-value" - }, - "receivedDateTime": "datetime-value", - "hasAttachments": true, - "from": { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - }, - "sender": { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - }, - "conversationThreadId": "conversationThreadId-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/conversationthread_reply.md b/api-reference/beta/api/conversationthread_reply.md index 59645213ee8bb..30e94482b1791 100644 --- a/api-reference/beta/api/conversationthread_reply.md +++ b/api-reference/beta/api/conversationthread_reply.md @@ -1,32 +1,35 @@ # conversationThread: reply +Reply to a thread in a group conversation and add a new post to it. You can specify the parent conversation +in the request, or, you can specify just the thread without the parent conversation. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All* + +## HTTP request ```http POST /groups//threads//reply POST /groups//conversations//threads//reply -POST /users//joinedGroups//threads//reply - ``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:---------------|:--------|:----------| -|post|Post|| +|post|[post](../resources/post.md)|The new post that is being replied with.| -### Response -If successful, this method returns `200, OK` response code. It does not return anything in the response body. +## Response +If successful, this method returns `202, Accepted` response code. It does not return anything in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. @@ -42,65 +45,21 @@ Content-length: 1131 { "post": { "body": { - "contentType": { - }, + "contentType": "", "content": "content-value" - }, - "receivedDateTime": "datetime-value", - "hasAttachments": true, - "from": { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - }, - "sender": { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - }, - "conversationThreadId": "conversationThreadId-value", - "newParticipants": [ - { - "emailAddress": { - "name": "name-value", - "address": "address-value" - } - } - ], - "conversationId": "conversationId-value", - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value", - "changeKey": "changeKey-value", - "categories": [ - "categories-value" - ], - "id": "id-value", - "inReplyTo": { - }, - "attachments": [ - { - "lastModifiedDateTime": "datetime-value", - "name": "name-value", - "contentType": "contentType-value", - "size": 99, - "isInline": true, - "id": "id-value" - } - ] + } } } ``` ##### Response -Here is an example of the response. +Here is an example of the response. ```http -HTTP/1.1 200 OK +HTTP/1.1 202 Accepted ``` \ No newline at end of file +}--> diff --git a/api-reference/beta/api/conversationthread_update.md b/api-reference/beta/api/conversationthread_update.md index 235c15edd52c1..f97885b56ebff 100644 --- a/api-reference/beta/api/conversationthread_update.md +++ b/api-reference/beta/api/conversationthread_update.md @@ -1,37 +1,33 @@ # Update conversationthread -Update the properties of conversationthread object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Lock or unlock a thread, to allow or avoid further posting to the thread. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Group.ReadWrite.All* + +## HTTP request ```http PATCH /groups//threads/ PATCH /groups//conversations//threads/ -PATCH /users//joinedGroups//threads/ + ``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer . Required. | +| Content-Type | application/json. Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|ccRecipients|Recipient|| -|hasAttachments|Boolean|| -|isLocked|Boolean|| -|lastDeliveredDateTime|DateTimeOffset|| -|preview|String|| -|toRecipients|Recipient|| -|topic|String|| -|uniqueSenders|String|| +|isLocked|Boolean|Indicates if the thread is locked. Set to `true` to disallow posting.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [conversationThread](../resources/conversationthread.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 419 @@ -101,7 +78,8 @@ Content-length: 419 "address": "address-value" } } - ] + ], + "isLocked": true } ``` @@ -113,4 +91,4 @@ Content-length: 419 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/device_checkmembergroups.md b/api-reference/beta/api/device_checkmembergroups.md deleted file mode 100644 index a59db89161c37..0000000000000 --- a/api-reference/beta/api/device_checkmembergroups.md +++ /dev/null @@ -1,74 +0,0 @@ -# device: checkMemberGroups - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /devices//Microsoft.Graph.checkMemberGroups - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|groupIds|String|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/devices//checkMemberGroups -Content-type: application/json -Content-length: 44 - -{ - "groupIds": [ - "groupIds-value" - ] -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/device_delete.md b/api-reference/beta/api/device_delete.md index 1458e245c85af..62fce960c1f9e 100644 --- a/api-reference/beta/api/device_delete.md +++ b/api-reference/beta/api/device_delete.md @@ -1,27 +1,28 @@ # Delete device Delete device. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.AccessAsUser.All* + +## HTTP request ```http DELETE /devices/ ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http GET /devices/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [device](../resources/device.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 322 diff --git a/api-reference/beta/api/device_list.md b/api-reference/beta/api/device_list.md index 8fc2814b34adc..303f941cb9ff0 100644 --- a/api-reference/beta/api/device_list.md +++ b/api-reference/beta/api/device_list.md @@ -1,26 +1,27 @@ # List devices -Retrieve a list of device objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of devices registered in the directory. + +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.AccessAsUser.All*, *Device.ReadWrite.All* + +## HTTP request ```http GET /devices ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [Device](../resources/device.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [device](../resources/device.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 399 { "value": [ @@ -48,7 +49,7 @@ Content-length: 399 "accountEnabled": true, "alternativeSecurityIds": [ { - "type": 99, + "type": 2, "identityProvider": "identityProvider-value", "key": "key-value" } @@ -56,7 +57,9 @@ Content-length: 399 "approximateLastSignInDateTime": "datetime-value", "deviceId": "deviceId-value", "deviceMetadata": "deviceMetadata-value", - "deviceVersion": 99 + "displayName" : "displayName-value", + "id" : "id-value", + "operatingSystem" : "operatingSystem-value" } ] } @@ -70,4 +73,4 @@ Content-length: 399 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/device_list_registeredowners.md b/api-reference/beta/api/device_list_registeredowners.md index f27303dd1ee10..2772236a51d65 100644 --- a/api-reference/beta/api/device_list_registeredowners.md +++ b/api-reference/beta/api/device_list_registeredowners.md @@ -1,26 +1,30 @@ # List registeredOwners -Retrieve a list of directoryobject objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of users that are registered owners of the device. +## Prerequisites +One of the following **scopes** is required to execute this API: +- *Device.ReadWrite.All* and *User.ReadBasic.All* +- *Directory.Read.All* +- *Directory.ReadWrite.All* +- *Directory.AccessAsUser.All* + +## HTTP request ```http GET /devices//registeredOwners ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 55 diff --git a/api-reference/beta/api/device_list_registeredusers.md b/api-reference/beta/api/device_list_registeredusers.md index e308f21b1580d..728181c47a6a7 100644 --- a/api-reference/beta/api/device_list_registeredusers.md +++ b/api-reference/beta/api/device_list_registeredusers.md @@ -1,26 +1,30 @@ # List registeredUsers -Retrieve a list of directoryobject objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of users that are registered users of the device. +## Prerequisites +One of the following **scopes** is required to execute this API: +- *Device.ReadWrite.All* and *User.ReadBasic.All* +- *Directory.Read.All* +- *Directory.ReadWrite.All* +- *Directory.AccessAsUser.All* + +## HTTP request ```http GET /devices//registeredUsers ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 55 diff --git a/api-reference/beta/api/device_post_devices.md b/api-reference/beta/api/device_post_devices.md new file mode 100644 index 0000000000000..4d52e38ed0d5e --- /dev/null +++ b/api-reference/beta/api/device_post_devices.md @@ -0,0 +1,89 @@ +# Create device + +Create a new device. +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* + +## HTTP request + +```http +POST /devices + +``` +## Request headers +| Name | Type | Description| +|:---------------|:--------|:----------| +| Authorization | string | Bearer . Required. | + +## Request body +In the request body, supply a JSON representation of [device](../resources/device.md) object. + + +## Response +If successful, this method returns `201, Created` response code and [device](../resources/device.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/devices +Content-type: application/json +Content-length: 364 + +{ + "accountEnabled": true, + "alternativeSecurityIds": [ + { + "type": 99, + "identityProvider": "identityProvider-value", + "key": "key-value" + } + ], + "approximateLastSignInDateTime": "datetime-value", + "deviceId": "deviceId-value", + "deviceMetadata": "deviceMetadata-value", + "deviceVersion": 99 +} +``` +In the request body, supply a JSON representation of [device](../resources/device.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 364 + +{ + "accountEnabled": true, + "alternativeSecurityIds": [ + { + "type": 99, + "identityProvider": "identityProvider-value", + "key": "key-value" + } + ], + "approximateLastSignInDateTime": "datetime-value", + "deviceId": "deviceId-value", + "deviceMetadata": "deviceMetadata-value", + "deviceVersion": 99 +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/device_post_registeredowners.md b/api-reference/beta/api/device_post_registeredowners.md index 00cd4527be7e6..e2ad465d8217c 100644 --- a/api-reference/beta/api/device_post_registeredowners.md +++ b/api-reference/beta/api/device_post_registeredowners.md @@ -1,27 +1,29 @@ # Create registeredOwner -Use this API to create a new registeredOwner. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Add a user as a registered owner of the device. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Directory.ReadWrite.All* or *Directory.AccessAsUser.All* + +## HTTP request ```http POST /devices//registeredOwners ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 51 diff --git a/api-reference/beta/api/device_post_registeredusers.md b/api-reference/beta/api/device_post_registeredusers.md index 5e2e656d2c313..84e8c9654fca2 100644 --- a/api-reference/beta/api/device_post_registeredusers.md +++ b/api-reference/beta/api/device_post_registeredusers.md @@ -1,27 +1,30 @@ # Create registeredUser -Use this API to create a new registeredUser. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Add a registered user for the device. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Directory.ReadWrite.All* or *Directory.AccessAsUser.All* + +## HTTP request ```http POST /devices//registeredUsers ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 51 diff --git a/api-reference/beta/api/device_update.md b/api-reference/beta/api/device_update.md index 8ce910a1cb89c..afbb2485ea788 100644 --- a/api-reference/beta/api/device_update.md +++ b/api-reference/beta/api/device_update.md @@ -1,40 +1,42 @@ # Update device -Update the properties of device object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Update the properties of a device. +## Prerequisites +One of the following **scopes** is required to execute this API: +*Device.ReadWrite.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* + +## HTTP request ```http PATCH /devices/ ``` -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|accountEnabled|Boolean| | -|alternativeSecurityIds|AlternativeSecurityId| **Notes:** not nullable, the **any** operator is required for filter expressions on multi-valued properties; for more information, see [Supported Queries, Filters, and Paging Options](https://msdn.microsoft.com/library/azure/dn727074.aspx). | -|approximateLastSignInDateTime|DateTimeOffset| | +|accountEnabled|Boolean| **true** if the account is enabled; otherwise, **false**. | +|alternativeSecurityIds|[alternativeSecurityId](../resources/alternativesecurityid.md) collection| The **any** operator is required for filter expressions on multi-valued properties. Not nullable. | +|approximateLastSignInDateTime|DateTimeOffset| The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: `'2014-01-01T00:00:00Z'`| |deviceId|Guid| | |deviceMetadata|String|| |operatingSystem|String|The type of operating system on the device.| |operatingSystemVersion|String|The version of the operating system on the device| |deviceVersion|Int32| | -|physicalIds|String| **Notes:** not nullable | +|physicalIds|String collection| Not nullable. | |trustType|String|| -|onPremisesSyncEnabled|Boolean|**true** if this object is synced from an on-premises directory; **false** if this object was originally synced from an on-premises directory but is no longer synced; **null** if this object has never been synced from an on-premises directory (default).| |displayName|String|The display name for the device.| -|onPremisesLastSyncDateTime|DateTimeOffset|The last time at which the object was synced with the on-premises directory.| +|isCompliant|Boolean|**true** if the device complies with Mobile Device Management (MDM) policies; otherwise, **false**.| +|isManaged|Boolean|**true** if the device is managed by a Mobile Device Management (MDM) app such as Intune; otherwise, **false**.| -### Response +## Response If successful, this method returns a `200 OK` response code and updated [device](../resources/device.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 322 @@ -96,4 +99,4 @@ Content-length: 322 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/directoryobject_checkmembergroups.md b/api-reference/beta/api/directoryobject_checkmembergroups.md deleted file mode 100644 index 53ca664319e66..0000000000000 --- a/api-reference/beta/api/directoryobject_checkmembergroups.md +++ /dev/null @@ -1,76 +0,0 @@ -# directoryObject: checkMemberGroups - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /users//manager/Microsoft.Graph.checkMemberGroups -POST /directoryObjects//Microsoft.Graph.checkMemberGroups -POST /contacts//manager/Microsoft.Graph.checkMemberGroups - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|groupIds|String|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/me/manager/checkMemberGroups -Content-type: application/json -Content-length: 44 - -{ - "groupIds": [ - "groupIds-value" - ] -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryobject_delete.md b/api-reference/beta/api/directoryobject_delete.md index b8cf6fd231afd..64b34099e5aa6 100644 --- a/api-reference/beta/api/directoryobject_delete.md +++ b/api-reference/beta/api/directoryobject_delete.md @@ -1,27 +1,29 @@ # Delete directoryObject Delete directoryObject. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: _Directory.AccessAsUser.All_ + +**NOTE:** Users, groups, and contacts are types of directory object. As a result,if you need to delete users, the following **scope** can and should be used: _User.ReadWrite.All_ +## HTTP request ```http DELETE /directoryObjects/ ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns `204, No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/me/manager +DELETE https://graph.microsoft.com/beta/directoryObject/ ``` ##### Response Here is an example of the response. diff --git a/api-reference/beta/api/directoryobject_get.md b/api-reference/beta/api/directoryobject_get.md index 479d21612d71b..c373313cea8f1 100644 --- a/api-reference/beta/api/directoryobject_get.md +++ b/api-reference/beta/api/directoryobject_get.md @@ -1,28 +1,25 @@ # Get directoryObject Retrieve the properties and relationships of directoryobject object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: _Directory.Read.All_ OR _Directory.AccessAsUser.All_ +## HTTP request ```http -GET /users//manager GET /directoryObjects/ -GET /contacts//manager ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [directoryObject](../resources/directoryobject.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http -GET https://graph.microsoft.com/beta/me/manager +GET https://graph.microsoft.com/beta/directoryObject/ ``` ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 22 diff --git a/api-reference/beta/api/directoryobject_getmembergroups.md b/api-reference/beta/api/directoryobject_getmembergroups.md deleted file mode 100644 index 15de5d477f0ef..0000000000000 --- a/api-reference/beta/api/directoryobject_getmembergroups.md +++ /dev/null @@ -1,74 +0,0 @@ -# directoryObject: getMemberGroups - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /users//manager/Microsoft.Graph.getMemberGroups -POST /directoryObjects//Microsoft.Graph.getMemberGroups -POST /contacts//manager/Microsoft.Graph.getMemberGroups - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/me/manager/getMemberGroups -Content-type: application/json -Content-length: 33 - -{ - "securityEnabledOnly": true -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryobject_getmemberobjects.md b/api-reference/beta/api/directoryobject_getmemberobjects.md deleted file mode 100644 index 189a6d196fd4e..0000000000000 --- a/api-reference/beta/api/directoryobject_getmemberobjects.md +++ /dev/null @@ -1,74 +0,0 @@ -# directoryObject: getMemberObjects - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /users//manager/Microsoft.Graph.getMemberObjects -POST /directoryObjects//Microsoft.Graph.getMemberObjects -POST /contacts//manager/Microsoft.Graph.getMemberObjects - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/me/manager/getMemberObjects -Content-type: application/json -Content-length: 33 - -{ - "securityEnabledOnly": true -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryobject_update.md b/api-reference/beta/api/directoryobject_update.md deleted file mode 100644 index 3f1c1a6ac7a04..0000000000000 --- a/api-reference/beta/api/directoryobject_update.md +++ /dev/null @@ -1,71 +0,0 @@ -# Update directoryobject - -Update the properties of directoryobject object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -PATCH /users//manager -PATCH /directoryObjects/ -PATCH /contacts//manager -``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. - -| Property | Type |Description| -|:---------------|:--------|:----------| - -### Response -If successful, this method returns a `200 OK` response code and updated [directoryObject](../resources/directoryobject.md) object in the response body. -### Example -##### Request -Here is an example of the request. - -```http -PATCH https://graph.microsoft.com/beta/users//manager -Content-type: application/json -Content-length: 111 - -{ - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" -} -``` -##### Response -Here is an example of the response. - -```http -HTTP/1.1 200 OK -Content-type: application/json -Content-length: 111 - -{ - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_delete.md b/api-reference/beta/api/directoryrole_delete.md deleted file mode 100644 index a7281d07dba45..0000000000000 --- a/api-reference/beta/api/directoryrole_delete.md +++ /dev/null @@ -1,52 +0,0 @@ -# Delete directoryRole - -Delete directoryRole. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -DELETE /directoryRoles/ - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -Do not supply a request body for this method. - - -### Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -DELETE https://graph.microsoft.com/beta/directoryRoles/ -``` -##### Response -Here is an example of the response. - -```http -HTTP/1.1 204 No Content -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_get.md b/api-reference/beta/api/directoryrole_get.md index d61ba2dc470cb..f7f77e835af5d 100644 --- a/api-reference/beta/api/directoryrole_get.md +++ b/api-reference/beta/api/directoryrole_get.md @@ -1,26 +1,25 @@ # Get directoryRole -Retrieve the properties and relationships of directoryrole object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve the properties of a directoryrole object. +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request ```http GET /directoryRoles/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [directoryRole](../resources/directoryrole.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 142 @@ -57,4 +57,4 @@ Content-length: 142 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/directoryrole_getmembergroups.md b/api-reference/beta/api/directoryrole_getmembergroups.md deleted file mode 100644 index f0b1352f00825..0000000000000 --- a/api-reference/beta/api/directoryrole_getmembergroups.md +++ /dev/null @@ -1,72 +0,0 @@ -# directoryRole: getMemberGroups - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoles//Microsoft.Graph.getMemberGroups - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoles//getMemberGroups -Content-type: application/json -Content-length: 33 - -{ - "securityEnabledOnly": true -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_getmemberobjects.md b/api-reference/beta/api/directoryrole_getmemberobjects.md deleted file mode 100644 index b1d32f424a707..0000000000000 --- a/api-reference/beta/api/directoryrole_getmemberobjects.md +++ /dev/null @@ -1,72 +0,0 @@ -# directoryRole: getMemberObjects - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoles//Microsoft.Graph.getMemberObjects - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoles//getMemberObjects -Content-type: application/json -Content-length: 33 - -{ - "securityEnabledOnly": true -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_list.md b/api-reference/beta/api/directoryrole_list.md index 7473e4f9a9db7..fb891db6225dd 100644 --- a/api-reference/beta/api/directoryrole_list.md +++ b/api-reference/beta/api/directoryrole_list.md @@ -1,26 +1,25 @@ # List directoryRoles -Retrieve a list of directoryrole objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +List the directory roles that are activated in the tenant. +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request ```http GET /directoryRoles ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [DirectoryRole](../resources/directoryrole.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [directoryRole](../resources/directoryrole.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 187 @@ -62,4 +62,4 @@ Content-length: 187 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/directoryrole_list_memberof.md b/api-reference/beta/api/directoryrole_list_memberof.md deleted file mode 100644 index 11a69f2081733..0000000000000 --- a/api-reference/beta/api/directoryrole_list_memberof.md +++ /dev/null @@ -1,65 +0,0 @@ -# List memberOf - -Retrieve a list of directoryobject objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -GET /directoryRoles//memberOf -``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example -##### Request -Here is an example of the request. - -```http -GET https://graph.microsoft.com/beta/directoryRoles//memberOf -``` -##### Response -Here is an example of the response. - -```http -HTTP/1.1 200 OK -Content-type: application/json -Content-length: 152 - -{ - "value": [ - { - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" - } - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_list_members.md b/api-reference/beta/api/directoryrole_list_members.md index d7c072681c438..ac2e08feabd93 100644 --- a/api-reference/beta/api/directoryrole_list_members.md +++ b/api-reference/beta/api/directoryrole_list_members.md @@ -1,26 +1,26 @@ # List members -Retrieve a list of directoryobject objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of the users that are assigned to the directory role. Only users can be assigned to a directory role. +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* + +## HTTP request ```http GET /directoryRoles//members ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 55 diff --git a/api-reference/beta/api/directoryrole_list_ownedobjects.md b/api-reference/beta/api/directoryrole_list_ownedobjects.md deleted file mode 100644 index 0a4b572fa9da1..0000000000000 --- a/api-reference/beta/api/directoryrole_list_ownedobjects.md +++ /dev/null @@ -1,65 +0,0 @@ -# List ownedObjects - -Retrieve a list of directoryobject objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -GET /directoryRoles//ownedObjects -``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example -##### Request -Here is an example of the request. - -```http -GET https://graph.microsoft.com/beta/directoryRoles//ownedObjects -``` -##### Response -Here is an example of the response. - -```http -HTTP/1.1 200 OK -Content-type: application/json -Content-length: 152 - -{ - "value": [ - { - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" - } - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_list_owners.md b/api-reference/beta/api/directoryrole_list_owners.md deleted file mode 100644 index 5b934c9594b1d..0000000000000 --- a/api-reference/beta/api/directoryrole_list_owners.md +++ /dev/null @@ -1,65 +0,0 @@ -# List owners - -Retrieve a list of directoryobject objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -GET /directoryRoles//owners -``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. -### Example -##### Request -Here is an example of the request. - -```http -GET https://graph.microsoft.com/beta/directoryRoles//owners -``` -##### Response -Here is an example of the response. - -```http -HTTP/1.1 200 OK -Content-type: application/json -Content-length: 152 - -{ - "value": [ - { - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" - } - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_list_scopedadministrators.md b/api-reference/beta/api/directoryrole_list_scopedadministrators.md new file mode 100644 index 0000000000000..0e29d09992ad9 --- /dev/null +++ b/api-reference/beta/api/directoryrole_list_scopedadministrators.md @@ -0,0 +1,70 @@ +# List scopedAdministrators for a directory role + +Retrieve a list of [scopedRoleMembership](../resources/scopedrolemembership.md) objects for a directory role. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All*. +## HTTP request + +```http +GET /directoryRoles//scopedAdministrators +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [scopedRoleMembership](../resources/scopedrolemembership.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/directoryRoles//scopedAdministrators +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 307 + +{ + "value": [ + { + "roleId": "roleId-value", + "administrativeUnitId": "administrativeUnitId-value", + "roleMemberInfo": { + "id": "id-value", + "displayName": "displayName-value", + "userPrincipalName": "userPrincipalName-value" + }, + "id": "id-value" + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_post_directoryroles.md b/api-reference/beta/api/directoryrole_post_directoryroles.md index 78230e2a50b22..b83d2170f3b6d 100644 --- a/api-reference/beta/api/directoryrole_post_directoryroles.md +++ b/api-reference/beta/api/directoryrole_post_directoryroles.md @@ -1,27 +1,34 @@ -# Create DirectoryRole +# Activate directoryRole -Use this API to create a new DirectoryRole. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Activate a directory role. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators and the implicit Users directory roles are activated by default. To access and assign members to another directory role, you must first activate it with its corresponding directory role template ([directoryRoleTemplate](../resources/directoryroletemplate.md)). + +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request ```http -POST /directoryObjects +POST /directoryRoles ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body -In the request body, supply a JSON representation of [DirectoryRole](../resources/directoryrole.md) object. +## Request body +In the request body, supply a JSON representation of [directoryRole](../resources/directoryrole.md) object. + +The following table shows the properties that are required when you activate a directory role. +|Required parameter | Type | Description| +|:---------|:---------|:---------| +|roleTemplateId | string | The ID of the [directoryRoleTemplate](../resources/directoryroletemplate.md) that the role is based on. This is the only property that may be specified in the request.| -### Response -If successful, this method returns `201, Created` response code and [DirectoryRole](../resources/directoryrole.md) object in the response body. -### Example +## Response +If successful, this method returns `201, Created` response code and [directoryRole](../resources/directoryrole.md) object in the response body. + +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 175 { - "directoryRole": { - "description": "description-value", - "displayName": "displayName-value", - "roleTemplateId": "roleTemplateId-value", - "id": "id-value" - } + "description": "description-value", + "displayName": "displayName-value", + "roleTemplateId": "roleTemplateId-value", + "id": "id-value" } ``` @@ -67,8 +71,8 @@ Content-length: 175 2015-10-25 14:57:30 UTC --> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/directoryrole_post_memberof.md b/api-reference/beta/api/directoryrole_post_memberof.md deleted file mode 100644 index ee522b1a23e8b..0000000000000 --- a/api-reference/beta/api/directoryrole_post_memberof.md +++ /dev/null @@ -1,62 +0,0 @@ -# Create memberOf - -Use this API to create a new memberOf. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoles//memberOf - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoles/ -``` -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -##### Response -Here is an example of the response. - -```http -HTTP/1.1 201 Created -Content-type: application/json -Content-length: 111 - -{ - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_post_members.md b/api-reference/beta/api/directoryrole_post_members.md index 43cf08b0cb52a..140deda1eb763 100644 --- a/api-reference/beta/api/directoryrole_post_members.md +++ b/api-reference/beta/api/directoryrole_post_members.md @@ -1,27 +1,27 @@ -# Create member +# Add directory role member -Use this API to create a new member. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Use this API to create a new directory role member. +## Prerequisites +One of the following **scopes** is required to execute this API: *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request ```http POST /directoryRoles//members ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -### Response +## Response If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 51 diff --git a/api-reference/beta/api/directoryrole_post_ownedobjects.md b/api-reference/beta/api/directoryrole_post_ownedobjects.md deleted file mode 100644 index c68ee607620a3..0000000000000 --- a/api-reference/beta/api/directoryrole_post_ownedobjects.md +++ /dev/null @@ -1,62 +0,0 @@ -# Create ownedObject - -Use this API to create a new ownedObject. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoles//ownedObjects - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoles/ -``` -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -##### Response -Here is an example of the response. - -```http -HTTP/1.1 201 Created -Content-type: application/json -Content-length: 111 - -{ - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_post_owners.md b/api-reference/beta/api/directoryrole_post_owners.md deleted file mode 100644 index 2b046cf780c61..0000000000000 --- a/api-reference/beta/api/directoryrole_post_owners.md +++ /dev/null @@ -1,62 +0,0 @@ -# Create owner - -Use this API to create a new owner. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoles//owners - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoles/ -``` -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -##### Response -Here is an example of the response. - -```http -HTTP/1.1 201 Created -Content-type: application/json -Content-length: 111 - -{ - "objectType": "objectType-value", - "objectId": "objectId-value", - "deletionTimestamp": "datetime-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryrole_update.md b/api-reference/beta/api/directoryrole_update.md deleted file mode 100644 index 491c1918aca63..0000000000000 --- a/api-reference/beta/api/directoryrole_update.md +++ /dev/null @@ -1,72 +0,0 @@ -# Update directoryrole - -Update the properties of directoryrole object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -PATCH /directoryRoles/ -``` -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. - -| Property | Type |Description| -|:---------------|:--------|:----------| -|description|String|The description for the directory role.| -|displayName|String|The display name for the directory role. | -|roleTemplateId|String| The **objectId** of the [DirectoryRoleTemplate] that this role is based on. **Notes**: In versions prior to version 1.5, the property is read only. In version 1.5 and later, the property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read only. | - -### Response -If successful, this method returns a `200 OK` response code and updated [directoryRole](../resources/directoryrole.md) object in the response body. -### Example -##### Request -Here is an example of the request. - -```http -PATCH https://graph.microsoft.com/beta/directoryRoles/ -Content-type: application/json -Content-length: 122 - -{ - "description": "description-value", - "displayName": "displayName-value", - "roleTemplateId": "roleTemplateId-value" -} -``` -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 142 - -{ - "description": "description-value", - "displayName": "displayName-value", - "roleTemplateId": "roleTemplateId-value", - "id": "id-value" -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryroletemplate_checkmembergroups.md b/api-reference/beta/api/directoryroletemplate_checkmembergroups.md deleted file mode 100644 index d1ac2bd3d3c9f..0000000000000 --- a/api-reference/beta/api/directoryroletemplate_checkmembergroups.md +++ /dev/null @@ -1,74 +0,0 @@ -# directoryRoleTemplate: checkMemberGroups - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoleTemplates//Microsoft.Graph.checkMemberGroups - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|groupIds|String|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoleTemplates//checkMemberGroups -Content-type: application/json -Content-length: 44 - -{ - "groupIds": [ - "groupIds-value" - ] -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryroletemplate_delete.md b/api-reference/beta/api/directoryroletemplate_delete.md deleted file mode 100644 index c3e6d3d3bcc43..0000000000000 --- a/api-reference/beta/api/directoryroletemplate_delete.md +++ /dev/null @@ -1,52 +0,0 @@ -# Delete directoryRoleTemplate - -Delete directoryRoleTemplate. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -DELETE /directoryRoleTemplates/ - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -Do not supply a request body for this method. - - -### Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -DELETE https://graph.microsoft.com/beta/directoryRoleTemplates/ -``` -##### Response -Here is an example of the response. - -```http -HTTP/1.1 204 No Content -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryroletemplate_get.md b/api-reference/beta/api/directoryroletemplate_get.md index 0684397cc894b..cf94d0c27c923 100644 --- a/api-reference/beta/api/directoryroletemplate_get.md +++ b/api-reference/beta/api/directoryroletemplate_get.md @@ -1,26 +1,25 @@ # Get directoryRoleTemplate -Retrieve the properties and relationships of directoryroletemplate object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve the properties and relationships of a directoryroletemplate object. +## Prerequisites +One of the following **scopes** is required to execute this API: +## HTTP request ```http GET /directoryRoleTemplates/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [directoryRoleTemplate](../resources/directoryroletemplate.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 98 @@ -56,4 +56,4 @@ Content-length: 98 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/directoryroletemplate_getmembergroups.md b/api-reference/beta/api/directoryroletemplate_getmembergroups.md deleted file mode 100644 index 12e6c02ac57da..0000000000000 --- a/api-reference/beta/api/directoryroletemplate_getmembergroups.md +++ /dev/null @@ -1,72 +0,0 @@ -# directoryRoleTemplate: getMemberGroups - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoleTemplates//Microsoft.Graph.getMemberGroups - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoleTemplates//getMemberGroups -Content-type: application/json -Content-length: 33 - -{ - "securityEnabledOnly": true -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryroletemplate_getmemberobjects.md b/api-reference/beta/api/directoryroletemplate_getmemberobjects.md deleted file mode 100644 index 20665b9050287..0000000000000 --- a/api-reference/beta/api/directoryroletemplate_getmemberobjects.md +++ /dev/null @@ -1,72 +0,0 @@ -# directoryRoleTemplate: getMemberObjects - - -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoleTemplates//Microsoft.Graph.getMemberObjects - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, provide a JSON object with the following parameters. - -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|securityEnabledOnly|Boolean|| - -### Response -If successful, this method returns `200, OK` response code and String collection object in the response body. - -### Example -Here is an example of how to call this API. -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/directoryRoleTemplates//getMemberObjects -Content-type: application/json -Content-length: 33 - -{ - "securityEnabledOnly": true -} -``` - -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 39 - -{ - "value": [ - "string-value" - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/directoryroletemplate_list.md b/api-reference/beta/api/directoryroletemplate_list.md index b8a3b03810a7a..1eabc7686dd6e 100644 --- a/api-reference/beta/api/directoryroletemplate_list.md +++ b/api-reference/beta/api/directoryroletemplate_list.md @@ -1,26 +1,25 @@ # List directoryRoleTemplates Retrieve a list of directoryroletemplate objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +## HTTP request ```http GET /directoryRoleTemplates ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [DirectoryRoleTemplate](../resources/directoryroletemplate.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [directoryRoleTemplate](../resources/directoryroletemplate.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 139 @@ -61,4 +61,4 @@ Content-length: 139 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/directorysetting_delete.md b/api-reference/beta/api/directorysetting_delete.md new file mode 100644 index 0000000000000..5c3bd7c25e6b7 --- /dev/null +++ b/api-reference/beta/api/directorysetting_delete.md @@ -0,0 +1,54 @@ +# Delete a directory setting + +Delete a directory setting. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request + +Delete a specific tenant-wide or group setting +```http +DELETE /settings/ +DELETE /groups//settings/ + +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. + + +## Response +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +DELETE https://graph.microsoft.com/beta/settings/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 204 No Content +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/directorysetting_get.md b/api-reference/beta/api/directorysetting_get.md new file mode 100644 index 0000000000000..bb126a09ede56 --- /dev/null +++ b/api-reference/beta/api/directorysetting_get.md @@ -0,0 +1,68 @@ +# Get a directory setting + +Retrieve the properties of a specific directory setting object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request + +Get a specific tenant-wide or group setting +```http +GET /settings/ +GET /groups//settings/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [directorySetting](../resources/directorysetting.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/settings/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 198 + +{ + "id": "id-value", + "displayName": "displayName-value", + "settingTemplateId": "settingTemplateId-value", + "values": [ + { + "name": "name-value", + "value": "value-value" + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/user_list_people.md b/api-reference/beta/api/directorysetting_list.md similarity index 50% rename from api-reference/beta/api/user_list_people.md rename to api-reference/beta/api/directorysetting_list.md index c96aac878c859..e511d0502ac8d 100644 --- a/api-reference/beta/api/user_list_people.md +++ b/api-reference/beta/api/directorysetting_list.md @@ -1,64 +1,60 @@ -# List people +# List directory settings -Retrieve a list of person objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of directory setting objects. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request +List tenant-wide or group settings ```http -GET /users//people -GET /drive/root/createdByUser/people -GET /drive/root/lastModifiedByUser/people +GET /settings +GET group//settings ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [Person](../resources/person.md) objects in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and collection of [directorySetting](../resources/directorysetting.md) objects in the response body. +## Example ##### Request Here is an example of the request. ```http -GET https://graph.microsoft.com/beta/me/people +GET https://graph.microsoft.com/beta/settings ``` ##### Response Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http +HTTP/1.1 200 OK Content-type: application/json -Content-length: 346 +Content-length: 263 { "value": [ { - "sources": [ - { - "type": "type-value" - } - ], + "id": "id-value", "displayName": "displayName-value", - "givenName": "givenName-value", - "surname": "surname-value", - "title": "title-value", - "emailAddresses": [ + "settingTemplateId": "settingTemplateId-value", + "values": [ { - "address": "address-value" + "name": "name-value", + "value": "value-value" } ] } @@ -70,7 +66,7 @@ Content-length: 346 2015-10-25 14:57:30 UTC --> +```http +POST /settings +POST /groups//settings +``` +## Request headers +| Name | Description| +|:---------------|:----------| +| Authorization | Bearer . Required.| + +## Request body +In the request body, supply a JSON representation of [directorySetting](../resources/directorysetting.md) object. However, the display name for the setting will be set based on the referenced settings template name. + + +## Response +If successful, this method returns `201, Created` response code and [directorySetting](../resources/directorysetting.md) object in the response body. + +## Example +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/settings +Content-type: application/json +Content-length: 222 + +{ + "templateId": "templateId-value", + "values": [ + { + "name": "name-value", + "value": "value-value" + } + ] +} +``` +In the request body, supply a JSON representation of [directorySetting](../resources/directorysetting.md) object. +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 201 Created +Content-type: application/json +Content-length: 244 + +{ + "@odata.context": "https://graph.microsoft.com/stagingbeta/$metadata#settings/$entity", + "id": "id-value", + "displayName": "displayName-value", + "templateId": "templateId-value", + "values": [ + { + "name": "name-value", + "value": "value-value" + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/directorysetting_update.md b/api-reference/beta/api/directorysetting_update.md new file mode 100644 index 0000000000000..91ad7abab9335 --- /dev/null +++ b/api-reference/beta/api/directorysetting_update.md @@ -0,0 +1,66 @@ +# Update a directory setting + +Update the properties of a specific directory setting object. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request + +Update a tenant-wide or group specific setting. +```http +PATCH /settings/ +PATCH /groups//settings/ +``` +## Optional request headers +| Name | Description| +|:-----------|:-----------| +| Authorization | Bearer . Required.| + +## Request body +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. + +| Property | Type |Description| +|:---------------|:--------|:----------| +|values|settingValue|The set of values that need to be updated. NOTE: You must supply the entire collection, and cannot just update one setting of the collection.| + +## Response +If successful, this method returns a `204 OK` response code. +## Example +##### Request +Here is an example of the request. + +```http +PATCH https://graph.microsoft.com/beta/settings/ +Content-type: application/json +Content-length: 178 + +{ + "values": [ + { + "name": "name-value", + "value": "value-value" + } + ] +} +``` +##### Response + +```http +HTTP/1.1 204 OK +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/directorysettingtemplate_get.md b/api-reference/beta/api/directorysettingtemplate_get.md new file mode 100644 index 0000000000000..506be871a9931 --- /dev/null +++ b/api-reference/beta/api/directorysettingtemplate_get.md @@ -0,0 +1,68 @@ +# Get a directory setting template + +A directory setting template represents a template of settings from which settings may be created within a tenant. This operation allows retrieval of the properties of the directorySettingTemplate object, including the available settings and their defaults. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request + +```http +GET /directorySettingTemplates/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and [directorySettingTemplate](../resources/directorysettingtemplate.md) object in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/directorySettingTemplates/ +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 270 + +{ + "id": "id-value", + "displayName": "displayName-value", + "description": "description-value", + "values": [ + { + "name": "name-value", + "type": "type-value", + "defaultValue": "defaultValue-value", + "description": "description-value" + } + ], +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/directorysettingtemplate_list.md b/api-reference/beta/api/directorysettingtemplate_list.md new file mode 100644 index 0000000000000..7812d21b737b2 --- /dev/null +++ b/api-reference/beta/api/directorysettingtemplate_list.md @@ -0,0 +1,73 @@ +# List directorySettingTemplates + +Directory setting templates represents a set of templates of directory settings, from which directory settings may be created and used within a tenant. This operation retrieves the list of available directorySettingTemplates objects. +## Prerequisites +The following **scopes** are required to execute this API: *Directory.Read.All* or *Directory.ReadWrite.All* or *Directory.AccessAsUser.All* +## HTTP request + +```http +GET /directorySettingTemplates +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request headers +| Name |Description| +|:----------|:----------| +| Authorization | Bearer . Required.| + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 OK` response code and collection of [directorySettingTemplate](../resources/directorysettingtemplate.md) objects in the response body. +## Example +##### Request +Here is an example of the request. + +```http +GET https://graph.microsoft.com/beta/directorySettingTemplates +``` +##### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 343 + +{ + "value": [ + { + "id": "id-value", + "displayName": "displayName-value", + "description": "description-value", + "values": [ + { + "name": "name-value", + "type": "type-value", + "defaultValue": "defaultValue-value", + "description": "description-value" + } + ] + } + ] +} +``` + + + \ No newline at end of file diff --git a/api-reference/beta/api/drive_get.md b/api-reference/beta/api/drive_get.md index 08ad8aae6458d..b7d93e11c0420 100644 --- a/api-reference/beta/api/drive_get.md +++ b/api-reference/beta/api/drive_get.md @@ -1,78 +1,91 @@ -# Get drive +# Get Drive -Retrieve the properties and relationships of drive object. -### Prerequisites -One of the following **scopes** is required to execute this API: +Retrieve the properties and relationships of a [Drive](../resources/drive.md) resource. +A Drive is the top-level container for a file system. +Graph API allows you to access the Drive resource for a user's OneDrive or OneDrive for Business, or SharePoint document libraries. + +## Prerequisites +One of the following **scopes** is required to execute this API: * Files.Read - + * Files.ReadWrite + * Sites.Read.All + + +## Get a user's OneDrive + +To access a user's OneDrive or OneDrive for Business, your app should request the **drive** relationship on the [User](../resources/user.md) resource. + ### HTTP request + ```http -GET /drive -GET /drives/ -GET /users//drive -GET /groups//drive +GET /me/drive +GET /users/{idOrUserPrincipalName}/drive ``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Get the document library assocaited with a group + +To access a [Group's](../resources/group.md) default document library, your app requests the **drive** relationship on the Group. + +### HTTP request + +```http +GET /groups/{idOrUserPrincipalName}/drive +``` -### Request body + +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. + +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and [drive](../resources/drive.md) object in the response body. -### Example +## Response +If successful, this method returns a `200 OK` response code and [Drive](../resources/drive.md) resource in the response body. + +## Example + ##### Request -Here is an example of the request. + +Here is an example of the request to get the sign-in user's OneDrive or OneDrive for Business. + ```http -GET https://graph.microsoft.com/v1.0/drive +GET https://graph.microsoft.com/beta/me/drive ``` + ##### Response + Here is an example of the response. + ```http HTTP/1.1 200 OK Content-type: application/json -Content-length: 458 { - "id": "id-value", - "driveType": "driveType-value", - "owner": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" + "id": "b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7", + "driveType": "business", + "owner": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Ryan Gregg" + } }, - "user": { - "displayName": "displayName-value", - "id": "id-value" + "quota": { + "deleted": 256938, + "remaining": 1099447353539, + "state": "normal", + "total": 1099511627776 } - }, - "quota": { - "deleted": 99, - "remaining": 99, - "state": "state-value", - "total": 99, - "used": 99 - } } ``` @@ -80,8 +93,8 @@ Content-length: 458 2015-10-25 14:57:30 UTC --> \ No newline at end of file + "tocPath": "OneDrive/Drive/Get Drive" +}--> diff --git a/api-reference/beta/api/drive_list.md b/api-reference/beta/api/drive_list.md index 901d0f329b536..7f150870b43ef 100644 --- a/api-reference/beta/api/drive_list.md +++ b/api-reference/beta/api/drive_list.md @@ -1,38 +1,44 @@ -# List drives +# List available drives -Retrieve a list of drive objects. -### Prerequisites -One of the following **scopes** is required to execute this API: +Retrieve the list of [Drive](../resources/drive.md) resources available for a target [User](../resources/user.md) or [Group](../resources/group.md). +Your app can also request the set of document libraries on the SharePoint root site. +## Prerequisites +One of the following **scopes** is required to execute this API: * Files.Read - -### HTTP request + * Files.ReadWrite + * Sites.Read.All + +## HTTP request ```http GET /drives +GET /me/drives +GET /groups/{id}/drives ``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [drive](../resources/drive.md) objects in the response body. -### Example + +## Response +If successful, this method returns a `200 OK` response code and collection of [Drive](../resources/drive.md) objects in the response body. + +## Example + ##### Request -Here is an example of the request. +Here is an example of the request for the user's drives. + ```http -GET https://graph.microsoft.com/v1.0/drives +GET https://graph.microsoft.com/beta/me/drives ``` + ##### Response Here is an example of the response. \ No newline at end of file + "tocPath": "OneDrive/Drive/List Drives" +}--> diff --git a/api-reference/beta/api/drive_list_items.md b/api-reference/beta/api/drive_list_items.md deleted file mode 100644 index c07146297dc77..0000000000000 --- a/api-reference/beta/api/drive_list_items.md +++ /dev/null @@ -1,85 +0,0 @@ -# List items - -Retrieve a list of driveitem objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -GET /drive/items -GET /me/drive/items -GET /drives//items -``` - -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - - -### Request body -Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [driveItem](../resources/driveitem.md) objects in the response body. -### Example -##### Request -Here is an example of the request. - -```http -GET https://graph.microsoft.com/v1.0/drive/items -``` -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -HTTP/1.1 200 OK -Content-type: application/json -Content-length: 550 - -{ - "value": [ - { - "content": "content-value", - "createdBy": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "createdDateTime": "datetime-value", - "cTag": "cTag-value", - "description": "description-value", - "eTag": "eTag-value" - } - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/drive_list_special.md b/api-reference/beta/api/drive_list_special.md deleted file mode 100644 index 1b681ad60fc3a..0000000000000 --- a/api-reference/beta/api/drive_list_special.md +++ /dev/null @@ -1,84 +0,0 @@ -# List special - -Retrieve a list of driveitem objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -GET /drive/special -GET /me/drive/special -GET /drives//special -``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - - -### Request body -Do not supply a request body for this method. -### Response -If successful, this method returns a `200 OK` response code and collection of [driveItem](../resources/driveitem.md) objects in the response body. -### Example -##### Request -Here is an example of the request. - -```http -GET https://graph.microsoft.com/v1.0/drive/special -``` -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -HTTP/1.1 200 OK -Content-type: application/json -Content-length: 550 - -{ - "value": [ - { - "content": "content-value", - "createdBy": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "createdDateTime": "datetime-value", - "cTag": "cTag-value", - "description": "description-value", - "eTag": "eTag-value" - } - ] -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/drive_post_drives.md b/api-reference/beta/api/drive_post_drives.md deleted file mode 100644 index a18242b8db19f..0000000000000 --- a/api-reference/beta/api/drive_post_drives.md +++ /dev/null @@ -1,108 +0,0 @@ -# Create drive - -Use this API to create a new drive. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request - -```http -POST /directoryRoleTemplates - -``` -### Request headers -| Name | Type | Description| -|:---------------|:--------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [drive](../resources/drive.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [drive](../resources/drive.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/beta/drives -Content-type: application/json -Content-length: 438 - -{ - "driveType": "driveType-value", - "owner": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "quota": { - "deleted": 99, - "remaining": 99, - "state": "state-value", - "total": 99, - "used": 99 - } -} -``` -In the request body, supply a JSON representation of [drive](../resources/drive.md) object. -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. - -```http -Content-type: application/json -Content-length: 458 - -{ - "id": "id-value", - "driveType": "driveType-value", - "owner": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "quota": { - "deleted": 99, - "remaining": 99, - "state": "state-value", - "total": 99, - "used": 99 - } -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/drive_post_items.md b/api-reference/beta/api/drive_post_items.md deleted file mode 100644 index 3db3860cb8f4a..0000000000000 --- a/api-reference/beta/api/drive_post_items.md +++ /dev/null @@ -1,187 +0,0 @@ -# Create item - -Use this API to create a new item in a drive. -### Prerequisites -One of the following **scopes** is required to execute this API: - - * Files.ReadWrite - -### HTTP request - -```http -POST /drive/items -POST /drives//items -POST /users//drive/items - -``` - -### Request headers -| Name | Type | Description| -|:-----------|:------|:----------| -| Authorization | string | Bearer . Required. | - -### Request body -In the request body, supply a JSON representation of [item](../resources/driveitem.md) object. - - -### Response -If successful, this method returns `201, Created` response code and [item](../resources/driveitem.md) object in the response body. - -### Example -##### Request -Here is an example of the request. - -```http -POST https://graph.microsoft.com/v1.0/drive -``` -In the request body, supply a JSON representation of [item](../resources/driveitem.md) object. -##### Response -Here is an example of the response. - -```http -HTTP/1.1 201 Created -Content-type: application/json -Content-length: 3179 - -{ - "content": "content-value", - "createdBy": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "createdDateTime": "datetime-value", - "cTag": "cTag-value", - "description": "description-value", - "eTag": "eTag-value", - "id": "id-value", - "lastModifiedBy": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "lastModifiedDateTime": "datetime-value", - "name": "name-value", - "parentReference": { - "driveId": "driveId-value", - "id": "id-value", - "path": "path-value" - }, - "size": 99, - "webDavUrl": "webDavUrl-value", - "webUrl": "webUrl-value", - "audio": { - "album": "album-value", - "albumArtist": "albumArtist-value", - "artist": "artist-value", - "bitrate": 99, - "composers": "composers-value", - "copyright": "copyright-value", - "disc": 99, - "discCount": 99, - "duration": 99, - "genre": "genre-value", - "hasDrm": true, - "isVariableBitrate": true, - "title": "title-value", - "track": 99, - "trackCount": 99, - "year": 99 - }, - "deleted": { - "state": "state-value" - }, - "file": { - "hashes": { - "crc32Hash": "crc32Hash-value", - "sha1Hash": "sha1Hash-value" - }, - "mimeType": "mimeType-value" - }, - "fileSystemInfo": { - "createdDateTime": "datetime-value", - "lastModifiedDateTime": "datetime-value" - }, - "folder": { - "childCount": 99 - }, - "image": { - "height": 99, - "width": 99 - }, - "location": { - "altitude": 99, - "latitude": 99, - "longitude": 99 - }, - "photo": { - "height": 99, - "width": 99, - "id": "id-value" - }, - "searchResult": { - "onClickTelemetryUrl": "onClickTelemetryUrl-value" - }, - "shared": { - "owner": { - "application": { - "displayName": "displayName-value", - "id": "id-value" - }, - "device": { - "displayName": "displayName-value", - "id": "id-value" - }, - "user": { - "displayName": "displayName-value", - "id": "id-value" - } - }, - "scope": "scope-value" - }, - "specialFolder": { - "name": "name-value" - }, - "video": { - "bitrate": 99, - "duration": 99, - "height": 99, - "width": 99 - } -} -``` - - - \ No newline at end of file diff --git a/api-reference/beta/api/drive_recent.md b/api-reference/beta/api/drive_recent.md new file mode 100644 index 0000000000000..2d776e969ec7a --- /dev/null +++ b/api-reference/beta/api/drive_recent.md @@ -0,0 +1,86 @@ +# List recent files + +List a set of items that have been recently used by the signed in user. +This collection includes items that are in the user's drive as well as items they have access to from other drives. + +## Prerequisites +One of the following **scopes** is required to execute this API: + + * Files.Read + * Sites.Read.All + +## HTTP request + + +``` +GET /me/drive/recent +``` + +## Request body +Do not supply a request body for this method. + +## Example + + +```http +GET https://graph.microsoft.com/beta/me/drive/recent +``` + +## Response + +This returns a collection of [DriveItem](../resources/driveitem.md) resources for items which the owner of the drive has recently accessed. +Items outside of the user's drive will include the [RemoteItem](../resources/remoteitem.md) facet, which provides information to access the shared item. + + + +```http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "id": "1312abc!1231", + "remoteItem": + { + "id": "1991210caf!192", + "name": "March Proposal.docx", + "file": { }, + "size": 19121, + "parentReference": { + "driveId": "1991210caf", + "id": "1991210caf!104" + } + } + }, + { + "id": "1312def!9943", + "name": "Vacation.jpg", + "file": { }, + "size": 37810, + "parentReference": { + "driveId": "1312def", + "id": "1312def!123" + } + } + ] +} +``` + +## Remarks + +Some driveItems returned from the **recent** action will include the **remoteItem** facet which indicates they are items from another drive. +To access the original driveItem object, you will need to make a request using the information provided in **remoteItem** in the following format: + + +```http +GET https://graph.microsoft.com/beta/drives/{remoteItem.driveId}/items/{remoteItem.id} +``` + + diff --git a/api-reference/beta/api/drive_sharedWithMe.md b/api-reference/beta/api/drive_sharedWithMe.md new file mode 100644 index 0000000000000..478c5639a8c1b --- /dev/null +++ b/api-reference/beta/api/drive_sharedWithMe.md @@ -0,0 +1,86 @@ +# List items shared with the signed-in user + +Retrieve a collection of [DriveItem](../resources/driveitem.md) resources that have been shared with the owner of the [Drive](../resources/drive.md). + +## Prerequisites +One of the following **scopes** is required to execute this API: + + * Files.Read + +## HTTP request + + +``` +GET /me/drive/sharedWithMe +``` + +## Request body +Do not supply a request body for this method. + +## Example + + +```http +GET https://graph.microsoft.com/beta/me/drive/sharedWithMe +``` + +## Response + +This returns a collection of [DriveItem](../resources/driveitem.md) resources which contain the DriveItem resources shared with the owner of the drive. +In this example, since the drive is the user's default drive, this returns items shared with the signed in user. + + + +```http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "id": "1312abc", + "remoteItem": { + "id": "1991210caf!192", + "name": "March Proposal.docx", + "file": { }, + "size": 19121, + "parentReference": { + "driveId": "1991210caf", + "id": "1991210caf!104" + } + } + }, + { + "id": "1312def", + "remoteItem": { + "id": "1991210caf!1991", + "name": "Team Roster.xlsx", + "file": { }, + "size": 37619, + "parentReference": { + "driveId": "1991210caf", + "id": "1991210caf!104" + } + } + } + ] +} +``` + +## Remarks + +DriveItems returned from the **sharedWithMe** action will always include the [**remoteItem**](../resources/remoteitem.md) facet which indicates they are items from a different drive. +To access the shared DriveItem resource, you will need to make a request using the information provided in **remoteItem** in the following format: + + +```http +GET https://graph.microsoft.com/beta/drives/{remoteItem.parentReference.driveId}/items/{remoteItem.id} +``` + + diff --git a/api-reference/beta/api/drive_special.md b/api-reference/beta/api/drive_special.md new file mode 100644 index 0000000000000..92d66eff4ba98 --- /dev/null +++ b/api-reference/beta/api/drive_special.md @@ -0,0 +1,130 @@ +# Get a special folder by name + +Use the special collection to access a special folder by name. + +Special folders provide simple aliases to access well-known folders in OneDrive +without the need to look up the folder by path (which would require localization), +or reference the folder with an ID. If a special folder is renamed or moved +to another location within the drive, this syntax will continue to find that +folder. + +Special folders are automatically created the first time an application attempts +to write to one, if it doesn't already exist. If a user deletes one, it is +recreated when written to again. + +**Note:** If you have read-only permissions and request a special folder that +doesn't exist, you'll receive a `403 Forbidden` error. + +## Prerequisites +One of the following **scopes** is required to execute this API: + + * Files.Read + * Files.ReadWrite + +## HTTP request + +```http +GET /me/drive/special/ +``` +## Optional query parameters +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) +to help customize the response. + +## Request headers + +| Name | Type | Description | +|:--------------|:-------|:--------------------------| +| Authorization | string | Bearer . Required. | + + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and a [driveItem](../resources/driveitem.md) +object in the response body. + +## Example + +##### Request +Here is an example of the request for the user's drives. + + +```http +GET https://graph.microsoft.com/beta/me/drive/special/ +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 200 OK +Content-type: application/json + +{ + "folder": { }, + "id": "s!lkjqwlkj124912049an", + "name": "Photos", + "specialFolder": { "name": "photos" }, + "webUrl": "https://contoso-my.sharepoint.com/personal/rgregg_contoso_com/Documents/Photos", +} +``` + +## Example HEAD requests for special folders + +If you request a special folder that doesn't exist by using a GET request, +the special folder will be automatically created for you. You can test to see +if the special folder exists by using a HEAD request. If the folder doesn't +exist, the HEAD request will return a `404` response. + +##### Request (folder does not exist) + + +``` +HEAD /drive/special/{special-folder-name} +``` + +##### Response + +``` +HTTP/1.1 404 Not Found +``` + +##### Request (folder does exist) + +On the other hand, sending the same request when the folder already exists will +return a `200 OK` response. + + +``` +HEAD /drive/special/{special-folder-name} +``` + +##### Response + + +``` +HTTP/1.1 200 OK +``` + +## Remarks + +To request the children of a special folder, you can request the `children` +collection or use the [expand](http://graph.microsoft.io/docs/overview/query_parameters) option +to expand the children collection. + + + diff --git a/api-reference/beta/api/event_accept.md b/api-reference/beta/api/event_accept.md index d42954c5b318f..0bfd838b42d84 100644 --- a/api-reference/beta/api/event_accept.md +++ b/api-reference/beta/api/event_accept.md @@ -1,33 +1,48 @@ # event: accept +Accept the specified event. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request ```http -POST /users//events//Microsoft.Graph.accept -POST /groups//events//Microsoft.Graph.accept -POST /users//calendarView//Microsoft.Graph.accept +POST /me/events//accept +POST /users//events//accept +POST /groups//events//accept +POST /me/calendar/events//accept +POST /users//calendar/events//accept +POST /groups//calendar/events//accept + +POST /me/calendars//events//accept +POST /users//calendars//events//accept + +POST /me/calendargroup/calendars//events//accept +POST /users//calendargroup/calendars//events//accept + +POST /me/calendargroups//calendars//events//accept +POST /users//calendargroups//calendars//events//accept ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | +| Content-Type | string | Nature of the data in the body of an entity. Required. | -### Request body +## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:---------------|:--------|:----------| -|comment|String|| -|sendResponse|Boolean|| +|comment|String|Text included in the response. Optional.| +|sendResponse|Boolean|`true` if a response is to be sent to the organizer; otherwise, `false`. Optional. Default is `true`.| -### Response -If successful, this method returns `200, OK` response code. It does not return anything in the response body. +## Response +If successful, this method returns `202, Accepted` response code. It does not return anything in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. @@ -47,7 +62,7 @@ Content-length: 56 ``` ##### Response -Here is an example of the response. +Here is an example of the response. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/event_cancel.md b/api-reference/beta/api/event_cancel.md new file mode 100644 index 0000000000000..528e7879f8147 --- /dev/null +++ b/api-reference/beta/api/event_cancel.md @@ -0,0 +1,88 @@ +# event: cancel + +This action allows the organizer of a meeting to send a cancellation message and cancel the event. + +The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting +by providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following +error message: + +"Your request can't be completed. You need to be an organizer to cancel a meeting." + +This action differs from [Delete](event_delete.md) in that **Cancel** is available to only the organizer, and lets +the organizer send a custom message to the attendees about the cancellation. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request + +```http +POST /me/events//cancel +POST /users//events//cancel +POST /groups//events//cancel + +POST /me/calendar/events//cancel +POST /users//calendar/events//cancel +POST /groups//calendar/events//cancel + +POST /me/calendars//events//cancel +POST /users//calendars//events//cancel + +POST /me/calendargroup/calendars//events//cancel +POST /users//calendargroup/calendars//events//cancel + +POST /me/calendargroups//calendars//events//cancel +POST /users//calendargroups//calendars//events//cancel +``` +## Request headers +| Name | Type | Description| +|:---------------|:--------|:----------| +| Authorization | string | Bearer . Required. | +| Content-Type | string | Nature of the data in the body of an entity. Required. | + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|comment|String|A comment about the cancellation sent to all the attendees. Optional.| + +## Response +If successful, this method returns `202, Accepted` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/events//cancel +Content-type: application/json + +{ + "Comment": "Cancelling for this week due to all hands" +} +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 202 Accepted +``` + + + diff --git a/api-reference/beta/api/event_decline.md b/api-reference/beta/api/event_decline.md index 76660ed32b86a..4a9f94f5dd364 100644 --- a/api-reference/beta/api/event_decline.md +++ b/api-reference/beta/api/event_decline.md @@ -1,33 +1,48 @@ # event: decline +Decline invitation to the specified event. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request ```http -POST /users//events//Microsoft.Graph.decline -POST /groups//events//Microsoft.Graph.decline -POST /users//calendarView//Microsoft.Graph.decline +POST /me/events//decline +POST /users//events//decline +POST /groups//events//decline +POST /me/calendar/events//decline +POST /users//calendar/events//decline +POST /groups//calendar/events//decline + +POST /me/calendars//events//decline +POST /users//calendars//events//decline + +POST /me/calendargroup/calendars//events//decline +POST /users//calendargroup/calendars//events//decline + +POST /me/calendargroups//calendars//events//decline +POST /users//calendargroups//calendars//events//decline ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | +| Content-Type | string | Nature of the data in the body of an entity. Required. | -### Request body +## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:---------------|:--------|:----------| -|comment|String|| -|sendResponse|Boolean|| +|comment|String|Text included in the response. Optional.| +|sendResponse|Boolean|`true` if a response is to be sent to the organizer; otherwise, `false`. Optional. Default is `true`.| -### Response -If successful, this method returns `200, OK` response code. It does not return anything in the response body. +## Response +If successful, this method returns `202, Accepted` response code. It does not return anything in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. @@ -47,7 +62,8 @@ Content-length: 56 ``` ##### Response -Here is an example of the response. +##### Response +Here is an example of the response. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/event_delete.md b/api-reference/beta/api/event_delete.md index 7c8db8713114c..15ae11e8ee7c7 100644 --- a/api-reference/beta/api/event_delete.md +++ b/api-reference/beta/api/event_delete.md @@ -1,29 +1,42 @@ # Delete event Delete event. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +***Calendars.ReadWrite*** +## HTTP request ```http +DELETE /me/events/ DELETE /users//events/ DELETE /groups//events/ -DELETE /users//calendarView/ +DELETE /me/calendar/events/ +DELETE /users//calendar/events/ +DELETE /groups//calendar/events// + +DELETE /me/calendars//events/ +DELETE /users//calendars//events/ + +DELETE /me/calendargroup/calendars//events/ +DELETE /users//calendargroup/calendars//events/ + +DELETE /me/calendargroups//calendars//events/ +DELETE /users//calendargroups//calendars//events/ ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +## Response +If successful, this method returns `204 No Content` response code. It does not return anything in the response body. -### Example +## Example ##### Request Here is an example of the request. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/event_dismissreminder.md b/api-reference/beta/api/event_dismissreminder.md index c5a508a415c49..186b73a22c266 100644 --- a/api-reference/beta/api/event_dismissreminder.md +++ b/api-reference/beta/api/event_dismissreminder.md @@ -1,27 +1,41 @@ # event: dismissReminder +Dissmiss a reminder that has been triggered. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.ReadWrite* +## HTTP request ```http -POST /users//events//Microsoft.Graph.dismissReminder -POST /groups//events//Microsoft.Graph.dismissReminder -POST /users//calendarView//Microsoft.Graph.dismissReminder +POST /me/events//dismissReminder +POST /users//events//dismissReminder +POST /groups//events//dismissReminder +POST /me/calendar/events//dismissReminder +POST /users//calendar/events//dismissReminder +POST /groups//calendar/events//dismissReminder + +POST /me/calendars//events//dismissReminder +POST /users//calendars//events//dismissReminder + +POST /me/calendargroup/calendars//events//dismissReminder +POST /users//calendargroup/calendars//events//dismissReminder + +POST /me/calendargroups//calendars//events//dismissReminder +POST /users//calendargroups//calendars//events//dismissReminder ``` -### Request headers +## Request headers | Name | Type | Description| |:---------------|:--------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body -### Response +## Response If successful, this method returns `200, OK` response code. It does not return anything in the response body. -### Example +## Example Here is an example of how to call this API. ##### Request Here is an example of the request. @@ -34,7 +48,8 @@ POST https://graph.microsoft.com/beta/me/events//dismissReminder ``` ##### Response -Here is an example of the response. +##### Response +Here is an example of the response. \ No newline at end of file +}--> diff --git a/api-reference/beta/api/event_forward.md b/api-reference/beta/api/event_forward.md new file mode 100644 index 0000000000000..cbe75d300dd97 --- /dev/null +++ b/api-reference/beta/api/event_forward.md @@ -0,0 +1,96 @@ +# event: forward + +This action allows the organizer or attendee of a meeting [event](../resources/event.md) to forward the +meeting request to a new recipient. + +If the meeting event is forwarded from an attendee's Office 365 mailbox to another recipient, this action +also sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's +copy of the meeting event. This convenience is not available when forwarding from an Outlook.com account. + + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request + +```http +POST /me/events//forward +POST /users//events//forward +POST /groups//events//forward + +POST /me/calendar/events//forward +POST /users//calendar/events//forward +POST /groups//calendar/events//forward + +POST /me/calendars//events//forward +POST /users//calendars//events//forward + +POST /me/calendargroup/calendars//events//forward +POST /users//calendargroup/calendars//events//forward + +POST /me/calendargroups//calendars//events//forward +POST /users//calendargroups//calendars//events//forward +``` +## Request headers +| Name | Type | Description| +|:---------------|:--------|:----------| +| Authorization | string | Bearer . Required. | +| Content-Type | string | Nature of the data in the body of an entity. Required. | + +## Request body +In the request body, provide a JSON object with the following parameters. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|Comment|String|A comment to include. Can be an empty string.| +|ToRecipients|[recipient](../resources/recipient.md) collection|The list of recipients to forward the event to.| + +## Response +If successful, this method returns `202, Accepted` response code. It does not return anything in the response body. + +## Example +Here is an example of how to call this API. +##### Request +Here is an example of the request. + +```http +POST https://graph.microsoft.com/beta/me/events//forward +Content-type: application/json +Content-length: 56 + +{ + "ToRecipients":[ + { + "emailAddress": { + "address":"danas@contoso.onmicrosoft.com", + "name":"Dana Swope" + } + } + ], + "Comment": "Dana, hope you can make this meeting." +} + +``` + +##### Response +Here is an example of the response. + +```http +HTTP/1.1 202 Accepted +``` + + + diff --git a/api-reference/beta/api/event_get.md b/api-reference/beta/api/event_get.md index 01edaa771ee5f..a5a4d3360a61b 100644 --- a/api-reference/beta/api/event_get.md +++ b/api-reference/beta/api/event_get.md @@ -1,28 +1,57 @@ # Get event -Retrieve the properties and relationships of event object. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get the properties and relationships of the specified [event](../resources/event.md) object. + +For all GET operations that return events, you can use the `Prefer: outlook.timezone` header to specify the time zone for the event start and end times in the response. + +For example, the following `Prefer: outlook.timezone` header sets the start and end times in the response to Eastern Standard Time. +```http +Prefer: outlook.timezone="Eastern Standard Time" +``` + +If the event was created in a different time zone, the start and end times will be adjusted to the time zone specified in that `Prefer` header. +See this [list](../resources/datetimetimezone.md) for the supported time zone names. If the `Prefer: outlook.timezone` header is not specified, the start and end +times are returned in UTC. + +You can use the **OriginalStartTimeZone** and **OriginalEndTimeZone** properties on the **event** resource to +find out the time zone used when the event was created. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request ```http +GET /me/events/ GET /users//events/ GET /groups//events/ -GET /users//calendarView/ + +GET /me/calendar/events/ +GET /users//calendar/events/ +GET /groups//calendar/events/ + +GET /me/calendars//events/ +GET /users//calendars//events/ + +GET /me/calendargroup/calendars//events/ +GET /users//calendargroup/calendars//events/ + +GET /me/calendargroups//calendars//events/ +GET /users//calendargroups//calendars//events/ ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. - -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | +| Prefer: | outlook.timezone | The default time zone for events in the response. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and [event](../resources/event.md) object in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 285 @@ -47,13 +77,29 @@ Content-length: 285 "originalStartTimeZone": "originalStartTimeZone-value", "originalEndTimeZone": "originalEndTimeZone-value", "responseStatus": { - "response": { - }, + "response": "", "time": "datetime-value" }, "iCalUId": "iCalUId-value", "reminderMinutesBeforeStart": 99, - "isReminderOn": true + "isReminderOn": true, + "start": { + "dateTime": "datetime-value", + "timeZone": "timezone-value" + }, + "end": { + "dateTime": "datetime-value", + "timeZone": "timezone-value" + }, + "location": { + "displayName": "displayName-value" + }, + "organizer": { + "emailAddress": { + "address": "address-value", + "name": "name-value" + } + } } ``` @@ -65,4 +111,4 @@ Content-length: 285 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/api-reference/beta/api/event_list_attachments.md b/api-reference/beta/api/event_list_attachments.md index 285651c063d51..256ec42367797 100644 --- a/api-reference/beta/api/event_list_attachments.md +++ b/api-reference/beta/api/event_list_attachments.md @@ -1,28 +1,56 @@ # List attachments -Retrieve a list of attachment objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Retrieve a list of [attachment](../resources/attachment.md) objects attached to an event. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request +Attachments for an [event](../resources/event.md) in the user's or group's default [calendar](../resources/calendar.md). ```http +GET /me/events//attachments GET /users//events//attachments GET /groups//events//attachments -GET /users//calendarView//attachments + +GET /me/calendar/events//attachments +GET /users//calendar/events//attachments +GET /groups//calendar/events//attachments +``` +Attachments for an [event](../resources/event.md) in a [calendar](../resources/calendar.md) belonging to the user's default [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendars//events//attachments +GET /users//calendars//events//attachments + +GET /me/calendargroup/calendars//events//attachments +GET /users//calendargroup/calendars//events//attachments +``` +Attachments for an [event](../resources/event.md) in a [calendar](../resources/calendar.md) belonging to a user's [calendarGroup](../resources/calendargroup.md). +```http +GET /me/calendargroups//calendars//events//attachments +GET /users//calendargroups//calendars//events//attachments ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +In particular, you can use the $expand query parameter to include all of the event attachments +inline with the rest of the event properties. For example: + +``` +GET https://graph.microsoft.com/beta/me/events/?$expand=attachments +``` + + +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Attachment](../resources/attachment.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 215 { "value": [ { + "@odata.type": "#Microsoft.OutlookServices.FileAttachment", + "contentType": "contentType-value", + "contentLocation": "contentLocation-value", + "contentBytes": "contentBytes-value", + "contentId": "null", "lastModifiedDateTime": "datetime-value", + "id": "id-value", + "isInline": false, + "isContactPhoto": false, "name": "name-value", - "contentType": "contentType-value", - "size": 99, - "isInline": true, - "id": "id-value" + "size": 99 } ] } diff --git a/api-reference/beta/api/event_list_extensions.md b/api-reference/beta/api/event_list_extensions.md index 1e44feb813d64..c60ae858c68b7 100644 --- a/api-reference/beta/api/event_list_extensions.md +++ b/api-reference/beta/api/event_list_extensions.md @@ -1,28 +1,28 @@ # List extensions Retrieve a list of extension objects. -### Prerequisites +## Prerequisites The following **scopes** are required to execute this API: -### HTTP request +## HTTP request ```http GET /users//events//extensions GET /groups//events//extensions GET /users//calendarView//extensions ``` -### Optional query parameters +## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. -### Request headers +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | -### Request body +## Request body Do not supply a request body for this method. -### Response +## Response If successful, this method returns a `200 OK` response code and collection of [Extension](../resources/extension.md) objects in the response body. -### Example +## Example ##### Request Here is an example of the request. ```http +HTTP/1.1 200 OK Content-type: application/json Content-length: 55 diff --git a/api-reference/beta/api/event_list_instances.md b/api-reference/beta/api/event_list_instances.md index ede3ca405f321..84ad025f00979 100644 --- a/api-reference/beta/api/event_list_instances.md +++ b/api-reference/beta/api/event_list_instances.md @@ -1,28 +1,52 @@ # List instances -Retrieve a list of event objects. -### Prerequisites -The following **scopes** are required to execute this API: -### HTTP request +Get the instances (occurrences) of an event for a specified time range. If the event is a `SeriesMaster` type, this returns the +occurrences and exceptions of the event in the specified time range. + +## Prerequisites +One of the following **scopes** is required to execute this API: +*Calendars.Read* +## HTTP request ```http -GET /users//events//instances -GET /groups//events//instances -GET /users//calendarView//instances +GET /me/events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /groups//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} + +GET /me/calendar/events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendar/events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /groups//calendar/events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} + +GET /me/calendars//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendars//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} + +GET /me/calendargroup/calendars//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendargroup/calendars//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} + +GET /me/calendargroups//calendars//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} +GET /users//calendargroups//calendars//events//instances?startDateTime={start_datetime}&endDateTime={end_datetime} ``` -### Optional query parameters -This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Query parameters + +In the request URL, provide the following required query parameters with values. + +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|startDateTime|String|The start date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T19:00:00.0000000".| +|endDateTime|String|The end date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T20:00:00.0000000".| -### Request headers +This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. +## Request headers | Name | Type | Description| |:-----------|:------|:----------| | Authorization | string | Bearer . Required. | +| Prefer | string |