SFItemsEntity (ShareFileJavaSDK 3.1.2 API)

java.lang.Object
- com.citrix.sharefile.api.entities.SFEntitiesBase
- - com.citrix.sharefile.api.entities.SFItemsEntity

public class SFItemsEntity
extends SFEntitiesBase

Field Summary
- Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase
  client

Constructor Summary

Constructors
Constructor and Description

SFItemsEntity(ISFApiClient client)

Constructors
Constructor and Description
`SFItemsEntity(ISFApiClient client)`

Method Summary

Methods
Modifier and Type	Method and Description
`ISFQuery<SFAdvancedSearchResults>`	`advancedSearch(SFSearchQuery searchQuery)` Advanced Search { "Query":{ "ItemTypes":["type1", "type2", ...], "ParentID":["id1", "id2", ...], "CreatorID":["id1", "id2", ...], "SearchQuery":"", "CreateStartDate":"", "CreateEndDate":"", "ItemNameOnly":false }, "Paging":{ "PageNumber":1, (deprecated) "PageSize":10, (deprecated) "Count":50, (default value) "Skip":0, (default value) }, "Sort":{ "SortBy":"", "Ascending":false, }, "TimeoutInSeconds":10 } Search for Items matching the criteria of the query parameter
`ISFQuery<SFAdvancedSearchResults>`	`advancedSimpleSearch(SFSimpleSearchQuery simpleSearchQuery)` Advanced Simple Search { "Query":{ "ItemType":"", "ParentID":"", "CreatorID":"", "SearchQuery":"", "CreateStartDate":"", "CreateEndDate":"", "ItemNameOnly":false }, "Paging":{ "PageNumber":1, (Deprecated) "PageSize":10, (Deprecated) "Count": 50 "Skip": 0 }, "Sort":{ "SortBy":"", "Ascending":false, }, "TimeoutInSeconds":10 } Search for Items matching the criteria of the query parameter
`ISFQuery`	`bulkDelete(java.net.URI parentUrl, java.util.ArrayList<java.lang.String> ids)` Delete Multiple Items ["id1","id2",...] All items in bulk delete must be children of the same parent, identified in the URI
`ISFQuery`	`bulkDelete(java.net.URI parentUrl, java.util.ArrayList<java.lang.String> ids, java.lang.Boolean forceSync)` Delete Multiple Items ["id1","id2",...] All items in bulk delete must be children of the same parent, identified in the URI
`ISFQuery`	`bulkDelete(java.net.URI parentUrl, java.util.ArrayList<java.lang.String> ids, java.lang.Boolean forceSync, java.lang.Boolean deletePermanently)` Delete Multiple Items ["id1","id2",...] All items in bulk delete must be children of the same parent, identified in the URI
`ISFQuery`	`bulkDeletePermanently(java.util.ArrayList<java.lang.String> ids)` Permanently delete multiple items
`ISFQuery<java.io.InputStream>`	`bulkDownload(java.net.URI parentUrl, java.util.ArrayList<java.lang.String> ids)` Download Multiple Items ["id1","id2",...] Initiate the download operation for items.
`ISFQuery<java.io.InputStream>`	`bulkDownload(java.net.URI parentUrl, java.util.ArrayList<java.lang.String> ids, java.lang.Boolean redirect)` Download Multiple Items ["id1","id2",...] Initiate the download operation for items.
`ISFQuery`	`bulkRestore(java.util.ArrayList<java.lang.String> ids)` Restore expired items to their original locations
`ISFQuery<SFItem>`	`byPath(java.lang.String path)` Get Item by Path Retrieves an item from its path.
`ISFQuery<SFItem>`	`byPath(java.net.URI url, java.lang.String path)` Get Item by relative Path from ID Retrieves an item from its path, relative to the provided ID.
`ISFQuery`	`checkIn(java.net.URI url)` Unlock File Unlock a locked file.
`ISFQuery`	`checkIn(java.net.URI url, java.lang.String message)` Unlock File Unlock a locked file.
`ISFQuery`	`checkOut(java.net.URI url)`
`ISFQuery`	`checkTemplateOwned(java.net.URI url, java.lang.String id)` Check if template is already part of an existing template structure
`ISFQuery`	`checkVersioningViolation(java.net.URI url, java.lang.String id, java.lang.Integer newMaxVersions)` Check if a versioning change would result in file deletions
`ISFQuery<SFItem>`	`copy(java.net.URI url, java.lang.String targetid)` Copy Item Copies an item to a new target Folder.
`ISFQuery<SFItem>`	`copy(java.net.URI url, java.lang.String targetid, java.lang.Boolean overwrite)` Copy Item Copies an item to a new target Folder.
`ISFQuery<SFSymbolicLink>`	`createChildrenByConnectorGroup(java.net.URI url, SFSymbolicLink symlink)` Creates SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Link":"https://server/provider/version/Items(id)", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } }
`ISFQuery<SFSymbolicLink>`	`createChildrenByConnectorGroup(java.net.URI url, SFSymbolicLink symlink, java.lang.Boolean overwrite)` Creates SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Link":"https://server/provider/version/Items(id)", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } }
`ISFQuery<SFFolder>`	`createFolder(java.net.URI parentUrl, SFFolder folder)` Create Folder { "Name":"Folder Name", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" } } Creates a new Folder.
`ISFQuery<SFFolder>`	`createFolder(java.net.URI parentUrl, SFFolder folder, java.lang.Boolean overwrite)` Create Folder { "Name":"Folder Name", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" } } Creates a new Folder.
`ISFQuery<SFFolder>`	`createFolder(java.net.URI parentUrl, SFFolder folder, java.lang.Boolean overwrite, java.lang.Boolean passthrough)` Create Folder { "Name":"Folder Name", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" } } Creates a new Folder.
`ISFQuery<SFLink>`	`createLink(java.net.URI parentUrl, SFLink link)` Create Link { "Name":"Link Name", "Description":"Description", "Uri":"https://server/path" } Creates a new Link
`ISFQuery<SFNote>`	`createNote(java.net.URI parentUrl, SFNote note)` Create Note { "Name":"Note Name", "Description":"Description" } Creates a new Note.
`ISFQuery<SFSymbolicLink>`	`createSymbolicLink(java.net.URI parentUrl, SFSymbolicLink symlink)` Create SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } } Creates a Symbolic Link The body must contain either a "Link" parameter with a fully qualified URI; or use FileName + Zone to have sharefile.com attempt to convert the Connector path to an URI using a call to the Zone - using ShareFile Hash authentication mode.
`ISFQuery<SFSymbolicLink>`	`createSymbolicLink(java.net.URI parentUrl, SFSymbolicLink symlink, java.lang.Boolean overwrite)` Create SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } } Creates a Symbolic Link The body must contain either a "Link" parameter with a fully qualified URI; or use FileName + Zone to have sharefile.com attempt to convert the Connector path to an URI using a call to the Zone - using ShareFile Hash authentication mode.
`ISFQuery`	`delete(java.net.URI url)` Delete Item Removes an item
`ISFQuery`	`delete(java.net.URI url, java.lang.Boolean singleversion)` Delete Item Removes an item
`ISFQuery`	`delete(java.net.URI url, java.lang.Boolean singleversion, java.lang.Boolean forceSync)` Delete Item Removes an item
`ISFQuery`	`discardCheckOut(java.net.URI url)`
`ISFQuery<java.io.InputStream>`	`download(java.net.URI url)` Download Item Content Initiate the download operation for an item.
`ISFQuery<java.io.InputStream>`	`download(java.net.URI url, java.lang.Boolean redirect)` Download Item Content Initiate the download operation for an item.
`ISFQuery<java.io.InputStream>`	`download(java.net.URI url, java.lang.Boolean redirect, java.lang.Boolean includeAllVersions)` Download Item Content Initiate the download operation for an item.
`ISFQuery<SFItem>`	`get()` Get HomeFolder for Current User Returns home folder for current user.
`ISFQuery<SFItem>`	`get(java.net.URI url)` Get Item by ID Returns a single Item.
`ISFQuery<SFItem>`	`get(java.net.URI url, java.lang.Boolean includeDeleted)` Get Item by ID Returns a single Item.
`ISFQuery<SFItem>`	`get(java.net.URI url, SFSafeEnum<SFTreeMode> treeMode, java.lang.String sourceId)` Get TreeView Retrieves a folder list structure tailored for TreeView navigation - used by clients to create folder trees for specific operations.
`ISFQuery<SFItem>`	`get(java.net.URI url, SFSafeEnum<SFTreeMode> treeMode, java.lang.String sourceId, java.lang.Boolean canCreateRootFolder)` Get TreeView Retrieves a folder list structure tailored for TreeView navigation - used by clients to create folder trees for specific operations.
`ISFQuery<SFItem>`	`get(java.net.URI url, SFSafeEnum<SFTreeMode> treeMode, java.lang.String sourceId, java.lang.Boolean canCreateRootFolder, java.lang.Boolean fileBox)` Get TreeView Retrieves a folder list structure tailored for TreeView navigation - used by clients to create folder trees for specific operations.
`ISFQuery<SFODataFeed<SFItem>>`	`getBreadcrumbs(java.net.URI url)` Get Breadcrumbs Retrieves the path from an item from the root.
`ISFQuery<SFODataFeed<SFItem>>`	`getBreadcrumbs(java.net.URI url, java.lang.String path)` Get Breadcrumbs Retrieves the path from an item from the root.
`ISFQuery<SFODataFeed<SFItem>>`	`getChildren(java.net.URI url)` Get Children Handler for the Children navigation property of a given Item.
`ISFQuery<SFODataFeed<SFItem>>`	`getChildren(java.net.URI url, java.lang.Boolean includeDeleted)` Get Children Handler for the Children navigation property of a given Item.
`ISFQuery<SFODataFeed<SFItem>>`	`getChildren(java.net.URI url, java.lang.Boolean includeDeleted, SFSafeEnum<SFItemOrderingMode> orderingMode)` Get Children Handler for the Children navigation property of a given Item.
`ISFQuery<SFODataFeed<SFItem>>`	`getChildrenByConnectorGroup(java.net.URI parentUrl)` Get Symbolic Links of a Connector Group Retrieves the Symbolic Links of the provided Connector Group type.
`ISFQuery<SFODataFeed<SFItem>>`	`getDeletedChildren(java.net.URI url, java.lang.String id)` Get a collection of recoverable/deleted items in a folder
`ISFQuery<SFItemInfo>`	`getInfo(java.net.URI url)` Get Folder Access Info Returns the effective Access Controls for the current authenticated user for the selected folder - i.e., the resulting set of Access Controls for the Item/User context.This operation applies to Folders only, will return an error for other Item types.
`ISFQuery<SFItem>`	`getParent(java.net.URI url)` Get Parent Item Retrieves the Parent navigation property of a single Item.
`ISFQuery<SFODataFeed<SFItemProtocolLink>>`	`getProtocolLinks(java.net.URI url, SFSafeEnum<SFPreviewPlatform> platform)` Get List of Item Protocol Links
`ISFQuery<SFRedirection>`	`getRedirection(java.net.URI url)` Get Redirection endpoint Information Returns the redirection endpoint for this Item.This operation applies to Folders and SymbolicLinks only, will return an error for other Item types.
`ISFQuery<java.io.InputStream>`	`getThumbnail(java.net.URI url)` Get Thumbnail Retrieve a thumbnail link from the specified Item.
`ISFQuery<java.io.InputStream>`	`getThumbnail(java.net.URI url, java.lang.Integer size)` Get Thumbnail Retrieve a thumbnail link from the specified Item.
`ISFQuery<java.io.InputStream>`	`getThumbnail(java.net.URI url, java.lang.Integer size, java.lang.Boolean redirect)` Get Thumbnail Retrieve a thumbnail link from the specified Item.
`ISFQuery<SFODataFeed<SFItem>>`	`getUserDeletedItems()`
`ISFQuery<SFODataFeed<SFItem>>`	`getUserDeletedItems(java.lang.String userid)`
`ISFQuery<SFODataFeed<SFItem>>`	`getUserDeletedItems(java.lang.String userid, java.lang.String zone)`
`ISFQuery`	`removeTemplateAssociation(java.net.URI url, java.lang.String id)` Remove folder template association from folder
`ISFQuery<SFSearchResults>`	`search(java.lang.String query)` Search Search for Items matching the criteria of the query parameter
`ISFQuery<SFSearchResults>`	`search(java.lang.String query, java.lang.Integer maxResults)` Search Search for Items matching the criteria of the query parameter
`ISFQuery<SFSearchResults>`	`search(java.lang.String query, java.lang.Integer maxResults, java.lang.Integer skip)` Search Search for Items matching the criteria of the query parameter
`ISFQuery<SFSearchResults>`	`search(java.lang.String query, java.lang.Integer maxResults, java.lang.Integer skip, java.lang.Boolean homeFolderOnly)` Search Search for Items matching the criteria of the query parameter
`ISFQuery<SFODataFeed<SFItem>>`	`stream(java.net.URI url)` Get Stream Retrieves the versions of a given Stream.
`ISFQuery<SFODataFeed<SFItem>>`	`stream(java.net.URI url, java.lang.Boolean includeDeleted)` Get Stream Retrieves the versions of a given Stream.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item, java.lang.String batchid)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item, java.lang.String batchid, java.lang.Long batchSizeInBytes)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item, java.lang.String batchid, java.lang.Long batchSizeInBytes, java.lang.Boolean forceSync)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item, java.lang.String batchid, java.lang.Long batchSizeInBytes, java.lang.Boolean forceSync, java.lang.Boolean scheduleAsync)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item, java.lang.String batchid, java.lang.Long batchSizeInBytes, java.lang.Boolean forceSync, java.lang.Boolean scheduleAsync, java.lang.Boolean resolveFolderNameConflict)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFItem>`	`update(java.net.URI url, SFItem item, java.lang.String batchid, java.lang.Long batchSizeInBytes, java.lang.Boolean forceSync, java.lang.Boolean scheduleAsync, java.lang.Boolean resolveFolderNameConflict, java.lang.Boolean notify)` Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object.
`ISFQuery<SFLink>`	`updateLink(java.lang.String id, SFLink link)` Update Link { "Name":"Name", "Uri":"https://server/path", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Link object
`ISFQuery<SFLink>`	`updateLink(java.lang.String id, SFLink link, java.lang.Boolean notify)` Update Link { "Name":"Name", "Uri":"https://server/path", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Link object
`ISFQuery<SFNote>`	`updateNote(java.lang.String id, SFNote note)` Update Note { "Name":"Name", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Note object
`ISFQuery<SFNote>`	`updateNote(java.lang.String id, SFNote note, java.lang.Boolean notify)` Update Note { "Name":"Name", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Note object
`ISFQuery<SFSymbolicLink>`	`updateSymbolicLink(java.lang.String id, SFSymbolicLink symlink)` Update SymbolicLink { "Name":"Name", "Description":"Description", "Link": "https://server/path" } Updates a Symbolic Link object
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount)` Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat) Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify) Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify, java.util.Date clientCreatedDateUTC) Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify, java.util.Date clientCreatedDateUTC, java.util.Date clientModifiedDateUTC) Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify, java.util.Date clientCreatedDateUTC, java.util.Date clientModifiedDateUTC, java.lang.Integer expirationDays) Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder.
`ISFQuery<SFUploadSpecification>`	`upload2(java.net.URI url, SFUploadRequestParams uploadParams)`
`ISFQuery<SFUploadSpecification>`	`upload2(java.net.URI url, SFUploadRequestParams uploadParams, java.lang.Integer expirationDays)`
`ISFQuery<SFRedirection>`	`webAppLink(java.net.URI url)` Create a one-time use login Uri for the Web App.
`ISFQuery<SFRedirection>`	`webView(java.net.URI url)` Get Web Preview Link Redirects the caller to the Web Edit application for the selected item.

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase
getEntity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SFItemsEntity
```
public SFItemsEntity(ISFApiClient client)
```
- Method Detail
  - get
