Module

microsoft.onedrive

Module microsoft.onedrive

Client

Audio
ByteRange
CheckInOptions
ConnectionConfig
Deleted
DriveItem
DriveItemData
DriveItemVersion
DriveRecipient
EmbeddableData
File
FileSystemInfo
Folder
FolderMetadata
FolderView
GeoCordinates
Hash
Identity
IdentitySet
Image
IncompleteData
ItemActionStat
ItemActivity
ItemActivityStat
ItemAnalytics
ItemReference
ItemShareInvitation
Package
ParentReference
Permission
PermissionOptions
Photo
PreviewOptions
Publication
SearchResult
Shared
ShareInvitation
SharePointId
SharingLinkSpecialFolder
ThumbnailSet
Tumbnail
UploadMetadata
Video

CheckInOption
ConflictResolutionBehaviour
FileFormat
LinkScope
LinkType
PermissionRole
PublicationLevel
SortBy
SortOrder
ViewType

DEFAULT_FRAGMENT_SIZE
MAXIMUM_FRAGMENT_SIZE

Error
InputValidationError
PayloadValidationError
QueryParameterValidationError
RequestFailedError

ballerinax/microsoft.onedrive

2.3.0

Overview

Ballerina connector for Microsoft OneDrive connects to the OneDrive file storage API in Microsoft Graph v1.0 via the Ballerina language. The connector allows you to programmatically perform basic drive functionalities such as file upload, download. It also allows you to share files and folders stored on Microsoft OneDrive.

This module supports Microsoft Graph API v1.0 and allows performing functions only on behalf of the currently signed-in user.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the OneDrive connector in your Ballerina application, update the .bal file as follows:

Step 1 - Import connector

Import the ballerinax/microsoft.onedrive module into the Ballerina project.

Copy

Step 2 - Create a new connector instance

To make the connection, use the OAuth2 refresh token grant configuration.

Copy

Step 3 - Invoke connector operation

  1. Create a folder
    To create a folder, use the following code block:
Copy
  1. Use bal run command to compile and run the Ballerina program.

You can find a list of samples here

Clients

microsoft.onedrive: Client

Isolated

This is connecting to the Microsoft Graph RESTful web API that enables you to access Microsoft Cloud service resources.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Microsoft 365 Work and School account and obtain tokens following this guide. Configure the Access token to have the required permission.

init (ConnectionConfig config)
  • config ConnectionConfig - Configurations required to initialize the Client endpoint

getRecentItems

Isolated FunctionRemote Function
function getRecentItems() returns DriveItemData[]|Error

Lists a set of items that have been recently used by the signed in user.
This will include items that are in the user's drive as well as the items they have access to from other drives.

Return Type
  • DriveItemData[]|Error - An array of onedrive:DriveItemData if sucess. Else onedrive:Error.

getItemsSharedWithMe

Isolated FunctionRemote Function
function getItemsSharedWithMe(string? queryParams) returns DriveItemData[]|error

Retrieves a collection of DriveItemData resources that have been shared with the signed in user of the OneDrive.

Parameters
  • queryParams string? (default ()) - Optional query parameters
    • This method support OData query parameters to customize the response. It should be an array of type string in the format <QUERY_PARAMETER_NAME>=<PARAMETER_VALUE>
    • For more information about query parameters, visit.
Return Type
  • DriveItemData[]|error - An array of onedrive:DriveItemData if sucess. Else onedrive:Error.

createFolderById

Isolated FunctionRemote Function
function createFolderById(string parentFolderId, FolderMetadata folderMetadata) returns DriveItemData|Error

Creates a new folder in a Drive with a specified parent item, referred with the parent folder's ID.

Parameters
  • parentFolderId string - The folder ID of the parent folder where, the new folder will be created
  • folderMetadata FolderMetadata - A record onedrive:FolderMetadata which contains the necessary data to create a folder
Return Type

createFolderByPath

Isolated FunctionRemote Function
function createFolderByPath(string parentFolderPath, FolderMetadata folderMetadata) returns DriveItemData|Error

Creates a new folder in a Drive with a specified parent item referred with the folder path.

Parameters
  • parentFolderPath string - The folder path of the parent folder relative to the root of the respective Drive where, the new folder will be created
    • NOTE: When you want to create a folder on root itself, you must give the relative path of the new folder only.
  • folderMetadata FolderMetadata - A record of type FolderMetadata which contains the necessary data to create a folder
Return Type

getItemMetadataById

Isolated FunctionRemote Function
function getItemMetadataById(string itemId, string? queryParams) returns DriveItemData|Error

Retrieves the metadata for a DriveItem in a Drive by item ID.

Parameters
  • itemId string - The ID of the DriveItem
  • queryParams string? (default ()) - Optional query parameters
    • This method support OData query parameters to customize the response. It should be an array of type string in the format <QUERY_PARAMETER_NAME>=<PARAMETER_VALUE>
    • For more information about query parameters, visit.
Return Type

getItemMetadataByPath

Isolated FunctionRemote Function
function getItemMetadataByPath(string itemPath, string? queryParams) returns DriveItemData|Error

