Запись опубликована:11.10.2022
Post category:Совместное использование
Запись изменена:03.11.2022

PUT api/2.0/files/file/{fileId}/share

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

Описание

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

Параметры

Название	Описание	Тип	Пример
fileId 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/file/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>