File management
Copy file
Copies a file from a Document Library to another (or the same) Document Library at the same SharePoint site.
Parameters
Parameter
Description
Source Document Library Name
Name of source Document Library in SharePoint to copy file from
Source filename
Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
Destination Document Library Name
Name of target Document Library in SharePoint to copy file to
Destination filename
Name of file in destination Document Library
Overwrite
Specifies whether to overwrite destination file if it already exists
Output
Record with information about whether operation failed or not.
Member
Description
HasFailed
Whether operation has failed or not
ErrorMessage
A description of the failure, if any
ErrorCode
An error code related to operation failure. Is 0 if no failure occured
Errors
Error code
Description
1000
Unspecified error.
1000001
User is not authorized to perform operation.
Delete file
Deletes a file in the Document Library. If the file does not exist, the operation is considered succesful.
Parameters
Parameter
Description
Document Library Name
Name of Document Library in SharePoint (not id)
Filename
Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
Output
Record with information about whether operation failed or not.
Member
Description
HasFailed
Whether operation has failed or not
ErrorMessage
A description of the failure, if any
ErrorCode
An error code related to operation failure. Is 0 if no failure occured
Errors
Error code
Description
1000
Unspecified error.
1000001
User is not authorized to perform operation.
Get file information
Gets information about a file provided as a releative url, example: '/subsite1/Shared Documents/file.doc'
Parameters
Parameter
Description
Document Library Name
Name of Document Library in SharePoint (not id)
Filename
Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
Output
Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member
Member
Description
HasFailed
Whether operation has failed or not
ErrorMessage
A description of the failure, if any
ErrorCode
An error code related to operation failure. Is 0 if no failure occured
Results
Record variable containing the results of operation
Structure of Results Results
Author
Id
LoginName
Email
Title
IsSiteAdmin
CheckedOutByUser
Id
LoginName
Email
Title
IsSiteAdmin
LockedByUser
Id
LoginName
Email
Title
IsSiteAdmin
ModifiedBy
Id
LoginName
Email
Title
IsSiteAdmin
CheckInComment
CheckOutType
ContentTag
CustomizedPageStatus
ETag
Exists
Length
Level
MajorVersion
MinorVersion
Name
ServerRelativeUrl
TimeCreated
TimeLastModified
Title
UIVersion
UIVersionLabel
Errors
Error code
Description
1000
Unspecified error.
List files
Lists all files at the root of a Document Library
Parameters
Parameter
Description
Document Library Name
Name of Document Library in SharePoint (not id)
Populate user members
Specifies whether to populate members that relates to SharePoint users, e.g. Author.
Output
Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member
Member
Description
HasFailed
Whether operation has failed or not
ErrorMessage
A description of the failure, if any
ErrorCode
An error code related to operation failure. Is 0 if no failure occured
Results
Table variable containing the results of operation
Structure of Results Results
Author
Id
LoginName
Email
Title
IsSiteAdmin
CheckedOutByUser
Id
LoginName
Email
Title
IsSiteAdmin
LockedByUser
Id
LoginName
Email
Title
IsSiteAdmin
ModifiedBy
Id
LoginName
Email
Title
IsSiteAdmin
CheckInComment
CheckOutType
ContentTag
CustomizedPageStatus
ETag
Exists
Length
Level
MajorVersion
MinorVersion
Name
ServerRelativeUrl
TimeCreated
TimeLastModified
Title
UIVersion
UIVersionLabel
Errors
Error code
Description
1000
Unspecified error.
Move file
Moves a file from a Document Library to another (or the same) Document Library at the same SharePoint site.
Parameters
Parameter
Description
Source Document Library Name
Name of source Document Library in SharePoint to move file from
Source filename
Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
Destination Document Library Name
Name of target Document Library in SharePoint to move file to
Destination filename
Name of file in destination Document Library
Move operations
Specifies move options.
Output
Record with information about whether operation failed or not.
Member
Description
HasFailed
Whether operation has failed or not
ErrorMessage
A description of the failure, if any
ErrorCode
An error code related to operation failure. Is 0 if no failure occured
Errors
Error code
Description
1000
Unspecified error.
1000001
User is not authorized to perform operation.
Update file property
Parameters
Parameter
Description
Server relative url
An url relative to server, e.g. "/subsite/doclib/folder/file.txt".
Field name
Name of field or column
New value
The new value to set on field
Output
Record with information about whether operation failed or not.
Member
Description
HasFailed
Whether operation has failed or not
ErrorMessage
A description of the failure, if any
ErrorCode
An error code related to operation failure. Is 0 if no failure occured
Errors
Error code
Description
1000
Unspecified error.
Last updated