Retrieves the metadata for a DriveItem in a Drive by file system path.

Parameters
  • itemPath string - The file system path of the DriveItem. The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • queryParams string? (default ()) - Optional query parameters
    • This method support OData query parameters to customize the response. It should be an array of type string in the format <QUERY_PARAMETER_NAME>=<PARAMETER_VALUE>
    • For more information about query parameters, visit.
Return Type

updateDriveItemById

Isolated FunctionRemote Function
function updateDriveItemById(string itemId, DriveItem replacementData) returns DriveItemData|Error

Updates the metadata for a DriveItem in a Drive referring by item ID.

Parameters
  • itemId string - The ID of the DriveItem
  • replacementData DriveItem - A record onedrive:DriveItem which contains the values for properties that should be updated
Return Type

updateDriveItemByPath

Isolated FunctionRemote Function
function updateDriveItemByPath(string itemPath, DriveItem replacementData) returns DriveItemData|Error

Updates the metadata for a DriveItem in a Drive by file system path.

Parameters
  • itemPath string - The file system path of the DriveItem
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • replacementData DriveItem - A record of type DriveItem which contains the values for properties that should be updated
Return Type

deleteDriveItemById

Isolated FunctionRemote Function
function deleteDriveItemById(string itemId) returns Error?

Deletes a DriveItem in a Drive by using it's ID.

Parameters
  • itemId string - The ID of the DriveItem
Return Type
  • Error? - onedrive:Error if the operation fails or () if nothing is to be returned

deleteDriveItemByPath

Isolated FunctionRemote Function
function deleteDriveItemByPath(string itemPath) returns Error?

Deletes a DriveItem in a Drive by using it's file system path.

Parameters
  • itemPath string - The file system path of the DriveItem
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
Return Type
  • Error? - onedrive:Error if the operation fails or () if nothing is to be returned

restoreDriveItem

Isolated FunctionRemote Function
function restoreDriveItem(string itemId, string? parentFolderId, string? name) returns DriveItemData|Error

Restores a driveItem that has been deleted and is currently in the recycle bin.
NOTE: This functionality is currently only available for OneDrive Personal.

Parameters
  • itemId string - The ID of the DriveItem
  • parentFolderId string? (default ()) - The ID of the parent item the deleted item will be restored to
  • name string? (default ()) - The new name for the restored item
    • If this isn't provided, the same name will be used as the original.
Return Type

copyDriveItemWithId

Isolated FunctionRemote Function
function copyDriveItemWithId(string itemId, string? name, ParentReference? parentReference) returns string|Error

Asynchronously creates a copy of a DriveItem (including any children), under a new parent item or at the same location with a new name.

Parameters
  • itemId string - The ID of the DriveItem
  • name string? (default ()) - The new name for the copy
    • If this isn't provided, the same name will be used as the original.
  • parentReference ParentReference? (default ()) - A record onedrive:ParentReference that represents reference to the parent item the copy will be created in
Return Type
  • string|Error - A string which represents the ID of the newly created copy if sucess. Else onedrive:Error.

copyDriveItemInPath

Isolated FunctionRemote Function
function copyDriveItemInPath(string itemPath, string? name, ParentReference? parentReference) returns string|Error

Asynchronously creates a copy of a DriveItem (including any children), under a new parent item or at the same location with a new name.

Parameters
  • itemPath string - The file system path of the DriveItem
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • name string? (default ()) - The new name for the copy
    • If this isn't provided, the same name will be used as the original.
  • parentReference ParentReference? (default ()) - A record onedrive:ParentReference that represents reference to the parent item the copy will be created in.
Return Type
  • string|Error - A string which represents the ID of the newly created copy if sucess. Else onedrive:Error.

downloadFileById

Isolated FunctionRemote Function
function downloadFileById(string itemId, FileFormat? formatToConvert) returns File|Error

Downloads the contents of the primary stream (file) of a DriveItem using item ID.
NOTE: Only driveItems with the file property can be downloaded.

Parameters
  • itemId string - The ID of the DriveItem
  • formatToConvert FileFormat? (default ()) - Specify the format the item's content should be downloaded as.
Return Type
  • File|Error - A record onedrive:File if sucess. Else onedrive:Error.

downloadFileByPath

Isolated FunctionRemote Function
function downloadFileByPath(string itemPath, FileFormat? formatToConvert) returns File|Error

Downloads the contents of the primary stream (file) of a DriveItem using item path.
NOTE: Only driveItems with the file property can be downloaded.

Parameters
  • itemPath string - The file system path of the File
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
    • example: Use the itempath as /Documents/MyFile.xlsx if MyFile.xlsx is located inside a folder called Docuements.
  • formatToConvert FileFormat? (default ()) - Specify the format the item's content should be downloaded as.
Return Type
  • File|Error - A record onedrive:File if successful. Else onedrive:Error.

downloadFileByDownloadUrl

Isolated FunctionRemote Function
function downloadFileByDownloadUrl(string downloadUrl, ByteRange? partialContentOption) returns File|Error

Downloads the contents of the primary stream (file) of a DriveItem using download URL.
NOTE: Only driveItems with the file property can be downloaded.

