Поделиться папкой

Print Friendly, PDF & EmailРаспечатать/сохранить в PDF

PUT api/2.0/files/folder/{folderId}/share

Для этой функции требуется аутентификация

Описание
Устанавливает параметры общего доступа к папке с идентификатором, указанным в запросе.

Параметры

НазваниеОписаниеТипПример
folderId

sent in url
Идентификатор папкистроковыйтекст
share

sent in body
Набор параметров совместного использованияCollection of FileShareParamss

collection
share[0].ShareTo=9924256A-739C-462b-AF15-E652A3B1B6EB&share[0].Access=0
notify

sent in body
Уведомляет пользователей об общем файлелогическийtrue
sharingMessage

sent in body
Сообщение для отправки при уведомлении об общем файлестроковыйтекст

Примечание

Каждый из параметров «поделиться» должен содержать два значения: «ShareTo» — идентификатор пользователя, с которым мы хотим поделиться папкой, и «Access» — тип доступа, который мы хотим предоставить пользователю (Read, ReadWrite и т. д.)
Пример
PUT api/2.0/files/folder/some+text/share
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "share": [
    {
      "shareTo": "00000000-0000-0000-0000-000000000000",
      "access": 0
    }
  ],
  "notify": true,
  "sharingMessage": "some text"
}

Возвращает
Информация об общей папке

Пример ответа

application/json

{
  "status": 0,
  "response": [
    {
      "access": 1,
      "sharedTo": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "isLocked": false,
      "isOwner": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <access>1</access>
    <sharedTo>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </sharedTo>
    <isLocked>false</isLocked>
    <isOwner>true</isOwner>
  </response>
</result>