Microsoft_Onedrive
Create a copy of a driveItem asynchronously including child items. You can specify a new parent folder, provide a new name, copy only children, or include version history. The operation is queued and processed asynchronously - use the monitor URL to track progress until completion.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Request body containing copy operation parameters.
Query parameters for conflict resolution.
Successful Response
Validation Error
List all drives available to the current user (personal, shared, or group drives).
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Retrieve the properties and relationships of a specific Drive resource by its ID. A Drive is the top-level container for a file system, such as OneDrive or SharePoint document libraries.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Get the current user's OneDrive. The signed-in user's drive is accessed automatically and will be provisioned if it doesn't exist but the user has a license to use OneDrive.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Create a new folder in a drive at the specified parent location. Returns the newly created folder with its metadata including ID, name, creation time, and parent reference. Supports conflict resolution when a folder with the same name already exists.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Retrieve the metadata for a driveItem in a drive by its unique ID. Returns file/folder details including name, size, created/modified dates, parent references, and other properties.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Return a collection of DriveItems in the children relationship of a DriveItem. DriveItems with a non-null folder or package facet can have one or more child DriveItems.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Track changes in a driveItem and its children over time. Use for incremental synchronization to detect added, modified, or deleted items. Returns @odata.nextLink for pagination or @odata.deltaLink for future change tracking.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for delta synchronization.
Successful Response
Validation Error
Search the hierarchy of items within a drive for items matching a query. Searches across filename, metadata, and file content within the user's drive only.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Search more broadly to include items shared with the current user, in addition to items within the user's drive. Returns items from the user's drive and items shared with them from other drives.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Retrieve the metadata for a driveItem in a drive by its file system path relative to the root. Returns file/folder details including name, size, created/modified dates, and other properties. Use this when you know the path but not the item ID.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Get the root folder of the user's OneDrive. This is a shortcut to access the top-level folder without needing to know its ID. Supports expanding children and other OData query parameters.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]OData query parameters to customize the response.
Successful Response
Validation Error
Retrieve the version history of a driveItem. OneDrive and SharePoint retain file history depending on configuration. Returns DriveItemVersion objects with version ID, lastModifiedBy, lastModifiedDateTime, and size. Versions are returned in descending order (newest to oldest).
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters to customize the response. Note: $orderby is not supported as versions are always returned newest to oldest.
Successful Response
Validation Error
Update the metadata for a driveItem by ID. Allows updating properties such as name (to rename files/folders), parentReference (to move items), and other metadata. Returns the updated DriveItem resource with modified properties.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Move a driveItem to a new parent folder by updating its parentReference. You can also rename the item during the move operation. This is a special case of the update method that moves items within the same drive. Items cannot be moved between different drives.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Read the content of a text-based file from OneDrive by its item ID. This function downloads the actual file content for text-based files such as .txt, .csv, .md, .log, .json, and other text formats.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]The identifier of the driveItem file to read. Only files (not folders) can be read. Use the full item ID as returned by other OneDrive functions (e.g., '7006ADAF2D3C1355!s5625f3cefe4c4fe28f99a4b6f05cb944').
Successful Response
Validation Error
Get the download URL for a driveItem file. Returns the @microsoft.graph.downloadUrl property which provides a preauthenticated download URL that's valid for a short period. This URL can be used directly for downloading without additional authentication.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Delete a DriveItem by using its ID. Deleting items using this method moves the items to the recycle bin instead of permanently deleting the item. Returns 204 No Content on successful deletion.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Permanently delete a driveItem by using its ID. WARNING: Items deleted with this method are permanently removed and are NOT sent to the recycle bin. They cannot be restored afterward. Use with extreme caution. Returns 204 No Content on successful deletion.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Upload or create a new text-based file to OneDrive. This method only supports text-based files like .txt, .md, .csv, .json, .log, .xml, .html, .css, .js, .py, .yaml, etc. Files up to 250 MB in size are supported. The file will be created at the specified parent location with the given filename.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]The text content of the file to upload. Provide the text content directly as a string.
Successful Response
Validation Error
Update or replace the contents of an existing text-based file in OneDrive. This method only supports text-based files like .txt, .md, .csv, .json, .log, .xml, .html, .css, .js, .py, .yaml, etc. Files up to 250 MB in size are supported. The file content will be completely replaced with the new content provided.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]The text content to replace the existing file content with. Provide the text content directly as a string.
Successful Response
Validation Error
Convert CSV data to a formatted text file and save it to OneDrive. Takes CSV data as a string and creates a properly formatted CSV file in the specified parent folder on OneDrive. While named 'excel', this creates a CSV file that can be opened in Excel.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]The CSV data as a string to save as a file. Should be properly formatted CSV with headers and data rows.
The name for the CSV file (without .csv extension). If not provided, defaults to 'converted_data'.
The identifier of the parent folder where the new CSV file will be created. Use 'root' for the root directory or a specific folder item ID.
Successful Response
Validation Error
Last updated