Parameters
  • downloadUrl string - Download URL for a specific DriveItem
  • partialContentOption ByteRange? (default ()) - The value for the Range header to download a partial range of bytes from the file
Return Type
  • File|Error - A record onedrive:File if successful. Else onedrive:Error.

uploadFileToFolderByIdAsStream

Isolated FunctionRemote Function
function uploadFileToFolderByIdAsStream(string parentFolderId, string fileName, stream<byte[], Error?> binaryStream, string mimeType) returns DriveItemData|Error

Upload a new file to the Drive. This method only supports files up to 4MB in size.

Parameters
  • parentFolderId string - The folder ID of the parent folder where, the new file will be uploaded
  • fileName string - The name of the new file
  • binaryStream stream<byte[], Error?> - An stream of byte[] that represents a binary stream of the file to be uploaded
  • mimeType string - The media type of the uploading file
Return Type

uploadFileToFolderByPathAsStream

Isolated FunctionRemote Function
function uploadFileToFolderByPathAsStream(string parentFolderPath, string fileName, stream<byte[], Error?> binaryStream, string mimeType) returns DriveItemData|Error

Upload a new file to the Drive. This method only supports files up to 4MB in size.

Parameters
  • parentFolderPath string - The folder path of the parent folder relative to the root of the respective Drive where, the new folder will be created. NOTE: When you want to create a folder on root itself, you must give the relative path of the new folder only.
  • fileName string - The name of the new file
  • binaryStream stream<byte[], Error?> - An stream of byte[] that represents a binary stream of the file to be uploaded
  • mimeType string - The media type of the uploading file
Return Type

replaceFileUsingIdAsStream

Isolated FunctionRemote Function
function replaceFileUsingIdAsStream(string itemId, stream<byte[], Error?> binaryStream, string mimeType) returns DriveItemData|Error

Update the contents of an existing file in the Drive. This method only supports files up to 4MB in size. Here, the type of the file should be the same type as the file we replace with.

Parameters
  • itemId string - The ID of the DriveItem
  • binaryStream stream<byte[], Error?> - An stream of byte[] that represents a binary stream of the file to be uploaded
  • mimeType string - The media type of the uploading file
Return Type

replaceFileUsingPathAsStream

Isolated FunctionRemote Function
function replaceFileUsingPathAsStream(string itemPath, stream<byte[], Error?> binaryStream, string mimeType) returns DriveItemData|Error

Update the contents of an existing file in the Drive. This method only supports files up to 4MB in size. Here, the type of the file should be the same type as the file we replace with.

Parameters
  • itemPath string - The file system path of the File. The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • binaryStream stream<byte[], Error?> - An stream of byte[] that represents a binary stream of the file to be uploaded
  • mimeType string - The media type of the uploading file
Return Type

uploadFileToFolderById

Isolated FunctionRemote Function
function uploadFileToFolderById(string parentFolderId, string fileName, byte[] byteArray, string mimeType) returns DriveItemData|Error

Uploads a new file to the Drive.
This method only supports files up to 4MB in size.

Parameters
  • parentFolderId string - The folder ID of the parent folder where, the new file will be uploaded
  • fileName string - The name of the new file
  • byteArray byte[] - An array of byte that represents a binary form of the file to be uploaded
  • mimeType string - The mime type of the uploading file
Return Type

uploadFileToFolderByPath

Isolated FunctionRemote Function
function uploadFileToFolderByPath(string parentFolderPath, string fileName, byte[] byteArray, string mimeType) returns DriveItemData|Error

Uploads a new file to the Drive.
This method only supports files up to 4MB in size.

Parameters
  • parentFolderPath string - The folder path of the parent folder relative to the root of the respective Drive where, the new folder will be created
    • NOTE: When you want to create a folder on root itself, you must give the relative path of the new folder only.
  • fileName string - The name of the new file
  • byteArray byte[] - An array of byte that represents a binary form of the file to be uploaded
  • mimeType string - The mime type of the uploading file
Return Type

replaceFileUsingId

Isolated FunctionRemote Function
function replaceFileUsingId(string itemId, byte[] byteArray, string mimeType) returns DriveItemData|Error

Updates the contents of an existing file in the Drive.
This method only supports files up to 4MB in size. Here, the type of the file should be the same type as the file we replace with.

Parameters
  • itemId string - The ID of the DriveItem
  • byteArray byte[] - An array of byte that represents a binary form of the file to be uploaded
  • mimeType string - The mime type of the uploading file
Return Type

replaceFileUsingPath

Isolated FunctionRemote Function
function replaceFileUsingPath(string itemPath, byte[] byteArray, string mimeType) returns DriveItemData|Error

Updates the contents of an existing file in the Drive.
This method only supports files up to 4MB in size. Here, the type of the file should be the same type as the file we replace with.

Parameters
  • itemPath string - The file system path of the File
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
    • example: Use the itempath as /Documents/MyFile.xlsx if MyFile.xlsx is located inside a folder called Docuements.
  • byteArray byte[] - An array of byte that represents a binary form of the file to be uploaded
  • mimeType string - The mime type of the uploading file