```
public ISFQuery<SFItem> get()
```
    Get HomeFolder for Current User Returns home folder for current user. Note that home folders are not available for client users, or if the account doesn't have the "My Files & Folders" feature enabled.
    
    Returns:
    home folder for current user
  - get
```
public ISFQuery<SFItem> get(java.net.URI url,
                   java.lang.Boolean includeDeleted)
                     throws InvalidOrMissingParameterException
```
    Get Item by ID Returns a single Item. Special Id's:home, favorites, allshared, connectors, box, top. home - Return home folder. favorites - Return parent favorite item; use .../Items(favorites)/Children to get the favorite folders. allshared - Return parent Shared Folders item; use .../Items(allshared)/Children to get the shared folders. connectors - Return parent Connectors item; use .../Items(connectors)/Children to get indiviual connectors. box - Return the FileBox folder. top - Returns the Top item; use .../Items(top)/Children to get the home, favorites, and shared folders as well as the connectors
    
    Parameters:
    url -
    includeDeleted - (default: false)
    
    Returns:
    a single Item
    
    Throws:
    
    InvalidOrMissingParameterException
  - get
```
public ISFQuery<SFItem> get(java.net.URI url)
                     throws InvalidOrMissingParameterException
```
    Get Item by ID Returns a single Item. Special Id's:home, favorites, allshared, connectors, box, top. home - Return home folder. favorites - Return parent favorite item; use .../Items(favorites)/Children to get the favorite folders. allshared - Return parent Shared Folders item; use .../Items(allshared)/Children to get the shared folders. connectors - Return parent Connectors item; use .../Items(connectors)/Children to get indiviual connectors. box - Return the FileBox folder. top - Returns the Top item; use .../Items(top)/Children to get the home, favorites, and shared folders as well as the connectors
    
    Parameters:
    url -
    
    Returns:
    a single Item
    
    Throws:
    
    InvalidOrMissingParameterException
  - get
