Тип ресурса driveItemdriveItem resource type

Ресурс driveItem представляет файл, папку или другой элемент, хранящийся на диске. Все объекты файловой системы в OneDrive и SharePoint возвращаются в виде ресурсов driveItem.The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in OneDrive and SharePoint are returned as driveItem resources.

Обратиться к ресурсу driveItem можно двумя основными способами:There are two primary ways of addressing a driveItem resource:

  • по уникальному идентификатору driveItem с помощью drive/items/{item-id};By the driveItem unique identifier using drive/items/{item-id}
  • по пути файловой системы с помощью /drive/root:/path/to/file.By file system path using /drive/root:/path/to/file

У ресурсов driveItem есть аспекты, смоделированные как свойства, которые предоставляют данные об идентификаторах и возможностях ресурса driveItem.driveItem resources have facets modeled as properties that provide data about the driveItem's identities and capabilities. Пример:For example:

  • У папок есть аспект folder.Folders have a folder facet
  • У файлов есть аспект file.Files have a file facet.
  • У изображений помимо аспекта file есть аспект image.Images have an image facet in addition to their file facet.
  • У изображений, полученных с помощью камеры (фотографий), есть аспект photo, который определяет элемент как фотографию со свойствами времени съемки и устройства.Images taken with a camera (photos) have a photo facet that identifies the item as a photo and provides the properties of when the photo was taken and with what device.

элементы с аспектом folder выполняют роль контейнеров элементов, поэтому у них есть ссылка children, указывающая на коллекцию объектов driveItem в папке.Items with the folder facet act as containers of items and therefore have a children reference pointing to a collection of driveItems under the folder.

Примечание. В OneDrive для бизнеса и библиотеках документов SharePoint свойство cTag не возвращается, если у ресурса driveItem есть аспект folder.Note: In OneDrive for Business or SharePoint document libraries, the cTag property is not returned, if the driveItem has a folder facet.

СвойстваProperties