Return Type

resumableUploadDriveItem

Remote Function
function resumableUploadDriveItem(string itemPath, UploadMetadata itemInfo, stream<Block, Error?> binaryStream) returns DriveItemData|Error

Uploads files up to the maximum file size.
NOTE: Maximum bytes in any given request is less than 60 MiB.

Parameters
  • itemPath string - The file system path of the file (with extention)
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • itemInfo UploadMetadata - Additional data about the file being uploaded
  • binaryStream stream<Block, Error?> - Stream of content of file which we need to be uploaded
    • The size of each byte range in the stream MUST be a multiple of 320 KiB (327,680 bytes).
    • The recommended fragment size is between 5-10 MiB (5,242,880 bytes - 10,485,760 bytes)
    • Note: For more information about upload large files, visit.
Return Type

searchDriveItems

Isolated FunctionRemote Function
function searchDriveItems(string searchText, string? queryParams) returns stream<DriveItemData, Error?>|Error

Searches the hierarchy of items for items matching a query.

Parameters
  • searchText string - The query text used to search for items
    • Values may be matched across several fields including filename, metadata, and file content.
  • queryParams string? (default ()) - Optional query parameters
    • This method support OData query parameters to customize the response. It should be an array of type string in the format <QUERY_PARAMETER_NAME>=<PARAMETER_VALUE>
    • For more information about query parameters, visit.
Return Type

getSharableLinkFromId

Isolated FunctionRemote Function
function getSharableLinkFromId(string itemId, PermissionOptions options) returns Permission|Error

Creates a new sharing link if the specified link type doesn't already exist for the calling application.
If a sharing link of the specified type already exists for the app, the existing sharing link will be returned.

Parameters
  • itemId string - The ID of the DriveItem
  • options PermissionOptions - A record onedrive:PermissionOptions that represents the properties of the sharing link your application is requesting
Return Type
  • Permission|Error - A record onedrive:Permission if sucess. Else onedrive:Error.

getSharableLinkFromPath

Isolated FunctionRemote Function
function getSharableLinkFromPath(string itemPath, PermissionOptions options) returns Permission|Error

Creates a new sharing link if the specified link type doesn't already exist for the calling application.
If a sharing link of the specified type already exists for the app, the existing sharing link will be returned.

Parameters
  • itemPath string - The file system path of the File
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • options PermissionOptions - A record onedrive:PermissionOptions that represents the properties of the sharing link your application is requesting
Return Type
  • Permission|Error - A record onedrive:Permission if sucess. Else onedrive:Error.

getSharedDriveItem

Isolated FunctionRemote Function
function getSharedDriveItem(string sharingUrl) returns DriveItemData|Error

Accesses a shared DriveItem by using sharing URL.

Parameters
  • sharingUrl string - The URL that represents a sharing link reated for a DriveItem
Return Type

sendSharingInvitationById

Isolated FunctionRemote Function
function sendSharingInvitationById(string itemId, ItemShareInvitation invitation) returns Permission|Error

Sends a sharing invitation for a DriveItem.
A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Parameters
  • itemId string - The ID of the DriveItem
  • invitation ItemShareInvitation - A record onedrive:ItemShareInvitation that contain metadata for sharing
Return Type
  • Permission|Error - A record onedrive:Permission if sucess. Else onedrive:Error.

sendSharingInvitationByPath

Isolated FunctionRemote Function
function sendSharingInvitationByPath(string itemPath, ItemShareInvitation invitation) returns Permission|Error

Sends a sharing invitation for a DriveItem.
A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Parameters
  • itemPath string - The file system path of the File
    • The hierarchy of the path allowed in this function is relative to the root of the respective Drive. So, the relative path from root must be provided.
  • invitation ItemShareInvitation - A record onedrive:ItemShareInvitation that contain metadata for sharing
Return Type
  • Permission|Error - A record onedrive:Permission if sucess. Else onedrive:Error.

Records

microsoft.onedrive: Audio

Resource that groups audio-related properties on an item into a single structure.

Fields
  • album string? - The title of the album for this audio file
  • albumArtist string? - The artist named on the album for the audio file
  • artist string? - The performing artist for the audio file
  • bitrate int? - Bitrate expressed in kbps
  • composers string? - The name of the composer of the audio file
  • disc Unsigned16? - The number of the disc this audio file came from
  • discCount Unsigned16? - The total number of discs in this album
  • duration int? - Duration of the audio file, expressed in milliseconds
  • genre string? - The genre of this audio file
  • hasDrm boolean? - Indicates if the file is protected with digital rights management
  • isVariableBitrate boolean? - Indicates if the file is encoded with a variable bitrate
  • title string? - The title of the audio file
  • track Unsigned32? - The number of the track on the original disc for this audio file
  • trackCount Unsigned32? - The total number of tracks on the original disc for this audio file
  • year Unsigned32? - The year the audio file was recorded

microsoft.onedrive: ByteRange

Closed record

Resource that contains the values to define a range of bytes.

Fields
  • startByte int - The value of the starting index of bytes
  • endByte int - The value of the ending index of bytes

