Тип ресурса driveItem
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет файл, папку или другой элемент, хранящийся на диске.
Все объекты файловой системы в OneDrive и SharePoint возвращаются в виде ресурсов driveItem. Элементы в библиотеках документов SharePoint могут быть представлены как ресурсы listItem или driveItem.
Обратиться к ресурсу driveItem можно двумя основными способами:
- по уникальному идентификатору driveItem с помощью
drive/items/{item-id}; - по пути файловой системы с помощью
/drive/root:/path/to/file.
Дополнительные сведения см. в разделе об адресации driveItems.
Ресурсы DriveItem имеют аспекты, смоделированные как свойства, которые предоставляют данные об удостоверениях и возможностях driveItem. Например:
- Папки имеют аспект папки
- Файлы имеют аспект файла.
- У изображений, кроме аспекта file, есть аспект image.
- У изображений, полученных с помощью камеры (фотографий), есть аспект photo, который определяет элемент как фотографию со свойствами времени и устройства съемки.
элементы с аспектом folder выполняют роль контейнеров элементов, поэтому у них есть ссылка children, указывающая на коллекцию объектов driveItem в папке.
Заметка: В библиотеках документов OneDrive для бизнеса или SharePoint свойство cTag не возвращается, если driveItem имеет аспект папки .
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Получение элемента | driveItem | Получите метаданные для элемента driveItem на диске. |
| Получение аналитики | itemAnalytics | Получение аналитических данных для ресурса. |
| Получение действий по интервалу | itemActivityStat | Получение коллекции объектов itemActivityStats в пределах указанного интервала времени. |
| Список дочерних элементов | Коллекция driveItem | Возвращает коллекцию элементов driveItem в связи дочерних элементов элемента driveItem. |
| Список версий | Коллекция driveItemVersion | Получите версии файла на диске текущего пользователя. |
| Создание папки | driveItem | Создайте driveItem на указанном диске. |
| Обновление элемента | driveItem | Обновите driveItem на диске. |
| Отправка | driveItem | Отправьте содержимое в driveItem. |
| Скачивание содержимого файла | Поток | Скачивание содержимого основного потока (файла) элемента driveItem. |
| Скачивание файла в определенном формате | URL-адрес скачивания | Скачайте содержимое объекта driveItem в определенном формате. |
| Удаление элемента | Нет | Удаление driveItem. |
| Удаление элемента без возможности восстановления | Нет | Окончательное удаление объекта driveItem с помощью его идентификатора. |
| Перемещение элемента | driveItem | Перемещение элемента driveItem в новый родительский элемент. |
| Копирование элемента | сведения о том, как следить за процессом копирования | Создайте копию элемента driveItem (включая все дочерние элементы). |
| Поиск элементов | Коллекция driveItem | Поиск элементов, соответствующих запросу, в иерархии элементов. |
| Отслеживание изменений | разностная ссылка | Перечисление всех изменений на диске. |
| Подписаться на элемент | driveItem | Следуйте за driveItem. |
| Отмена подписки на элемент | Нет | Отмена подписки driveItem. |
| Получение эскизов | Коллекция driveItem | Вывод списка элементов driveItem с их эскизами. |
| Создание ссылки совместного доступа | Ссылка совместного доступа | Создайте ссылку для предоставления общего доступа к объекту driveItem. |
| Добавление разрешений | Коллекция объектов permission | Отправить пользователю приглашение на общий доступ. |
| Список разрешений | Коллекция объектов permission | Получите коллекцию разрешений для объекта driveItem. |
| Разрешение на создание | permission | Создайте разрешение на driveItem. |
| Удаление разрешения | Нет | Удалите разрешение из driveItem. |
| Отмена разрешений на ссылку для общего доступа | permission | Отмените доступ к listItem или driveItem, предоставленным через ссылку для общего доступа, удалив указанного получателя из ссылки. |
| Получение канала WebSocket | subscription | Получайте уведомления об изменениях для диска практически в реальном времени с помощью socket.io. |
| Предварительный просмотр элемента | объект JSON | Получение внедряемых URL-адресов с небольшим сроком действия для элемента, чтобы создать временный предварительный просмотр. |
| Восстановление файлов | Нет | Запустите извлеченный ресурс driveItem , который делает версию документа доступной для других пользователей. |
| Извлечь файлы | Нет | Извлеките ресурс driveItem , чтобы другие пользователи не могли редактировать документ, а изменения не будут отображаться до тех пор, пока документ не будет возвращен. |
| Отмена оформления заказа | Нет | Отмена ранее извлеченногоэлемента driveItem. |
| Извлечение меток конфиденциальности | extractSensitivityLabelsResult | Извлеките одну или несколько меток конфиденциальности, назначенных элементу диска, и обновите метаданные элемента диска последними сведениями о назначенной метки. |
| Назначение метки конфиденциальности | String | Асинхронно назначьте метку конфиденциальности объекту driveItem. |
| Получение метки хранения | itemRetentionLabel | Получение сведений о метаданных для метки хранения, примененной к объекту driveItem. |
| Установка метки хранения | itemRetentionLabel | Применение (установка) метки хранения к объекту driveItem (файлам и папкам ). |
| Удаление метки хранения | Нет | Удалите метку хранения из элемента driveItem. |
| Блокировка или разблокировка записи | itemRetentionLabel | Блокировка или разблокировка метки хранения на объекте driveItem , который классифицирует содержимое как записи. |
| Скачивание файла (не рекомендуется) | URL-адрес скачивания | Скачайте содержимое объекта driveItem. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| audio | audio | Метаданные звукового файла, если элемент — звуковой файл. Только для чтения. Только в личном хранилище OneDrive. |
| bundle | bundle | Метаданные пакета, если элемент является пакетом. Только для чтения. |
| содержимое (не рекомендуется) | Поток | Поток содержимого, если элемент представляет файл. В будущем свойство содержимого будет иметь потенциально критическое изменение в поведении. Он будет выполнять потоковую передачу содержимого напрямую, а не перенаправление. Чтобы заранее принять новое поведение, используйте свойство contentStream . |
| contentStream | Поток | Поток содержимого, если элемент представляет файл. |
| createdBy | identitySet | Удостоверение пользователя, устройства и приложения, создавшего элемент. Только для чтения. |
| createdDateTime | DateTimeOffset | Дата и время создания элемента. Только для чтения. |
| cTag | String | ETag для содержимого элемента. Этот eTag не изменяется, если изменены только метаданные. Заметка Это свойство не возвращается, если элемент является папкой. Только для чтения. |
| deleted | deleted | Сведения о состоянии удаления элемента. Только для чтения. |
| description | String | Предоставляет видимое пользователю описание элемента. Чтение и запись. Только в личном хранилище OneDrive. |
| eTag | String | Тег сущности для всего элемента (метаданные и содержимое). Только для чтения. |
| file | file | Файл метаданных, если в роли элемента выступает файл. Только для чтения. |
| fileSystemInfo | fileSystemInfo | Сведения о файловой системе на клиенте. Чтение и запись. |
| folder | folder | Метаданные папки, если в роли элемента выступает папка. Только для чтения. |
| id | String | Уникальный идентификатор элемента на диске. Только для чтения. |
| изображение | image | Метаданные изображения, если в роли элемента выступает изображение. Только для чтения. |
| lastModifiedBy | identitySet | Удостоверение пользователя, устройства и приложения, которые в последний раз изменяли элемент. Только для чтения. |
| lastModifiedDateTime | DateTimeOffset | Дата и время последнего изменения элемента. Только для чтения. |
| location | geoCoordinates | Метаданные местоположения, если в роли элемента выступают данные о местоположении. Только для чтения. |
| malware | malware | Метаданные вредоносной программы, если обнаружено, что элемент содержит вредоносную программу. Только для чтения. |
| мультимедиа | media | Сведения о элементе мультимедиа (аудио или видео). Чтение и запись. Только в OneDrive для бизнеса и SharePoint. |
| name | String | Имя элемента (имя и расширение файла). Чтение и запись. |
| package | package | В случае наличия указывает, что этот элемент — пакет, а не папка или файл. Пакеты обрабатываются как файлы в одном контексте, и как папки — в другом. Только для чтения. |
| parentReference | itemReference | Сведения о родительском элементе, если элемент выступает в роли родительского элемента. Чтение и запись. |
| pendingOperations | pendingOperations | Если он имеется, указывает, что одна или несколько операций, которые могут повлиять на состояние driveItem, находятся в ожидании завершения. Только для чтения. |
| photo; | photo | Метаданные фотографии, если в роли элемента выступает фотография. Только для чтения. |
| publication | publicationFacet | Предоставляет сведения о состоянии элемента (опубликован или получен для изменения) в расположениях, поддерживающих такие действия. По умолчанию это свойство не возвращается. Только для чтения. |
| remoteItem | remoteItem | Данные удаленного элемента, если элемент используется совместно на диске, но не на том, к которому получен доступ в данный момент. Только для чтения. |
| root | root | Ненулевое значение этого свойства указывает, что ресурс driveItem является самым верхним на диске. |
| searchResult | searchResult | Поиск метаданных, если элемент получен из результата поиска. Только для чтения. |
| общие | shared | Указывает, что элемент был предоставлен другим пользователям, и предоставляет сведения об общем состоянии элемента. Только для чтения. |
| sharepointIds | sharepointIds | Возвращает идентификаторы, использующиеся для обеспечения совместимости с SharePoint REST. Только для чтения. |
| size | Int64 | Размер элемента (в байтах). Только для чтения. |
| specialFolder | specialFolder | Если текущий элемент также доступен как специальная папка, возвращается этот аспект. Только для чтения. |
| source | driveItemSource | Сведения об источнике элемента диска. Только для чтения. Только в OneDrive для бизнеса и SharePoint. |
| video | video | Метаданные видео, если в роли элемента выступает видео. Только для чтения. |
| точка зрения | driveItemViewpoint | Возвращает сведения, характерные для вызывающего пользователя для этого элемента диска. Только для чтения. |
| webDavUrl | Строка | URL-адрес элемента, совместимый с WebDAV. |
| webUrl | String | URL-адрес для отображения ресурса в браузере. Только для чтения. |
Заметка: Свойства eTag и cTag работают по-разному в контейнерах (папках). Значение cTag изменяется при изменении содержимого или метаданных любого потомка папки. Значение eTag изменяется только при изменении свойств папки, за исключением свойств, производных от потомков (например , childCount или lastModifiedDateTime).
Связи
| Связь | Тип | Описание |
|---|---|---|
| activities | Коллекция itemActivity | Список последних действий, выполненных с элементом. |
| analytics | Ресурс itemAnalytics | Аналитические данные о действиях просмотра, выполненных для элемента. |
| children | Коллекция driveItem | Коллекция, содержащая объекты Item для непосредственных дочерних элементов Item. Дочерние элементы есть только у элементов, представляющих папки. Только для чтения. Допускается значение null. |
| createdByUser | user | Удостоверение пользователя, создавшего элемент. Только для чтения. |
| lastModifiedByUser | user | Удостоверение пользователя, который последним изменил элемент. Только для чтения. |
| listItem | listItem | Для дисков в SharePoint, связанный элемент библиотеки документов. Только для чтения. Может иметь значение null. |
| permissions | Коллекция объектов permission | Набор разрешений для элемента. Только для чтения. Допускается значение null. |
| RetentionLabel | itemRetentionLabel | Сведения о метках хранения и параметрах, применяемых в driveItem. Чтение и запись. |
| subscriptions | Коллекция subscription | Набор подписок на элемент. Поддерживается только в корне диска. |
| thumbnails | Коллекция объектов thumbnailSet | Коллекция объектов thumbnailSet, связанных с элементом. Дополнительные сведения см. в статье Получение эскизов. Только для чтения. Допускается значение null. |
| versions | Коллекция driveItemVersion | Список предыдущих версий элемента. Дополнительные сведения см. в статье, посвященной получению предыдущих версий. Только для чтения. Допускается значение null. |
| workbook | workbook | Для файлов, которые являются электронными таблицами Excel, доступ к API книги для работы с содержимым электронной таблицы. Допускается значение null. |
Атрибуты экземпляра
Атрибуты экземпляра — это свойства с особым поведением. Эти свойства являются временными и определяют поведение, которое должна выполнять служба, или предоставляют краткосрочные значения свойств, например URL-адрес для скачивания элемента, срок действия которого истекает.
| Имя свойства | Тип | Описание |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | Определяет поведение для разрешения конфликтов, возникающих при создании элементов. Вы можете использовать значения fail, replace или rename. Значение по умолчанию для метода PUT: replace. Элемент никогда не возвращается с этой заметкой. Только для записи. |
| @microsoft.graph.downloadUrl | string | URL-адрес, который можно использовать для скачивания содержимого этого файла. Проверка подлинности с этим URL-адресом не требуется. Только для чтения. |
| @microsoft.graph.sourceUrl | string | Эту заметку экземпляра можно использовать для указания службе скачать содержимое URL-адреса при отправке запроса PUT и сохранить его в виде файла. Только для записи. |
Примечания. Параметр
@microsoft.graph.conflictBehaviorдолжен быть включен в URL-адрес, а не в текст запроса.Значение
@microsoft.graph.downloadUrl— это краткосрочный URL-адрес, который не сохраняется в кэше. ПОСЛЕ этого URL-адрес становится недействительным в течение короткого периода времени (1 час). Удаление разрешений на доступ к файлу для пользователя может не сразу сделать URL-адрес недействительным.Использование свойства
@microsoft.graph.sourceUrlдля отправки файла не поддерживается в OneDrive для бизнеса, SharePoint Online и SharePoint Server 2016.
Представление JSON
В следующем представлении JSON показан тип ресурса.
Ресурс driveItem является производным от ресурса baseItem и наследует его свойства.
{
"audio": { "@odata.type": "microsoft.graph.audio" },
"bundle": { "@odata.type": "microsoft.graph.bundle" },
"content": { "@odata.type": "Edm.Stream" },
"contentStream": { "@odata.type": "Edm.Stream" },
"cTag": "string (etag)",
"deleted": { "@odata.type": "microsoft.graph.deleted"},
"description": "string",
"file": { "@odata.type": "microsoft.graph.file" },
"fileSystemInfo": { "@odata.type": "microsoft.graph.fileSystemInfo" },
"folder": { "@odata.type": "microsoft.graph.folder" },
"image": { "@odata.type": "microsoft.graph.image" },
"location": { "@odata.type": "microsoft.graph.geoCoordinates" },
"malware": { "@odata.type": "microsoft.graph.malware" },
"media": { "@odata.type": "microsoft.graph.media" },
"package": { "@odata.type": "microsoft.graph.package" },
"pendingOperations": { "@odata.type": "microsoft.graph.pendingOperations" },
"photo": { "@odata.type": "microsoft.graph.photo" },
"publication": {"@odata.type": "microsoft.graph.publicationFacet"},
"remoteItem": { "@odata.type": "microsoft.graph.remoteItem" },
"root": { "@odata.type": "microsoft.graph.root" },
"searchResult": { "@odata.type": "microsoft.graph.searchResult" },
"shared": { "@odata.type": "microsoft.graph.shared" },
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"size": 1024,
"source": { "@odata.type": "microsoft.graph.driveItemSource" },
"specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
"video": { "@odata.type": "microsoft.graph.video" },
"viewpoint": { "@odata.type": "microsoft.graph.driveItemViewpoint" },
"webDavUrl": "string",
/* relationships */
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
"children": [{ "@odata.type": "microsoft.graph.driveItem" }],
"createdByUser": { "@odata.type": "microsoft.graph.user" },
"retentionLabel": { "@odata.type": "microsoft.graph.itemRetentionLabel" },
"lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
"permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
"subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],
"thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
"versions": [ {"@odata.type": "microsoft.graph.driveItemVersion"}],
/* inherited from baseItem */
"id": "string (identifier)",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"eTag": "string",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"name": "string",
"parentReference": {"@odata.type": "microsoft.graph.itemReference"},
"webUrl": "string",
/* instance annotations */
"@microsoft.graph.conflictBehavior": "string",
"@microsoft.graph.downloadUrl": "url",
"@microsoft.graph.sourceUrl": "url"
}