СвойствоProperty ТипType ОписаниеDescription
audioaudio audioaudio Метаданные звукового файла, если элемент — звуковой файл. Только для чтения.Audio metadata, if the item is an audio file. Read-only.
содержимоеcontent ПотокStream Поток содержимого, если элемент представляет файл.The content stream, if the item represents a file.
createdBycreatedBy identitySetidentitySet Идентификатор пользователя, устройства или приложения, создавшего элемент. Только для чтения.Identity of the user, device, and application which created the item. Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset Дата и время создания элемента. Только для чтения.Date and time of item creation. Read-only.
cTagcTag StringString ETag для содержимого элемента. Такой тег сущности не изменяется, если изменяются только метаданные. Примечание. Это свойство не возвращается, если в роли элемента выступает папка. Только для чтения.An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.
deleteddeleted deleteddeleted Сведения о состоянии удаления элемента. Только для чтения.Information about the deleted state of the item. Read-only.
descriptiondescription StringString Предоставляет видимое пользователю описание элемента. Чтение и запись. Только в личном хранилище OneDriveProvides a user-visible description of the item. Read-write. Only on OneDrive Personal
eTageTag StringString Тег сущности для всего элемента (метаданные и содержимое). Только для чтения.eTag for the entire item (metadata + content). Read-only.
filefile filefile Файл метаданных, если в роли элемента выступает файл. Только для чтения.File metadata, if the item is a file. Read-only.
fileSystemInfofileSystemInfo fileSystemInfofileSystemInfo Сведения о файловой системе на клиенте. Чтение и запись.File system information on client. Read-write.
folderfolder folderfolder Метаданные папки, если в роли элемента выступает папка. Только для чтения.Folder metadata, if the item is a folder. Read-only.
idid StringString Уникальный идентификатор элемента на диске. Только для чтения.The unique identifier of the item within the Drive. Read-only.
изображениеimage imageimage Метаданные изображения, если в роли элемента выступает изображение. Только для чтения.Image metadata, if the item is an image. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet Идентификатор пользователя, устройства или приложения, внесшего последние изменения в элемент. Только для чтения.Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset Дата и время последнего изменения элемента. Только для чтения.Date and time the item was last modified. Read-only.
locationlocation geoCoordinatesgeoCoordinates Метаданные местоположения, если в роли элемента выступают данные о местоположении. Только для чтения.Location metadata, if the item has location data. Read-only.
namename StringString Имя элемента (имя и расширение файла). Чтение и запись.The name of the item (filename and extension). Read-write.
packagepackage packagepackage В случае наличия указывает, что этот элемент — пакет, а не папка или файл. Пакеты обрабатываются как файлы в одном контексте, и как папки — в другом. Только для чтения.If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only.
parentReferenceparentReference itemReferenceitemReference Сведения о родительском элементе, если элемент выступает в роли родительского элемента. Чтение и запись.Parent information, if the item has a parent. Read-write.
Фотография
photo photophoto Метаданные фотографии, если в роли элемента выступает фотография. Только для чтения.Photo metadata, if the item is a photo. Read-only.
publicationpublication publicationFacetpublicationFacet Предоставляет сведения о состоянии элемента (опубликован или получен для изменения) в расположениях, поддерживающих такие действия.Provides information about the published or checked-out state of an item, in locations that support such actions. Это свойство не возвращается по умолчанию.This property is not returned by default. Только для чтения.Read-only.
remoteItemremoteItem remoteItemremoteItem Данные удаленного элемента, если элемент используется совместно на диске, но не на том, к которому получен доступ в данный момент. Только для чтения.Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.
rootroot rootroot Ненулевое значение этого свойства указывает, что ресурс driveItem является самым верхним на диске.If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.
searchResultsearchResult searchResultsearchResult Поиск метаданных, если элемент получен из результата поиска. Только для чтения.Search metadata, if the item is from a search result. Read-only.
общиеshared sharedshared Указывает, что к элементу был предоставлен общий доступ для других пользователей, и предоставляет сведения о состоянии совместного использования элемента. Только для чтения.Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.
sharepointIdssharepointIds sharepointIdssharepointIds Возвращает идентификаторы, использующиеся для обеспечения совместимости с SharePoint REST. Только для чтения.Returns identifiers useful for SharePoint REST compatibility. Read-only.
sizesize Int64Int64 Размер элемента (в байтах). Только для чтения.Size of the item in bytes. Read-only.
specialFolderspecialFolder specialFolderspecialFolder Если текущий элемент также доступен как специальная папка, возвращается этот аспект. Только для чтения.If the current item is also available as a special folder, this facet is returned. Read-only.
videovideo videovideo Метаданные видео, если в роли элемента выступает видео. Только для чтения.Video metadata, if the item is a video. Read-only.
webDavUrlwebDavUrl СтрокаString URL-адрес элемента, совместимый с WebDAV.WebDAV compatible URL for the item.
webUrlwebUrl StringString URL-адрес для отображения ресурса в браузере. Только для чтения.URL that displays the resource in the browser. Read-only.

Примечание. Свойства тегов eTag и cTag по-разному действуют на контейнеры (папки). Значение cTag изменяется при изменении содержимого или метаданных любого потомка папки. Значение eTag изменяется только при изменении свойств папки, за исключением свойств, которые являются производными от потомков (например, свойство childCount или lastModifiedDateTime).Note: The eTag and cTag properties work differently on containers (folders). The cTag value is modified when content or metadata of any descendant of the folder is changed. The eTag value is only modified when the folder's properties are changed, except for properties that are derived from descendants (like childCount or lastModifiedDateTime).

ОтношенияRelationships