microsoft.onedrive: CheckInOptions

Closed record

Resource that contains options for Check-In a file.

Fields
  • comment string - A check-in comment that is associated with the version
  • checkInAs CheckInOption? - Optional. The status of the document after the check-in operation is complete. Can be published or unspecified.

microsoft.onedrive: ConnectionConfig

Closed record

Client configuration details.

Fields
  • httpVersion HttpVersion(default http:HTTP_1_1) - The HTTP version understood by the client

microsoft.onedrive: Deleted

Resource that indicates that the item has been deleted. The presence (non-null) of the resource value indicates that the file was deleted. A null (or missing) value indicates that the file is not deleted.

Fields
  • state string? - Represents the state of the deleted item

microsoft.onedrive: DriveItem

Closed record

Drive item data.

Fields
  • name string? - Name of the item
  • file File? - File metadata, if the item is a file
  • folder Folder? - Folder metadata, if the item is a folder
  • parentReference ParentReference? - Parent information, if the item has a parent

microsoft.onedrive: DriveItemData

Represents a file, folder, or other item stored in a drive.

Fields
  • id string? - The unique identifier of the drive
  • createdDateTime string? - Date and time of item creation
  • cTag string? - 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.
  • eTag string? - ETag for the item
  • lastModifiedDateTime string? - Date and time the item was last modified
  • name string? - Name of the item
  • size int? - Size of the item in bytes
  • webUrl string? - URL that displays the resource in the browser
  • description string? - Provides a user-visible description of the item
  • webDavUrl string? - WebDAV compatible URL for the item
  • root json? - If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive
  • createdBy IdentitySet? - Identity of the user, device, or application which created the item
  • lastModifiedBy IdentitySet? - Identity of the user, device, and application which last modified the item
  • parentReference ItemReference? - Parent information, if the item has a parent
  • remoteItem DriveItemData? - Remote item data, if the item is shared from a drive other than the one being accessed
  • downloadUrl string? - A URL that can be used to download this file's content. Authentication is not required with this URL.
  • file File? - File metadata, if the item is a file
  • folder Folder? - Folder metadata, if the item is a folder
  • image Image? - Image metadata, if the item is an image
  • photo Photo? - Photo metadata, if the item is a photo
  • video Video? - Video metadata, if the item is a video
  • audio Audio? - Audio metadata, if the item is an audio file
  • location GeoCordinates? - Location metadata, if the item has location data
  • package Package? - If present, indicates that this item is a package instead of a folder or file
  • publication Publication? - Provides information about the published or checked-out state of an item, in locations that support such actions
  • deleted Deleted? - Information about the deleted state of the item
  • shared Shared? - Indicates that the item has been shared with others and provides information about the shared state of the
  • searchResult SearchResult? - Search metadata, if the item is from a search result item
  • sharepointIds SharePointId? - Returns identifiers useful for SharePoint REST compatibility
  • specialFolder SpecialFolder? - If the current item is also available as a special folder, this facet is returned
  • children DriveItemData[]? - Collection containing Item objects for the immediate children of item
  • activities ItemActivity? - The list of recent activities that took place on this item
  • permissions Permission[]? - The set of permissions for the item
  • thumbnails ThumbnailSet[]? - Collection containing ThumbnailSet objects associated with the item

microsoft.onedrive: DriveItemVersion

Resource that represents a specific version of a DriveItem.

Fields
  • id string? - The ID of the version
  • lastModifiedBy IdentitySet? - Identity of the user which last modified the version
  • lastModifiedDateTime string? - Date and time the version was last modified
  • publication Publication? - Indicates the publication status of this particular version
  • size int? - Indicates the size of the content stream for this version of the item

microsoft.onedrive: DriveRecipient

Closed record

Resource that represents a person, group, or other recipient to share with using the invite action.

Fields
  • email string - The email address for the recipient, if the recipient has an associated email address
  • alias string? - The alias of the domain object, for cases where an email address is unavailable (e.g. security groups)
  • objectId string? - The unique identifier for the recipient in the directory

microsoft.onedrive: EmbeddableData

Closed record

Resource that represents the embeddable URLs for the preview.

Fields
  • getUrl string? - URL suitable for embedding using HTTP GET (iframes, etc.)
  • postUrl string? - URL suitable for embedding using HTTP POST (form post, JS, etc.)
  • postParameters string? - POST parameters to include if using postUrl

microsoft.onedrive: File

Resource that groups file-related data items into a single structure.

Fields
  • content byte[]? - A byte[] which represents the content of a file
  • mimeType string? - The MIME type for the file
  • hashes Hash? - Hashes of the file's binary content, if available

microsoft.onedrive: FileSystemInfo

Resource that contains properties that are reported by the device's local file system for the local version of an item.

Fields
  • createdDateTime string? - The UTC date and time the file was created on a client
  • lastAccessedDateTime string? - The UTC date and time the file was last accessed
  • lastModifiedDateTime string? - The UTC date and time the file was last modified on a client

microsoft.onedrive: Folder

Closed record

Resource that groups folder-related data on an item into a single structure.