```
public ISFQuery<SFItem> get(java.net.URI url,
                   SFSafeEnum<SFTreeMode> treeMode,
                   java.lang.String sourceId,
                   java.lang.Boolean canCreateRootFolder,
                   java.lang.Boolean fileBox)
                     throws InvalidOrMissingParameterException
```
    Get TreeView Retrieves a folder list structure tailored for TreeView navigation - used by clients to create folder trees for specific operations. This operation will enforce a specific $select and $expand operators. You can provide additional $expand, for example Children, which is not added by default. The $select operator will apply to the expanded objects as well. You can also specify additional $select elements.
    
    Parameters:
    url -
    treeMode -
    sourceId -
    canCreateRootFolder - (default: false)
    fileBox - (default: false)
    
    Returns:
    A tree root element.
    
    Throws:
    
    InvalidOrMissingParameterException
  - get
```
public ISFQuery<SFItem> get(java.net.URI url,
                   SFSafeEnum<SFTreeMode> treeMode,
                   java.lang.String sourceId,
                   java.lang.Boolean canCreateRootFolder)
                     throws InvalidOrMissingParameterException
```
    Get TreeView Retrieves a folder list structure tailored for TreeView navigation - used by clients to create folder trees for specific operations. This operation will enforce a specific $select and $expand operators. You can provide additional $expand, for example Children, which is not added by default. The $select operator will apply to the expanded objects as well. You can also specify additional $select elements.
    
    Parameters:
    url -
    treeMode -
    sourceId -
    canCreateRootFolder - (default: false)
    
    Returns:
    A tree root element.
    
    Throws:
    
    InvalidOrMissingParameterException
  - get
```
public ISFQuery<SFItem> get(java.net.URI url,
                   SFSafeEnum<SFTreeMode> treeMode,
                   java.lang.String sourceId)
                     throws InvalidOrMissingParameterException
```
    Get TreeView Retrieves a folder list structure tailored for TreeView navigation - used by clients to create folder trees for specific operations. This operation will enforce a specific $select and $expand operators. You can provide additional $expand, for example Children, which is not added by default. The $select operator will apply to the expanded objects as well. You can also specify additional $select elements.
    
    Parameters:
    url -
    treeMode -
    sourceId -
    
    Returns:
    A tree root element.
    
    Throws:
    
    InvalidOrMissingParameterException
  - getChildrenByConnectorGroup
```
public ISFQuery<SFODataFeed<SFItem>> getChildrenByConnectorGroup(java.net.URI parentUrl)
                                                          throws InvalidOrMissingParameterException
```
    Get Symbolic Links of a Connector Group Retrieves the Symbolic Links of the provided Connector Group type. Connector Groups define classes of external data connectors - such as SharePoint, Network Shares. Symbolic Links represent a single Connector point to such classes - for example, a single SharePoint site, or a network share drive.
    
    Parameters:
    parentUrl -
    
    Returns:
    The list of Symbolic Links associated with the given connector group.
    
    Throws:
    
    InvalidOrMissingParameterException
  - stream
```
public ISFQuery<SFODataFeed<SFItem>> stream(java.net.URI url,
                                   java.lang.Boolean includeDeleted)
                                     throws InvalidOrMissingParameterException
```
    Get Stream Retrieves the versions of a given Stream. The ID parameter must be a StreamID, otherwise an empty list is returned. StreamID is a property of all Items, representing the "Stream", ie., the collection of all versions of a file. In contrast, an Item ID represents a single version of a file. For example, when users upload or modify an existing file, a new Item is created with the same StreamID. All default Item enumerations return only the latest version of a given stream. Use this method to retrieve previous versions of a given stream. This method carries a default OData $top parameter of 20. If more versions are required, specify the $top query option with the desired parameter.
    
    Parameters:
    url -
    includeDeleted - (default: false)
    
    Throws:
    
    InvalidOrMissingParameterException
  - stream
