Тип ресурса DriveItem
Ресурс driveItem представляет файл, папку или другой элемент, хранящийся на диске. Все объекты файловой системы в OneDrive и SharePoint возвращаются в виде ресурсов driveItem.
Обратиться к ресурсу driveItem можно двумя основными способами:
- по уникальному идентификатору driveItem с помощью
drive/items/{item-id}; - по пути файловой системы с помощью
/drive/root:/path/to/file.
Ресурсы DriveItem имеют аспекты, смоделированные как свойства, которые предоставляют данные об удостоверениях и возможностях driveItem. Например:
- Папки имеют аспект папки
- Файлы имеют аспект файла.
- У изображений, кроме аспекта file, есть аспект image.
- У изображений, полученных с помощью камеры (фотографий), есть аспект photo, который определяет элемент как фотографию со свойствами времени и устройства съемки.
элементы с аспектом folder выполняют роль контейнеров элементов, поэтому у них есть ссылка children, указывающая на коллекцию объектов driveItem в папке.
Представление в формате JSON
Ниже представлено описание ресурса driveItem в формате JSON.
Ресурс driveItem является производным от ресурса baseItem и наследует его свойства.
{
"audio": { "@odata.type": "microsoft.graph.audio" },
"content": { "@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" },
"package": { "@odata.type": "microsoft.graph.package" },
"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,
"specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
"video": { "@odata.type": "microsoft.graph.video" },
"webDavUrl": "string",
/* relationships */
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
"children": [{ "@odata.type": "microsoft.graph.driveItem" }],
"permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
"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"
}
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| audio | audio | Метаданные звукового файла, если элемент — звуковой файл. Только для чтения. |
| содержимое | Поток | Поток содержимого, если элемент представляет файл. |
| createdBy | identitySet | Идентификатор пользователя, устройства или приложения, создавшего элемент. Только для чтения. |
| createdDateTime | DateTimeOffset | Дата и время создания элемента. Только для чтения. |
| cTag | String | ETag для содержимого элемента. Этот eTag не изменяется, если изменены только метаданные. Примечание Это свойство не возвращается, если элемент является папкой. Только для чтения. |
| deleted | deleted | Сведения о состоянии удаления элемента. Только для чтения. |
| description | String | Предоставляет видимое пользователю описание элемента. Чтение и запись. Только в OneDrive Personal |
| eTag | String | Тег сущности для всего элемента (метаданные и содержимое). Только для чтения. |
| file | file | Файл метаданных, если в роли элемента выступает файл. Только для чтения. |
| fileSystemInfo | fileSystemInfo | Сведения о файловой системе на клиенте. Чтение и запись. |
| folder | folder | Метаданные папки, если в роли элемента выступает папка. Только для чтения. |
| id | String | Уникальный идентификатор элемента на диске. Только для чтения. |
| изображение | image | Метаданные изображения, если в роли элемента выступает изображение. Только для чтения. |
| lastModifiedBy | identitySet | Идентификатор пользователя, устройства или приложения, внесшего последние изменения в элемент. Только для чтения. |
| lastModifiedDateTime | DateTimeOffset | Дата и время последнего изменения элемента. Только для чтения. |
| location | geoCoordinates | Метаданные местоположения, если в роли элемента выступают данные о местоположении. Только для чтения. |
| malware | malware | Метаданные вредоносной программы, если обнаружено, что элемент содержит вредоносную программу. Только для чтения. |
| name | String | Имя элемента (имя и расширение файла). Чтение и запись. |
| package | package | В случае наличия указывает, что этот элемент — пакет, а не папка или файл. Пакеты обрабатываются как файлы в одном контексте, и как папки — в другом. Только для чтения. |
| parentReference | itemReference | Сведения о родительском элементе, если элемент выступает в роли родительского элемента. Чтение и запись. |
| Фотография | photo | Метаданные фотографии, если в роли элемента выступает фотография. Только для чтения. |
| publication | publicationFacet | Предоставляет сведения о состоянии элемента (опубликован или получен для изменения) в расположениях, поддерживающих такие действия. Это свойство не возвращается по умолчанию. Только для чтения. |
| remoteItem | remoteItem | Данные удаленного элемента, если элемент используется совместно на диске, но не на том, к которому получен доступ в данный момент. Только для чтения. |
| root | root | Ненулевое значение этого свойства указывает, что ресурс driveItem является самым верхним на диске. |
| searchResult | searchResult | Поиск метаданных, если элемент получен из результата поиска. Только для чтения. |
| общие | shared | Указывает, что к элементу был предоставлен общий доступ для других пользователей, и предоставляет сведения о состоянии совместного использования элемента. Только для чтения. |
| sharepointIds | sharepointIds | Возвращает идентификаторы, использующиеся для обеспечения совместимости с SharePoint REST. Только для чтения. |
| size | Int64 | Размер элемента (в байтах). Только для чтения. |
| specialFolder | specialFolder | Если текущий элемент также доступен как специальная папка, возвращается этот аспект. Только для чтения. |
| video | video | Метаданные видео, если в роли элемента выступает видео. Только для чтения. |
| webDavUrl | Строка | URL-адрес элемента, совместимый с WebDAV. |
| webUrl | String | URL-адрес для отображения ресурса в браузере. Только для чтения. |
Примечание: Свойства eTag и cTag работают по-разному в контейнерах (папках). Значение cTag изменяется при изменении содержимого или метаданных любого потомка папки. Значение eTag изменяется только при изменении свойств папки, за исключением свойств, производных от потомков (например , childCount или lastModifiedDateTime).
Связи
| Связь | Тип | Описание |
|---|---|---|
| activities | Коллекция itemActivity | Список последних действий, выполненных с элементом. |
| children | Коллекция driveItem | Коллекция, содержащая объекты Item для непосредственных дочерних элементов Item. Дочерние элементы есть только у элементов, представляющих папки. Только для чтения. Допускается значение null. |
| listItem | listItem | Для дисков в SharePoint, связанный элемент библиотеки документов. Только для чтения. Может иметь значение null. |
| permissions | Коллекция объектов permission | Набор разрешений для элемента. Только для чтения. Допускается значение null. |
| thumbnails | Коллекция объектов thumbnailSet | Коллекция, содержащая объекты ThumbnailSet, связанные с элементом. Дополнительные сведения см. в разделе Получение эскизов. Только для чтения. Допускается значение null. |
| versions | Коллекция driveItemVersion | Список предыдущих версий элемента. Дополнительные сведения см. в статье, посвященной получению предыдущих версий. Только для чтения. Допускается значение null. |
Атрибуты экземпляра
Атрибуты экземпляра — это свойства с особым поведением. Эти свойства — временные и а) определяют поведение выполнения службы; или б) предоставляют краткосрочные значения свойств, например URL-адрес скачивания элемента, у которого истекает срок действия.
| Имя свойства | Тип | Описание |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | Определяет поведение для разрешения конфликтов, возникающих при создании элементов. Вы можете использовать значения fail, replace или rename. Значение по умолчанию для метода PUT: replace. Элементы никогда не возвращаются с такой заметкой. Только для записи. |
| @microsoft.graph.downloadUrl | string | URL-адрес, который можно использовать для скачивания содержимого этого файла. Проверка подлинности не является обязательным условием, если используется такой URL-адрес. Только для чтения. |
| @microsoft.graph.sourceUrl | string | При создании запроса PUT такую заметку экземпляра можно использовать, чтобы указать службе скачать содержимое по URL-адресу и сохранить его как файл. Только для записи. |
Примечание: Значение @microsoft.graph.downloadUrl является краткосрочным URL-адресом и не может быть кэшировано. URL-адрес будет доступен в течение короткого времени (1 час), после чего станет недействительным.
Методы
| Метод | Путь REST |
|---|---|
| Получение элемента | GET /drive/items/{item-id} |
| Список действий | GET /drive/items/{item-id}/activities |
| Список дочерних элементов | GET /drive/items/{item-id}/children |
| Список версий | GET /drive/items/{item-id}/versions |
| Создание элемента | POST /drive/items/{item-id}/children |
| Обновление элемента | PATCH /drive/items/{item-id} |
| Отправка содержимого | PUT /drive/items/{item-id}/content |
| Скачивание содержимого | GET /drive/items/{item-id}/content |
| Скачивание файла в определенном формате | GET /drive/items/{item-id}/content?format={format} |
| Удаление элемента | DELETE /drive/items/{item-id} |
| Перемещение элемента | PATCH /drive/items/{item-id} |
| Копирование элемента | POST /drive/items/{item-id}/copy |
| Поиск элементов | GET /drive/items/{item-id}/search(q='text') |
| Перечисление изменений на диске | GET /drive/root/delta |
| Перечисление эскизов | GET /drive/items/{item-id}/thumbnails |
| Создание ссылки совместного доступа | POST /drive/items/{item-id}/createLink |
| Добавление разрешений | POST /drive/items/{item-id}/invite |
| Список разрешений | GET /drive/items/{item-id}/permissions |
| Удаление разрешения | DELETE /drive/items/{item-id}/permissions/{perm-id} |
| Предварительный просмотр элемента | POST /drive/items/{item-id}/preview |
Заметки
В OneDrive для бизнеса и библиотеках документов SharePoint свойство cTag не возвращается, если у ресурса driveItem есть аспект folder.