Fields
  • childCount Unsigned32? - Number of children contained immediately within this container
  • view FolderView? - A collection of properties defining the recommended view for the folder

microsoft.onedrive: FolderMetadata

Closed record

Represents necessary metadata in reference to a folder.

Fields
  • name string - The name of the folder
  • folder Folder(default { }) - Folder metadata, if the item is a folder
  • parentReference ItemReference? - Parent information, if the item has a parent

microsoft.onedrive: FolderView

Resource that provides or sets recommendations on the user-experience of a folder.

Fields
  • sortBy SortBy? - The method by which the folder should be sorted
  • sortOrder SortOrder? - Indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending.
  • viewType ViewType? - The type of view that should be used to represent the folder

microsoft.onedrive: GeoCordinates

Resource that provides geographic coordinates and elevation of a location based on metadata contained within the file.

Fields
  • altitude float? - The altitude (height), in feet, above sea level for the item
  • latitude float? - The latitude, in decimal, for the item
  • longitude float? - he longitude, in decimal, for the item

microsoft.onedrive: Hash

Resource that groups available hashes into a single structure for an item.

Fields
  • crc32Hash string? - The CRC32 value of the file in little endian (if available)
  • sha1Hash string? - SHA1 hash for the contents of the file (if available)
  • sha256Hash string? - SHA256 hash for the contents of the file (if available)
  • quickXorHash string? - A proprietary hash of the file that can be used to determine if the contents of the file have changed

microsoft.onedrive: Identity

Represents an identity of a user, device, or application.

Fields
  • displayName string? - The identity's display name
  • id string? - Unique identifier for the identity

microsoft.onedrive: IdentitySet

represent a set of identities associated with various events for an item.

Fields
  • application Identity? - The application associated with this action
  • device Identity? - The device associated with this action
  • user Identity? - The user associated with this action

microsoft.onedrive: Image

Resource that groups image-related properties into a single structure.

Fields
  • height Unsigned32? - Height of the image, in pixels

microsoft.onedrive: IncompleteData

Closed record

Indicates that a resource was generated with incomplete data. The properties within might provide information about why the data is incomplete.

Fields
  • missingDataBeforeDateTime string - The service does not have source data before the specified time
  • wasThrottled boolean - Some data was not recorded due to excessive activity

microsoft.onedrive: ItemActionStat

Closed record

Resource that provides aggregate details about an action over a period of time.

Fields
  • actionCount Unsigned32 - The number of times the action took place
  • actorCount Unsigned32 - The number of distinct actors that performed the action

microsoft.onedrive: ItemActivity

Resource that provides information about activities that took place on an item or within a container.

Fields
  • id string? - The unique identifier of the activity
  • actor IdentitySet? - Identity of who performed the action
  • driveItem DriveItemData? - The driveItem that was the target of this activity
  • activityDateTime string? - Details about when the activity took place

microsoft.onedrive: ItemActivityStat

Resource that provides information about activities that took place within an interval of time.

Fields
  • activities ItemActivity[]? - Exposes the itemActivities represented in this itemActivityStat resource
  • incompleteData IncompleteData? - Indicates that the statistics in this interval are based on incomplete data
  • isTrending boolean? - Indicates whether the item is "trending"
  • startDateTime string? - When the interval starts
  • endDateTime string? - When the interval ends
  • create ItemActionStat? - Statistics about the create actions in this interval
  • delete ItemActionStat? - Statistics about the edit actions in this interval
  • edit ItemActionStat? - Statistics about the delete actions in this interval
  • move ItemActionStat? - Statistics about the move actions in this interval
  • access ItemActionStat? - Statistics about the access actions in this interval

microsoft.onedrive: ItemAnalytics

Resource that provides analytics about activities that took place on an item. This resource is currently only available on SharePoint and OneDrive for Business.

Fields

microsoft.onedrive: ItemReference

Provides information necessary to address a DriveItem via the API.

Fields
  • driveId string? - Unique identifier of the drive instance that contains the item
  • driveType string? - Identifies the type of drive
  • id string? - Unique identifier of the item in the drive
  • name string? - The name of the item being referenced
  • path string? - Path that can be used to navigate to the item
  • shareId string? - A unique identifier for a shared resource that can be accessed via the Shares API
  • sharepointIds SharePointId? - Returns identifiers useful for SharePoint REST compatibility

microsoft.onedrive: ItemShareInvitation

Closed record

Resource that represents necessary information for a sharing invitation.

Fields
  • requireSignIn boolean(default false) - Specifies whether the recipient of the invitation is required to sign-in to view the shared item.
  • sendInvitation boolean(default false) - If true, a sharing link is sent to the recipient. Otherwise, a permission is granted directly without sending a notification.
  • roles PermissionRole[] - Specify the roles that are to be granted to the recipients of the sharing invitation
  • recipients DriveRecipient[] - A collection of recipients who will receive access and the sharing invitation
  • message string? - A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.

microsoft.onedrive: Package

Resource that indicates if a DriveItem is the top level item in a "package" or a collection of items that should be treated as a collection instead of individual items.

Fields
  • 'type string? - A string indicating the type of package