```
public ISFQuery<SFODataFeed<SFItem>> stream(java.net.URI url)
                                     throws InvalidOrMissingParameterException
```
    Get Stream Retrieves the versions of a given Stream. The ID parameter must be a StreamID, otherwise an empty list is returned. StreamID is a property of all Items, representing the "Stream", ie., the collection of all versions of a file. In contrast, an Item ID represents a single version of a file. For example, when users upload or modify an existing file, a new Item is created with the same StreamID. All default Item enumerations return only the latest version of a given stream. Use this method to retrieve previous versions of a given stream. This method carries a default OData $top parameter of 20. If more versions are required, specify the $top query option with the desired parameter.
    
    Parameters:
    url -
    
    Throws:
    
    InvalidOrMissingParameterException
  - byPath
```
public ISFQuery<SFItem> byPath(java.lang.String path)
                        throws InvalidOrMissingParameterException
```
    Get Item by Path Retrieves an item from its path. The path is of format /foldername/foldername/filename This call may redirect the client to another API provider, if the path contains a symbolic link.
    
    Parameters:
    path -
    
    Returns:
    An item identified by a path
    
    Throws:
    
    InvalidOrMissingParameterException
  - byPath
```
public ISFQuery<SFItem> byPath(java.net.URI url,
                      java.lang.String path)
                        throws InvalidOrMissingParameterException
```
    Get Item by relative Path from ID Retrieves an item from its path, relative to the provided ID. The path is of format /foldername/foldername/filename This call may redirect the client to another API provider, if the path contains a symbolic link.
    
    Parameters:
    url -
    path -
    
    Returns:
    An item identified by a path
    
    Throws:
    
    InvalidOrMissingParameterException
  - getParent
```
public ISFQuery<SFItem> getParent(java.net.URI url)
                           throws InvalidOrMissingParameterException
```
    Get Parent Item Retrieves the Parent navigation property of a single Item.
    
    Parameters:
    url -
    
    Returns:
    the Parent Item of the give object ID.
    
    Throws:
    
    InvalidOrMissingParameterException
  - getChildren
```
public ISFQuery<SFODataFeed<SFItem>> getChildren(java.net.URI url,
                                        java.lang.Boolean includeDeleted,
                                        SFSafeEnum<SFItemOrderingMode> orderingMode)
                                          throws InvalidOrMissingParameterException
```
    Get Children Handler for the Children navigation property of a given Item. A 302 redirection is returned if the folder is a SymbolicLink. The redirection will enumerate the children of the remote connector
    
    Parameters:
    url -
    includeDeleted - (default: false)
    orderingMode - (default: Default)
    
    Returns:
    the list of children under the given object ID
    
    Throws:
    
    InvalidOrMissingParameterException
  - getChildren
```
public ISFQuery<SFODataFeed<SFItem>> getChildren(java.net.URI url,
                                        java.lang.Boolean includeDeleted)
                                          throws InvalidOrMissingParameterException
```
    Get Children Handler for the Children navigation property of a given Item. A 302 redirection is returned if the folder is a SymbolicLink. The redirection will enumerate the children of the remote connector
    
    Parameters:
    url -
    includeDeleted - (default: false)
    
    Returns:
    the list of children under the given object ID
    
    Throws:
    
    InvalidOrMissingParameterException
  - getChildren
```
public ISFQuery<SFODataFeed<SFItem>> getChildren(java.net.URI url)
                                          throws InvalidOrMissingParameterException
```
    Get Children Handler for the Children navigation property of a given Item. A 302 redirection is returned if the folder is a SymbolicLink. The redirection will enumerate the children of the remote connector
    
    Parameters:
    url -
    
    Returns:
    the list of children under the given object ID
    
    Throws:
    
    InvalidOrMissingParameterException
  - getInfo
```
public ISFQuery<SFItemInfo> getInfo(java.net.URI url)
                             throws InvalidOrMissingParameterException
```
    Get Folder Access Info Returns the effective Access Controls for the current authenticated user for the selected folder - i.e., the resulting set of Access Controls for the Item/User context.This operation applies to Folders only, will return an error for other Item types.
    
    Parameters:
    url -
    
    Returns:
    The Folder Access Control Information
    
    Throws:
    
    InvalidOrMissingParameterException
  - download
```
public ISFQuery<java.io.InputStream> download(java.net.URI url,
                                     java.lang.Boolean redirect,
                                     java.lang.Boolean includeAllVersions)
                                       throws InvalidOrMissingParameterException
```
    Download Item Content Initiate the download operation for an item. It will return 302 redirection to the actual download link. For Folders, the download link will retrieve a ZIP archive with the contents of the Folder.
    
    Parameters:
    url -
    redirect - (default: true)
    includeAllVersions - (default: false)
    
    Returns:
    the download link for the provided item content.
    
    Throws:
    
    InvalidOrMissingParameterException
  - download
```
public ISFQuery<java.io.InputStream> download(java.net.URI url,
                                     java.lang.Boolean redirect)
                                       throws InvalidOrMissingParameterException
```
    Download Item Content Initiate the download operation for an item. It will return 302 redirection to the actual download link. For Folders, the download link will retrieve a ZIP archive with the contents of the Folder.
    
    Parameters:
    url -
    redirect - (default: true)
    
    Returns:
    the download link for the provided item content.
    
    Throws:
    
    InvalidOrMissingParameterException
  - download
```
public ISFQuery<java.io.InputStream> download(java.net.URI url)
                                       throws InvalidOrMissingParameterException
```
    Download Item Content Initiate the download operation for an item. It will return 302 redirection to the actual download link. For Folders, the download link will retrieve a ZIP archive with the contents of the Folder.
    
    Parameters:
    url -
    
    Returns:
    the download link for the provided item content.
    
    Throws:
    
    InvalidOrMissingParameterException
  - bulkDownload
```
public ISFQuery<java.io.InputStream> bulkDownload(java.net.URI parentUrl,
                                         java.util.ArrayList<java.lang.String> ids,
                                         java.lang.Boolean redirect)
                                           throws InvalidOrMissingParameterException
```
    Download Multiple Items ["id1","id2",...] Initiate the download operation for items. It will return 302 redirection to the actual download link.
    
    Parameters:
    parentUrl -
    ids -
    redirect - (default: true)
    
    Returns:
    the download link for the provided item content.
    
    Throws:
    
    InvalidOrMissingParameterException
  - bulkDownload
```
public ISFQuery<java.io.InputStream> bulkDownload(java.net.URI parentUrl,
                                         java.util.ArrayList<java.lang.String> ids)
                                           throws InvalidOrMissingParameterException
```
    Download Multiple Items ["id1","id2",...] Initiate the download operation for items. It will return 302 redirection to the actual download link.
    
    Parameters:
    parentUrl -
    ids -
    
    Returns:
    the download link for the provided item content.
    
    Throws:
    
    InvalidOrMissingParameterException
  - createFolder