ОтношениеRelationship ТипType ОписаниеDescription
activitiesactivities Коллекция itemActivityitemActivity collection Список последних действий, выполненных с элементом.The list of recent activities that took place on this item.
analyticsanalytics Ресурс itemAnalyticsitemAnalytics resource Аналитические данные о действиях просмотра, выполненных для элемента.Analytics about the view activities that took place on this item.
childrenchildren Коллекция driveItemdriveItem collection Коллекция, содержащая объекты Item для непосредственных дочерних элементов Item. Дочерние элементы есть только у элементов, представляющих папки. Только для чтения. Допускается значение null.Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
createdByUsercreatedByUser useruser Удостоверение пользователя, создавшего элемент.Identity of the user who created the item. Только для чтения.Read-only.
lastModifiedByUserlastModifiedByUser useruser Удостоверение пользователя, который последним изменил элемент.Identity of the user who last modified the item. Только для чтения.Read-only.
listItemlistItem listItemlistItem Для дисков в SharePoint, связанный элемент библиотеки документов.For drives in SharePoint, the associated document library list item. Только для чтения.Read-only. Может иметь значение null.Nullable.
permissionspermissions Коллекция объектов permissionpermission collection Набор разрешений для элемента. Только для чтения. Допускается значение null.The set of permissions for the item. Read-only. Nullable.
subscriptionssubscriptions Коллекция subscriptionsubscription collection Набор подписок на элемент.The set of subscriptions on the item. Поддерживается только в корне диска.Only supported on the root of a drive.
thumbnailsthumbnails Коллекция объектов thumbnailSetthumbnailSet collection Коллекция, содержащая объекты ThumbnailSet, связанные с элементом. Дополнительные сведения см. в статье о [получении эскизов][]. Только для чтения. Допускается значение null.Collection containing ThumbnailSet objects associated with the item. For more info, see getting thumbnails. Read-only. Nullable.
versionsversions Коллекция driveItemVersiondriveItemVersion collection Список предыдущих версий элемента.The list of previous versions of the item. Дополнительные сведения см. в статье, посвященной [получению предыдущих версий][].For more info, see getting previous versions. Только для чтения.Read-only. Допускается значение null.Nullable.
workbookworkbook workbookworkbook Для файлов, представляющих собой электронные таблицы Excel, получает доступ к API книги для работы с содержимым электронной таблицы.For files that are Excel spreadsheets, accesses the workbook API to work with the spreadsheet's contents. Допускается значение null.Nullable.

Атрибуты экземпляраInstance Attributes

Атрибуты экземпляра — это свойства с особым поведением. Эти свойства — временные и а) определяют поведение выполнения службы; или б) предоставляют краткосрочные значения свойств, например URL-адрес скачивания элемента, у которого истекает срок действия.Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.

Имя свойстваProperty name ТипType ОписаниеDescription
@microsoft.graph.conflictBehavior@microsoft.graph.conflictBehavior stringstring Определяет поведение для разрешения конфликтов, возникающих при создании элементов. Вы можете использовать значения fail, replace или rename. Значение по умолчанию для метода PUT: replace. Элементы никогда не возвращаются с такой заметкой. Только для записи.The conflict resolution behavior for actions that create a new item. You can use the values fail, replace, or rename. The default for PUT is replace. An item will never be returned with this annotation. Write-only.
@microsoft.graph.downloadUrl@microsoft.graph.downloadUrl stringstring URL-адрес, который можно использовать для скачивания содержимого этого файла. Проверка подлинности не является обязательным условием, если используется такой URL-адрес. Только для чтения.A URL that can be used to download this file's content. Authentication is not required with this URL. Read-only.
@microsoft.graph.sourceUrl@microsoft.graph.sourceUrl stringstring При создании запроса PUT такую заметку экземпляра можно использовать, чтобы указать службе скачать содержимое по URL-адресу и сохранить его как файл. Только для записи.When issuing a PUT request, this instance annotation can be used to instruct the service to download the contents of the URL, and store it as the file. Write-only.

Примечание. Значение @microsoft.graph.downloadUrl — это краткосрочный URL-адрес, который не сохраняется в кэше.Note: The @microsoft.graph.downloadUrl value is a short-lived URL and can't be cached. URL-адрес будет доступен в течение короткого времени (1 час), после чего станет недействительным.The URL will only be available for a short period of time (1 hour) before it is invalidated. Удаление разрешений на доступ к файлу для пользователя может не сразу сделать URL-адрес недействительным.Removing file permissions for a user may not immediately invalidate the URL.

Представление JSONJSON representation

Ниже представлено описание ресурса driveItem в формате JSON.Here is a JSON representation of a driveItem resource.

Ресурс driveItem является производным от ресурса baseItem и наследует его свойства.The driveItem resource is derived from baseItem and inherits properties from that resource.