microsoft.onedrive: ParentReference

Closed record

The reference data for the destination folder where the item will be copied.

Fields
  • id string - ID of the destination folder
  • driveId string? - ID of the Drive the destination folder exist

microsoft.onedrive: Permission

Resource that provides information about a sharing permission granted for a DriveItem resource.

Fields
  • id string? - The unique identifier of the permission among all permissions on the item
  • grantedTo IdentitySet? - For user type permissions, the details of the users & applications for this permission
  • grantedToIdentities IdentitySet[]? - For link type permissions, the details of the users to whom permission was granted
  • inheritedFrom ItemReference? - Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor
  • invitation ShareInvitation? - Details of any associated sharing invitation for this permission
  • roles string[]? - The type of permission
  • shareId string? - A unique token that can be used to access this shared item via the shares API

microsoft.onedrive: PermissionOptions

Closed record

Resource that defines properties of the sharing link your application is requesting.

Fields
  • 'type LinkType - The type of sharing link to create. Either view, edit, or embed
  • scope LinkScope? - The scope of link to create. Either anonymous or organization
  • password string? - The password of the sharing link that is set by the creator. Optional and OneDrive Personal only.
  • expirationDateTime string? - A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission

microsoft.onedrive: Photo

Resource that provides photo and camera properties.

Fields
  • cameraMake string? - Camera manufacturer
  • cameraModel string? - Camera model
  • exposureDenominator float? - The denominator for the exposure time fraction from the camera
  • exposureNumerator float? - The numerator for the exposure time fraction from the camera
  • fNumber float? - The F-stop value from the camera
  • focalLength float? - The focal length from the camera
  • takenDateTime string? - Represents the date and time the photo was taken

microsoft.onedrive: PreviewOptions

Closed record

Resource that contain defines properties of the embeddable URL your application is requesting.

Fields
  • page string|int? - Optional. Page number of document to start at, if applicable. Specified as string for future use cases around file types such as ZIP.
  • zoom int? - Optional. Zoom level to start at, if applicable.

microsoft.onedrive: Publication

Resource that provides details on the published status of a driveItemVersion or driveItem resource.

Fields
  • level PublicationLevel? - The state of publication for this document. Either published or checkout.
  • versionId string? - The unique identifier for the version that is visible to the current caller

microsoft.onedrive: SearchResult

Resource that indicates than an item is the response to a search query.

Fields
  • onClickTelemetryUrl string? - A callback URL that can be used to record telemetry information.

microsoft.onedrive: Shared

Resource that indicates a DriveItem has been shared with others.

Fields
  • owner IdentitySet? - The identity of the owner of the shared item
  • scope string? - Indicates the scope of how the item is shared: anonymous, organization, or users
  • sharedBy IdentitySet? - The identity of the user who shared the item
  • sharedDateTime string? - he UTC date and time when the item was shared

microsoft.onedrive: ShareInvitation

Resource that groups invitation-related data items into a single structure.

Fields
  • email string? - The email address provided for the recipient of the sharing invitation
  • invitedBy IdentitySet? - Provides information about who sent the invitation that created this permission, if that information is available
  • signInRequired boolean? - If true the recipient of the invitation needs to sign in in order to access the shared item

microsoft.onedrive: SharePointId

Resource that groups the various identifiers for an item stored in a SharePoint site or OneDrive for Business into a single structure.

Fields
  • listId string? - The unique identifier (guid) for the item's list in SharePoint
  • listItemId string? - An integer identifier for the item within the containing list
  • listItemUniqueId string? - The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site
  • siteId string? - The unique identifier (guid) for the item's site collection (SPSite)
  • siteUrl string? - The SharePoint URL for the site that contains the item
  • tenantId string? - The unique identifier (guid) for the tenancy
  • webId string? - The unique identifier (guid) for the item's site (SPWeb)

Resource that groups link-related data items into a single structure.

Fields
  • application Identity? - The app the link is associated with
  • 'type LinkType? - The type of the link created
  • scope LinkScope? - The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.
  • webHtml string? - For embed links, this property contains the HTML code for an <iframe> element that will embed the item in a webpage.
  • webUrl string? - A URL that opens the item in the browser on the OneDrive website.

microsoft.onedrive: SpecialFolder

Resource that groups special folder-related data items into a single structure.

Fields
  • name string? - The unique identifier for this item in the /drive/special collection

microsoft.onedrive: ThumbnailSet

Resource which is a keyed collection of thumbnail resources. It is used to represent a set of thumbnails associated with a DriveItem.

Fields
  • id string? - The id within the item
  • large Tumbnail? - A 1920x1920 scaled thumbnail
  • medium Tumbnail? - A 176x176 scaled thumbnail
  • small Tumbnail? - A 48x48 cropped thumbnail
  • 'source Tumbnail? - A custom thumbnail image or the original image used to generate other thumbnails

microsoft.onedrive: Tumbnail

Resource that represents a thumbnail for an image, video, document, or any item that has a bitmap representation.

Fields
  • height Unsigned32? - The height of the thumbnail, in pixels
  • width Unsigned32? - The width of the thumbnail, in pixels
  • sourceItemId string? - The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested.
  • url string? - The URL used to fetch the thumbnail content