```
public ISFQuery<SFFolder> createFolder(java.net.URI parentUrl,
                              SFFolder folder,
                              java.lang.Boolean overwrite,
                              java.lang.Boolean passthrough)
                                throws InvalidOrMissingParameterException
```
    Create Folder { "Name":"Folder Name", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" } } Creates a new Folder. The POST body must contain the serialized object. For top-level folders, use Items/Folder. The Zone object may only be provided for top-level folders. The Zone object must contain a zone ID.
    
    Parameters:
    parentUrl -
    folder -
    overwrite - (default: false)
    passthrough - (default: false)
    
    Returns:
    the new Folder
    
    Throws:
    
    InvalidOrMissingParameterException
  - createFolder
```
public ISFQuery<SFFolder> createFolder(java.net.URI parentUrl,
                              SFFolder folder,
                              java.lang.Boolean overwrite)
                                throws InvalidOrMissingParameterException
```
    Create Folder { "Name":"Folder Name", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" } } Creates a new Folder. The POST body must contain the serialized object. For top-level folders, use Items/Folder. The Zone object may only be provided for top-level folders. The Zone object must contain a zone ID.
    
    Parameters:
    parentUrl -
    folder -
    overwrite - (default: false)
    
    Returns:
    the new Folder
    
    Throws:
    
    InvalidOrMissingParameterException
  - createFolder
```
public ISFQuery<SFFolder> createFolder(java.net.URI parentUrl,
                              SFFolder folder)
                                throws InvalidOrMissingParameterException
```
    Create Folder { "Name":"Folder Name", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" } } Creates a new Folder. The POST body must contain the serialized object. For top-level folders, use Items/Folder. The Zone object may only be provided for top-level folders. The Zone object must contain a zone ID.
    
    Parameters:
    parentUrl -
    folder -
    
    Returns:
    the new Folder
    
    Throws:
    
    InvalidOrMissingParameterException
  - createNote
```
public ISFQuery<SFNote> createNote(java.net.URI parentUrl,
                          SFNote note)
                            throws InvalidOrMissingParameterException
```
    Create Note { "Name":"Note Name", "Description":"Description" } Creates a new Note.
    
    Parameters:
    parentUrl -
    note -
    
    Returns:
    the new Note
    
    Throws:
    
    InvalidOrMissingParameterException
  - createLink
```
public ISFQuery<SFLink> createLink(java.net.URI parentUrl,
                          SFLink link)
                            throws InvalidOrMissingParameterException
```
    Create Link { "Name":"Link Name", "Description":"Description", "Uri":"https://server/path" } Creates a new Link
    
    Parameters:
    parentUrl -
    link -
    
    Returns:
    the new Link
    
    Throws:
    
    InvalidOrMissingParameterException
  - createSymbolicLink
```
public ISFQuery<SFSymbolicLink> createSymbolicLink(java.net.URI parentUrl,
                                          SFSymbolicLink symlink,
                                          java.lang.Boolean overwrite)
                                            throws InvalidOrMissingParameterException
```
    Create SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } } Creates a Symbolic Link The body must contain either a "Link" parameter with a fully qualified URI; or use FileName + Zone to have sharefile.com attempt to convert the Connector path to an URI using a call to the Zone - using ShareFile Hash authentication mode. For active clients, it's recommended to make the convertion call to the Zone directly, using Items/ByPath=name, retriving the resulting URL, and calling this method with the Link parameter.SymbolicLinks must be created as top-level folders - i.e., this call requires the parent to be the Item(accountid) element.Zone defines the location of the SymbolicLink target - for example, for Network Shares connectors, the SymbolicLink will point to the StorageZone Controller that will serve the file browsing requests.The ConnectorGroup parameter indicates the kind of symbolic link - e.g., Network Share, or SharePoint.
    
    Parameters:
    parentUrl -
    symlink -
    overwrite - (default: false)
    
    Returns:
    the new SymbolicLink
    
    Throws:
    
    InvalidOrMissingParameterException
  - createSymbolicLink
```
public ISFQuery<SFSymbolicLink> createSymbolicLink(java.net.URI parentUrl,
                                          SFSymbolicLink symlink)
                                            throws InvalidOrMissingParameterException
```
    Create SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } } Creates a Symbolic Link The body must contain either a "Link" parameter with a fully qualified URI; or use FileName + Zone to have sharefile.com attempt to convert the Connector path to an URI using a call to the Zone - using ShareFile Hash authentication mode. For active clients, it's recommended to make the convertion call to the Zone directly, using Items/ByPath=name, retriving the resulting URL, and calling this method with the Link parameter.SymbolicLinks must be created as top-level folders - i.e., this call requires the parent to be the Item(accountid) element.Zone defines the location of the SymbolicLink target - for example, for Network Shares connectors, the SymbolicLink will point to the StorageZone Controller that will serve the file browsing requests.The ConnectorGroup parameter indicates the kind of symbolic link - e.g., Network Share, or SharePoint.
    
    Parameters:
    parentUrl -
    symlink -
    
    Returns:
    the new SymbolicLink
    
    Throws:
    
    InvalidOrMissingParameterException
  - createChildrenByConnectorGroup
```
public ISFQuery<SFSymbolicLink> createChildrenByConnectorGroup(java.net.URI url,
                                                      SFSymbolicLink symlink,
                                                      java.lang.Boolean overwrite)
                                                        throws InvalidOrMissingParameterException
```
    Creates SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Link":"https://server/provider/version/Items(id)", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } }
    
    Parameters:
    url -
    symlink -
    overwrite - (default: false)
    
    Returns:
    the new SymbolicLink
    
    Throws:
    
    InvalidOrMissingParameterException
  - createChildrenByConnectorGroup
```
public ISFQuery<SFSymbolicLink> createChildrenByConnectorGroup(java.net.URI url,
                                                      SFSymbolicLink symlink)
                                                        throws InvalidOrMissingParameterException
```
    Creates SymbolicLink { "Name":"RemoteFileName", "Description":"Description", "Link":"https://server/provider/version/Items(id)", "Zone":{ "Id":"z014766e-8e96-4615-86aa-57132a69843c" }, "ConnectorGroup": { "Id":"1" } }
    
    Parameters:
    url -
    symlink -
    
    Returns:
    the new SymbolicLink
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item,
                      java.lang.String batchid,
                      java.lang.Long batchSizeInBytes,
                      java.lang.Boolean forceSync,
                      java.lang.Boolean scheduleAsync,
                      java.lang.Boolean resolveFolderNameConflict,
                      java.lang.Boolean notify)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    forceSync - (default: false)
    notify - (default: false)
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item,
                      java.lang.String batchid,
                      java.lang.Long batchSizeInBytes,
                      java.lang.Boolean forceSync,
                      java.lang.Boolean scheduleAsync,
                      java.lang.Boolean resolveFolderNameConflict)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    forceSync - (default: false)
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item,
                      java.lang.String batchid,
                      java.lang.Long batchSizeInBytes,
                      java.lang.Boolean forceSync,
                      java.lang.Boolean scheduleAsync)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    forceSync - (default: false)
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item,
                      java.lang.String batchid,
                      java.lang.Long batchSizeInBytes,
                      java.lang.Boolean forceSync)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    forceSync - (default: false)
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item,
                      java.lang.String batchid,
                      java.lang.Long batchSizeInBytes)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item,
                      java.lang.String batchid)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - update
```
public ISFQuery<SFItem> update(java.net.URI url,
                      SFItem item)
                        throws InvalidOrMissingParameterException
```
    Update Item { "Name":"Name", "FileName":"FileName", "Description":"Description", "ExpirationDate": "date", "Parent": { "Id": "parentid" }, "Zone": { "Id": "zoneid" } } Updates an Item object. Please note that for a Folder, the Name and FileName properties must be consistent. If a new Name is provided, the FileName will also be updated with the new name, and viceversa. If both Name and FileName are provided, FileName is disregarded and Name will be used to update both properties.
    
    Parameters:
    url -
    item -
    
    Returns:
    A modified Item object. If the item Zone or Parent Zone is modified, then this method will return an Asynchronous operation record instead. Note: the parameters listed in the body of the request are the only parameters that can be updated through this call.
    
    Throws:
    
    InvalidOrMissingParameterException
  - updateLink