{
  "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" },
  "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"}],
  "analytics": {"@odata.type": "microsoft.graph.itemAnalytics"},
  "children": [{ "@odata.type": "microsoft.graph.driveItem" }],
  "createdByUser": { "@odata.type": "microsoft.graph.user" },
  "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"
}

МетодыMethods

МетодMethod Возвращаемый типReturn Type ОписаниеDescription
Получение элементаGet item driveItemdriveItem Получение метаданных для DriveItem в объекте Drive.Retrieve the metadata for a DriveItem in a Drive.
Получение аналитикиGet analytics itemAnalyticsitemAnalytics Получение аналитических данных для ресурса.Get analytics for this resource.
Получение действий по интервалуGet activities by interval itemActivityStatitemActivityStat Получение коллекции объектов itemActivityStat в пределах указанного интервала времени.Get a collection of itemActivityStats within the specified time interval.
Список дочерних элементовList children коллекция ресурсов driveItemcollection of driveItem Возвращает коллекцию DriveItems в дочерних элементах ресурса DriveItem.Return a collection of DriveItems in the children relationship of a DriveItem.
Список версийList versions коллекция объектов DriveItemVersioncollection of DriveItemVersion Извлекает версии файла для объекта Drive текущего пользователя.Retrieves the versions of a file in the current user's drive.
Создание элементаCreate item driveItemdriveItem Создает ресурс driveItem на указанном диске.Creates a driveItem in the specified drive.
Обновление элементаUpdate item driveItemdriveItem Обновляет ресурс driveItem на диске.Updates a driveItem in the drive.
Отправка содержимогоUpload content driveItemdriveItem Отправляет содержимое в ресурс driveItem.Uploads content to the driveItem.
Скачивание содержимогоDownload content URL-адрес скачиванияdownload Url Скачивает содержимое ресурса driveItem.Downloads content of a driveItem.
Скачивание файла в определенном форматеDownload specific file format URL-адрес скачиванияdownload Url Скачивает содержимое ресурса driveItem с определенным форматом.Downloads content of a driveItem with a specific format.
Удаление элементаDelete item Содержимое отсутствуетNo Content Удаляет ресурс driveItem.Deletes a driveItem.
Перемещение элементаMove item driveItemdriveItem Перемещение ресурса DriveItem в новый родительский элемент.Move a DriveItem to a new parent item.
Копирование элементаCopy item сведения о том, как следить за процессом копированияdetails about how to monitor the progress of the copy Создает копию ресурса driveItem (включая все дочерние элементы).Creates a copy of an driveItem (including any children).
Поиск элементовSearch items коллекция ресурсов driveItemcollection of driveItem Поиск элементов, соответствующих запросу, в иерархии элементов.Search the hierarchy of items for items matching a query.
Перечисление изменений на дискеList changes in a drive разностная ссылкаdelta link Перечисление всех изменений на диске.List any changes in the drive.
Перечисление эскизовList thumbnails коллекция ресурсов driveItemcolletion of driveItem Перечисление ресурсов driveItem с их эскизами.List driveItems with their thumbnails.
Создание ссылки совместного доступаCreate sharing link Ссылка совместного доступаsharing link Создание ссылки совместного доступа к ресурсу driveItem.Create a link to share the driveItem.
Добавление разрешенийAdd permissions коллекция объектов [разрешений][]collection of permission Отправляет приглашение к совместному доступу пользователю.Sends a sharing ivite to a user.
Список разрешенийList permissions коллекция объектов [разрешений][]collection of permission Извлекает коллекцию разрешений для ресурса driveItem.Retrieves the collection of permissions on an driveItem.
Удаление разрешенияDelete permission Содержимое отсутствуетNo Content Удаляет разрешение из ресурса driveItem.Removes the permission from the driveItem.
Получение канала WebSocketGet WebSocket channel subscriptionsubscription Получает уведомления об изменениях почти в режиме реального времени для диска с использованием socket.io.Receives near-real-time change notifications for a drive using socket.io.
Предварительный просмотр элементаPreview item объект JSONjson object Получение внедряемых URL-адресов с небольшим сроком действия для элемента, чтобы создать временный предварительный просмотр.Obtain short-lived embeddable URLs for an item in order to render a temporary preview.