microsoft.onedrive: UploadMetadata

Closed record

Resource that provide additional data about the file being uploaded and customizing the semantics of the upload operation.

Fields
  • fileSize int - Provides an expected file size to perform a quota check prior to upload. Only on OneDrive Personal.
  • name string? - The name of the item (filename and extension)
  • description string? - Provides a user-visible description of the item. Only on OneDrive Personal.

microsoft.onedrive: Video

Resource that groups video-related data items into a single structure.

Fields
  • audioBitsPerSample Unsigned32? - Number of audio bits per sample
  • audioChannels Unsigned32? - Number of audio channels
  • audioFormat string? - Name of the audio format (AAC, MP3, etc.)
  • audioSamplesPerSecond Unsigned32? - Number of audio samples per second
  • bitrate Unsigned32? - Bit rate of the video in bits per second
  • duration int? - Duration of the file in milliseconds
  • fourCC string? - "Four character code" name of the video format
  • frameRate float? - Frame rate of the video
  • height Unsigned32? - Height of the video, in pixels

Enums

microsoft.onedrive: CheckInOption

The desired status of the document after the check-in operation is complete.

Members

PUBLISHED - The content is published
UNSPECIFIED - The status of conteent is unspecified

microsoft.onedrive: ConflictResolutionBehaviour

Represents the conflict resolution behavior for actions in file operations. Default for PUT requests is REPLACE

Members

FAIL - Fail the operation when a conflict occurs
REPLACE - Replace the file content when a conflict occurs
RENAME - Rename the file when a conflict occurs

microsoft.onedrive: FileFormat

Represents the possible mimetypes of a file. Note: For more information about compatible formats, refer here: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get_content_format?view=odsp-graph-online#query-string-parameters#

Members

MIMETYPE_PDF - Converts the item into PDF format
MIMETYPE_JPG - Converts the item into JPG format
MIMETYPE_HTML - Converts the item into HTML format
MIMETYPE_GLB - Converts the item into GLB format

microsoft.onedrive: LinkScope

The scope of the link represented by this permission.

Members

ANONYMOUS - Indicates the link is usable by anyone
ORGANIZATION - Indicates the link is only usable for users signed into the same tenant

microsoft.onedrive: LinkType

The type of the link created.

Members

VIEW - A view-only sharing link, allowing read-only access
EDIT - An edit sharing link, allowing read-write accessharing link, allowing read-only access
EMBED - A view-only sharing link that can be used to embed content into a host webpage

microsoft.onedrive: PermissionRole

Specify the roles that are to be granted to the recipients of the sharing invitation.

Members

READ - Read permission
WRITE - Write permission

microsoft.onedrive: PublicationLevel

The state of publication for a document.

Members

PUBLISHED_LEVEL - The level for a pusblished document
CHECKOUT_LEVEL - The level for a document to ensure that no-one else is able to edit it

microsoft.onedrive: SortBy

The method by which the folder should be sorted.

Members

DEFAULT - The default sort order of the application
NAME - Items should be arranged by the name property of the items
TYPE - Items should be arranged by the type of item
SIZE - Items should be arranged by the size property of the items
CREATEDDATETIME - Items should be arranged by the takenDateTime property of the photo facet. If not available, the createdDateTime property should be used.
LASTMODIFIEDDATETIME - Items should be arranged by the lastModifiedDateTime property of the items
SEQUENCE - Items follow a custom sequence specified by the user

microsoft.onedrive: SortOrder

If value is descending, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending.

Members

ASCENDING - Items should be arranged in ascending order
DESCENDING - Items should be arranged in descending order

microsoft.onedrive: ViewType

The type of view that should be used to represent the folder.

Members

DEFAULT_VIEWTYPE - The default view type for the application
ICONS_VIEWTYPE - A view that uses icons to represent driveItems
DETAILS_VIEWTYPE - A view with multiple columns that provide additional details about each item
THUMBNAILS_VIEWTYPE - A view that uses larger thumbnails of driveItems to represent the items

Constants

microsoft.onedrive: DEFAULT_FRAGMENT_SIZE

int 327680

The default fragment size for obtaining fragments of a file.(To upload as fragment size MUST be a multiple of 320 KiB (327,680 bytes)).

microsoft.onedrive: MAXIMUM_FRAGMENT_SIZE

int 62914550

The maximum fragment size for obtaining fragments of a file. (The maximum bytes in any given request muat be less than 60 MiB (62,914,560 bytes))

Errors

microsoft.onedrive: InputValidationError

Distinct

An error which occur when providing an invalid value.

microsoft.onedrive: PayloadValidationError

Distinct

An errror occur due to an invalid payload received.

microsoft.onedrive: QueryParameterValidationError

Distinct

An error which occur when there is an invalid query parameter.

microsoft.onedrive: RequestFailedError

Distinct

An error occur due to a failed failed request attempt.

Other versions

2.3.0

2.2.02.1.02.0.01.0.3
See more...

Terms of service

Privacy policy

Cookie policy

2023 WSO2