```
public ISFQuery<SFLink> updateLink(java.lang.String id,
                          SFLink link,
                          java.lang.Boolean notify)
                            throws InvalidOrMissingParameterException
```
    Update Link { "Name":"Name", "Uri":"https://server/path", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Link object
    
    Parameters:
    id -
    link -
    notify - (default: false)
    
    Returns:
    A modified Link object
    
    Throws:
    
    InvalidOrMissingParameterException
  - updateLink
```
public ISFQuery<SFLink> updateLink(java.lang.String id,
                          SFLink link)
                            throws InvalidOrMissingParameterException
```
    Update Link { "Name":"Name", "Uri":"https://server/path", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Link object
    
    Parameters:
    id -
    link -
    
    Returns:
    A modified Link object
    
    Throws:
    
    InvalidOrMissingParameterException
  - updateNote
```
public ISFQuery<SFNote> updateNote(java.lang.String id,
                          SFNote note,
                          java.lang.Boolean notify)
                            throws InvalidOrMissingParameterException
```
    Update Note { "Name":"Name", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Note object
    
    Parameters:
    id -
    note -
    notify - (default: false)
    
    Returns:
    The modified Note object
    
    Throws:
    
    InvalidOrMissingParameterException
  - updateNote
```
public ISFQuery<SFNote> updateNote(java.lang.String id,
                          SFNote note)
                            throws InvalidOrMissingParameterException
```
    Update Note { "Name":"Name", "Description":"Description", "Parent": { "Id": "parentid" }, } Updates a Note object
    
    Parameters:
    id -
    note -
    
    Returns:
    The modified Note object
    
    Throws:
    
    InvalidOrMissingParameterException
  - updateSymbolicLink
```
public ISFQuery<SFSymbolicLink> updateSymbolicLink(java.lang.String id,
                                          SFSymbolicLink symlink)
                                            throws InvalidOrMissingParameterException
```
    Update SymbolicLink { "Name":"Name", "Description":"Description", "Link": "https://server/path" } Updates a Symbolic Link object
    
    Parameters:
    id -
    symlink -
    
    Returns:
    The modified SymbolicLink object
    
    Throws:
    
    InvalidOrMissingParameterException
  - delete
```
public ISFQuery delete(java.net.URI url,
              java.lang.Boolean singleversion,
              java.lang.Boolean forceSync)
                throws InvalidOrMissingParameterException
```
    Delete Item Removes an item
    
    Parameters:
    url -
    singleversion - (default: false)
    forceSync - (default: false)
    
    Throws:
    
    InvalidOrMissingParameterException
  - delete
```
public ISFQuery delete(java.net.URI url,
              java.lang.Boolean singleversion)
                throws InvalidOrMissingParameterException
```
    Delete Item Removes an item
    
    Parameters:
    url -
    singleversion - (default: false)
    
    Throws:
    
    InvalidOrMissingParameterException
  - delete
```
public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException
```
    Delete Item Removes an item
    
    Parameters:
    url -
    
    Throws:
    
    InvalidOrMissingParameterException
  - bulkDelete
```
public ISFQuery bulkDelete(java.net.URI parentUrl,
                  java.util.ArrayList<java.lang.String> ids,
                  java.lang.Boolean forceSync,
                  java.lang.Boolean deletePermanently)
                    throws InvalidOrMissingParameterException
```
    Delete Multiple Items ["id1","id2",...] All items in bulk delete must be children of the same parent, identified in the URI
    
    Parameters:
    parentUrl -
    ids -
    forceSync - (default: false)
    deletePermanently - (default: false)
    
    Throws:
    
    InvalidOrMissingParameterException
  - bulkDelete
```
public ISFQuery bulkDelete(java.net.URI parentUrl,
                  java.util.ArrayList<java.lang.String> ids,
                  java.lang.Boolean forceSync)
                    throws InvalidOrMissingParameterException
```
    Delete Multiple Items ["id1","id2",...] All items in bulk delete must be children of the same parent, identified in the URI
    
    Parameters:
    parentUrl -
    ids -
    forceSync - (default: false)
    
    Throws:
    
    InvalidOrMissingParameterException
  - bulkDelete
```
public ISFQuery bulkDelete(java.net.URI parentUrl,
                  java.util.ArrayList<java.lang.String> ids)
                    throws InvalidOrMissingParameterException
```
    Delete Multiple Items ["id1","id2",...] All items in bulk delete must be children of the same parent, identified in the URI
    
    Parameters:
    parentUrl -
    ids -
    
    Throws:
    
    InvalidOrMissingParameterException
  - getThumbnail
```
public ISFQuery<java.io.InputStream> getThumbnail(java.net.URI url,
                                         java.lang.Integer size,
                                         java.lang.Boolean redirect)
                                           throws InvalidOrMissingParameterException
```
    Get Thumbnail Retrieve a thumbnail link from the specified Item.
    
    Parameters:
    url -
    size - (default: 75)
    redirect - (default: false)
    
    Returns:
    A 302 redirection to the Thumbnail link
    
    Throws:
    
    InvalidOrMissingParameterException
  - getThumbnail
```
public ISFQuery<java.io.InputStream> getThumbnail(java.net.URI url,
                                         java.lang.Integer size)
                                           throws InvalidOrMissingParameterException
```
    Get Thumbnail Retrieve a thumbnail link from the specified Item.
    
    Parameters:
    url -
    size - (default: 75)
    
    Returns:
    A 302 redirection to the Thumbnail link
    
    Throws:
    
    InvalidOrMissingParameterException
  - getThumbnail
```
public ISFQuery<java.io.InputStream> getThumbnail(java.net.URI url)
                                           throws InvalidOrMissingParameterException
```
    Get Thumbnail Retrieve a thumbnail link from the specified Item.
    
    Parameters:
    url -
    
    Returns:
    A 302 redirection to the Thumbnail link
    
    Throws:
    
    InvalidOrMissingParameterException
  - getBreadcrumbs
```
public ISFQuery<SFODataFeed<SFItem>> getBreadcrumbs(java.net.URI url,
                                           java.lang.String path)
                                             throws InvalidOrMissingParameterException
```
    Get Breadcrumbs Retrieves the path from an item from the root. The return list is a Feed of Items, with the top-level folder at the first position. If this item is in a Connection path, the breadcrumbs may contain URL reference back to the parent account - and the Item in the feed will contain just the URL reference.
    
    Parameters:
    url -
    path - (default: null)
    
    Returns:
    A feed containing the path of folders from the specified root to the item, in order
    
    Throws:
    
    InvalidOrMissingParameterException
  - getBreadcrumbs
```
public ISFQuery<SFODataFeed<SFItem>> getBreadcrumbs(java.net.URI url)
                                             throws InvalidOrMissingParameterException
```
    Get Breadcrumbs Retrieves the path from an item from the root. The return list is a Feed of Items, with the top-level folder at the first position. If this item is in a Connection path, the breadcrumbs may contain URL reference back to the parent account - and the Item in the feed will contain just the URL reference.
    
    Parameters:
    url -
    
    Returns:
    A feed containing the path of folders from the specified root to the item, in order
    
    Throws:
    
    InvalidOrMissingParameterException
  - copy
```
public ISFQuery<SFItem> copy(java.net.URI url,
                    java.lang.String targetid,
                    java.lang.Boolean overwrite)
                      throws InvalidOrMissingParameterException
```
    Copy Item Copies an item to a new target Folder. If the target folder is in another zone, the operation will return an AsyncOperation record instead. Clients may query the /AsyncOperation Entity to determine operation progress and result.
    
    Parameters:
    url -
    targetid -
    overwrite - (default: false)
    
    Returns:
    the modified source object
    
    Throws:
    
    InvalidOrMissingParameterException
  - copy
```
public ISFQuery<SFItem> copy(java.net.URI url,
                    java.lang.String targetid)
                      throws InvalidOrMissingParameterException
```
    Copy Item Copies an item to a new target Folder. If the target folder is in another zone, the operation will return an AsyncOperation record instead. Clients may query the /AsyncOperation Entity to determine operation progress and result.
    
    Parameters:
    url -
    targetid -
    
    Returns:
    the modified source object
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify,
                                     java.util.Date clientCreatedDateUTC,
                                     java.util.Date clientModifiedDateUTC,
                                     java.lang.Integer expirationDays)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    threadCount - (default: 4)
    responseFormat - (default: "json")
    notify - (default: false)
    clientCreatedDateUTC - (default: null)
    clientModifiedDateUTC - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify,
                                     java.util.Date clientCreatedDateUTC,
                                     java.util.Date clientModifiedDateUTC)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    threadCount - (default: 4)
    responseFormat - (default: "json")
    notify - (default: false)
    clientCreatedDateUTC - (default: null)
    clientModifiedDateUTC - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify,
                                     java.util.Date clientCreatedDateUTC)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    threadCount - (default: 4)
    responseFormat - (default: "json")
    notify - (default: false)
    clientCreatedDateUTC - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    threadCount - (default: 4)
    responseFormat - (default: "json")
    notify - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    threadCount - (default: 4)
    responseFormat - (default: "json")
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    threadCount - (default: 4)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    opid - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    sendGuid - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    isSend - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    details - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    title - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    overwrite - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    tool - (default: "apiv3")
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    unzip - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    startOver - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    canResume - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    batchLast - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    batchId - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    fileSize - (default: 0)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    fileName - (default: null)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    raw - (default: false)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    method - (default: Standard)
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload
```
public ISFQuery<SFUploadSpecification> upload(java.net.URI url)
                                       throws InvalidOrMissingParameterException
```
    Upload File POST https://account.sf-api.com/sf/v3/Items(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Folder. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and canResume parameters passed to the upload call. The Method determines how the URLs must be called. There are two different URLs for upload: /sf/v3/Items(id)/Upload accepts parameters through the URL query string, while /sf/v3/Items(id)/Upload2 uses the HTTP POST message body. If using 'Upload2', the parameters must be capitalized. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. For each call, the client must append the parameters index, byteOffset and hash to the ChunkUri address. Index is a sequential number (zero-based) identifying the position of the chunk relative to others; byteOffset represents how many bytes precede the chunk relative to the beginning of the file; and hash contains the MD5 hash of the chunk. The last HTTP POST must also include the parameters finish=true and filehash=[MD5 hash of entire file]. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing chunks in parallel. Clients must append index, byteOffset and hash to the end of ChunkUri, as explained for Streamed uploads. After all chunks are sent, the client must call the FinishUri provided in the Upload Specification response. If using the Threaded Uploader, the client can add the parameter fmt=json to the ChunkUri to retrieve the Item ID of the file after the upload is completed. For all uploaders, the contents of the POST Body can either be "raw" (if the parameter raw=true is provided to the Uploader) or use MIME multi-part form encoding otherwise. Raw uploads provide the chunk content directly in the POST body and the Content-Length header specifies the size. Multi-part form encoding requires passing the file as a Form parameter named "Filedata". For Streamed and Threaded uploads, if the CanResume parameter is specified in the call to Upload, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash may be populated in the Upload Specification response. If they are, it indicates that the server has identified a partial upload with that specification and is ready to resume the upload process. The client can verify the file has not been modified based on the value of ResumeFileHash, then continue issuing calls to the ChunkUri starting from the position represented by the values of ResumeIndex and ResumeOffset. If the client decides to restart the upload, it should simply ignore the resume fields and send chunks starting from Index 0. For all upload methods, successful HTTP POST calls to ChunkUri and FinishUri will return response code 200 with either no Content Body or with a Body of 'OK'. The response code for failed calls can be 401, indicating authentication is required; 4xx/5xx, indicating some kind of error; or 200 with Content Body of format 'ERROR:[message]'.
    
    Parameters:
    url -
    
    Returns:
    an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.
    
    Throws:
    
    InvalidOrMissingParameterException
  - upload2
```
public ISFQuery<SFUploadSpecification> upload2(java.net.URI url,
                                      SFUploadRequestParams uploadParams,
                                      java.lang.Integer expirationDays)
                                        throws InvalidOrMissingParameterException
```
    Throws:
    
    InvalidOrMissingParameterException
  - upload2
```
public ISFQuery<SFUploadSpecification> upload2(java.net.URI url,
                                      SFUploadRequestParams uploadParams)
                                        throws InvalidOrMissingParameterException
```
    Throws:
    
    InvalidOrMissingParameterException
  - checkIn
```
public ISFQuery checkIn(java.net.URI url,
               java.lang.String message)
                 throws InvalidOrMissingParameterException
```
    Unlock File Unlock a locked file. This operation is only implemented in Sharepoint providers (/sp)
    
    Parameters:
    url -
    message - (default: null)
    
    Throws:
    
    InvalidOrMissingParameterException
  - checkIn
```
public ISFQuery checkIn(java.net.URI url)
                 throws InvalidOrMissingParameterException
```
    Unlock File Unlock a locked file. This operation is only implemented in Sharepoint providers (/sp)
    
    Parameters:
    url -
    
    Throws:
    
    InvalidOrMissingParameterException
  - checkOut
```
public ISFQuery checkOut(java.net.URI url)
                  throws InvalidOrMissingParameterException
```
    Throws:
    
    InvalidOrMissingParameterException
  - discardCheckOut
```
public ISFQuery discardCheckOut(java.net.URI url)
                         throws InvalidOrMissingParameterException
```
    Throws:
    
    InvalidOrMissingParameterException
  - search
```
public ISFQuery<SFSearchResults> search(java.lang.String query,
                               java.lang.Integer maxResults,
                               java.lang.Integer skip,
                               java.lang.Boolean homeFolderOnly)
                                 throws InvalidOrMissingParameterException
```
    Search Search for Items matching the criteria of the query parameter
    
    Parameters:
    query -
    maxResults - (default: 50)
    skip - (default: 0)
    homeFolderOnly - (default: false)
    
    Returns:
    SearchResults
    
    Throws:
    
    InvalidOrMissingParameterException
  - search
```
public ISFQuery<SFSearchResults> search(java.lang.String query,
                               java.lang.Integer maxResults,
                               java.lang.Integer skip)
                                 throws InvalidOrMissingParameterException
```
    Search Search for Items matching the criteria of the query parameter
    
    Parameters:
    query -
    maxResults - (default: 50)
    skip - (default: 0)
    
    Returns:
    SearchResults
    
    Throws:
    
    InvalidOrMissingParameterException
  - search
```
public ISFQuery<SFSearchResults> search(java.lang.String query,
                               java.lang.Integer maxResults)
                                 throws InvalidOrMissingParameterException
```
    Search Search for Items matching the criteria of the query parameter
    
    Parameters:
    query -
    maxResults - (default: 50)
    
    Returns:
    SearchResults
    
    Throws:
    
    InvalidOrMissingParameterException
  - search
```
public ISFQuery<SFSearchResults> search(java.lang.String query)
                                 throws InvalidOrMissingParameterException
```
    Search Search for Items matching the criteria of the query parameter
    
    Parameters:
    query -
    
    Returns:
    SearchResults
    
    Throws:
    
    InvalidOrMissingParameterException
  - advancedSimpleSearch
```
public ISFQuery<SFAdvancedSearchResults> advancedSimpleSearch(SFSimpleSearchQuery simpleSearchQuery)
                                                       throws InvalidOrMissingParameterException
```
    Advanced Simple Search { "Query":{ "ItemType":"", "ParentID":"", "CreatorID":"", "SearchQuery":"", "CreateStartDate":"", "CreateEndDate":"", "ItemNameOnly":false }, "Paging":{ "PageNumber":1, (Deprecated) "PageSize":10, (Deprecated) "Count": 50 "Skip": 0 }, "Sort":{ "SortBy":"", "Ascending":false, }, "TimeoutInSeconds":10 } Search for Items matching the criteria of the query parameter
    
    Parameters:
    simpleSearchQuery -
    
    Returns:
    AdvancedSearchResults
    
    Throws:
    
    InvalidOrMissingParameterException
  - advancedSearch
```
public ISFQuery<SFAdvancedSearchResults> advancedSearch(SFSearchQuery searchQuery)
                                                 throws InvalidOrMissingParameterException
```
    Advanced Search { "Query":{ "ItemTypes":["type1", "type2", ...], "ParentID":["id1", "id2", ...], "CreatorID":["id1", "id2", ...], "SearchQuery":"", "CreateStartDate":"", "CreateEndDate":"", "ItemNameOnly":false }, "Paging":{ "PageNumber":1, (deprecated) "PageSize":10, (deprecated) "Count":50, (default value) "Skip":0, (default value) }, "Sort":{ "SortBy":"", "Ascending":false, }, "TimeoutInSeconds":10 } Search for Items matching the criteria of the query parameter
    
    Parameters:
    searchQuery -
    
    Returns:
    AdvancedSearchResults
    
    Throws:
    
    InvalidOrMissingParameterException
  - webView
```
public ISFQuery<SFRedirection> webView(java.net.URI url)
                                throws InvalidOrMissingParameterException
```
    Get Web Preview Link Redirects the caller to the Web Edit application for the selected item.
    
    Parameters:
    url -
    
    Returns:
    A redirection message to the Web Edit app for this item. It returns 404 (Not Found) if the Web Preview app doesn't support the file type.
    
    Throws:
    
    InvalidOrMissingParameterException
  - getProtocolLinks
```
public ISFQuery<SFODataFeed<SFItemProtocolLink>> getProtocolLinks(java.net.URI url,
                                                         SFSafeEnum<SFPreviewPlatform> platform)
                                                           throws InvalidOrMissingParameterException
```
    Get List of Item Protocol Links
    
    Parameters:
    url -
    
    Returns:
    A list of protocol links depending on the input parameter 'platform', 404 (Not Found) if not supported by the item
    
    Throws:
    
    InvalidOrMissingParameterException
  - getRedirection
```
public ISFQuery<SFRedirection> getRedirection(java.net.URI url)
                                       throws InvalidOrMissingParameterException
```
    Get Redirection endpoint Information Returns the redirection endpoint for this Item.This operation applies to Folders and SymbolicLinks only, will return an error for other Item types.
    
    Parameters:
    url -
    
    Returns:
    The Redirection endpoint Information
    
    Throws:
    
    InvalidOrMissingParameterException
  - getDeletedChildren
```
public ISFQuery<SFODataFeed<SFItem>> getDeletedChildren(java.net.URI url,
                                               java.lang.String id)
                                                 throws InvalidOrMissingParameterException
```
    Get a collection of recoverable/deleted items in a folder
    
    Parameters:
    url -
    
    Throws:
    
    InvalidOrMissingParameterException
  - getUserDeletedItems
```
public ISFQuery<SFODataFeed<SFItem>> getUserDeletedItems(java.lang.String userid,
                                                java.lang.String zone)
                                                  throws InvalidOrMissingParameterException
```
    Throws:
    
    InvalidOrMissingParameterException
  - getUserDeletedItems
```
public ISFQuery<SFODataFeed<SFItem>> getUserDeletedItems(java.lang.String userid)
                                                  throws InvalidOrMissingParameterException
```
    Throws:
    
    InvalidOrMissingParameterException
  - getUserDeletedItems
```
public ISFQuery<SFODataFeed<SFItem>> getUserDeletedItems()
```
  - bulkRestore
```
public ISFQuery bulkRestore(java.util.ArrayList<java.lang.String> ids)
                     throws InvalidOrMissingParameterException
```
    Restore expired items to their original locations
    
    Parameters:
    ids -
    
    Throws:
    
    InvalidOrMissingParameterException
  - bulkDeletePermanently
```
public ISFQuery bulkDeletePermanently(java.util.ArrayList<java.lang.String> ids)
                               throws InvalidOrMissingParameterException
```
    Permanently delete multiple items
    
    Parameters:
    ids -
    
    Throws:
    
    InvalidOrMissingParameterException
  - webAppLink
```
public ISFQuery<SFRedirection> webAppLink(java.net.URI url)
                                   throws InvalidOrMissingParameterException
```
    Create a one-time use login Uri for the Web App.
    
    Parameters:
    url -
    
    Returns:
    Redirection populated with link in Uri field
    
    Throws:
    
    InvalidOrMissingParameterException
  - removeTemplateAssociation
```
public ISFQuery removeTemplateAssociation(java.net.URI url,
                                 java.lang.String id)
                                   throws InvalidOrMissingParameterException
```
    Remove folder template association from folder
    
    Parameters:
    url -
    
    Throws:
    
    InvalidOrMissingParameterException
  - checkTemplateOwned
```
public ISFQuery checkTemplateOwned(java.net.URI url,
                          java.lang.String id)
                            throws InvalidOrMissingParameterException
```
    Check if template is already part of an existing template structure
    
    Parameters:
    url -
    
    Throws:
    
    InvalidOrMissingParameterException
  - checkVersioningViolation
```
public ISFQuery checkVersioningViolation(java.net.URI url,
                                java.lang.String id,
                                java.lang.Integer newMaxVersions)
                                  throws InvalidOrMissingParameterException
```
    Check if a versioning change would result in file deletions
    
    Parameters:
    url -
    newMaxVersions -
    
    Throws:
    
    InvalidOrMissingParameterException

Class SFItemsEntity

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

Constructor Summary

Method Summary

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

Methods inherited from class java.lang.Object

Constructor Detail

SFItemsEntity

Method Detail

get

get

get

get

get

get

getChildrenByConnectorGroup

stream

stream

byPath

byPath

getParent

getChildren

getChildren

getChildren

getInfo

download

download

download

bulkDownload

bulkDownload

createFolder

createFolder

createFolder

createNote

createLink

createSymbolicLink

createSymbolicLink

createChildrenByConnectorGroup

createChildrenByConnectorGroup

update

update

update

update

update

update

update

updateLink

updateLink

updateNote

updateNote

updateSymbolicLink

delete

delete

delete

bulkDelete

bulkDelete

bulkDelete

getThumbnail

getThumbnail

getThumbnail

getBreadcrumbs

getBreadcrumbs

copy

copy

upload

upload

upload

upload

upload

upload

upload

upload

upload

upload

upload

upload

upload

upload

upload