Sharepoint Client GET Service
Sharepoint Client GET Service is used to retrieve a specific file from Sharepoint site.
The following table provides an overview of the Sharepoint Client GET Service:
| Parameters | Description |
|---|---|
session_token |
Session token is returned from the Begin Session service response. It is a Sterling B2B Integrator specific session. |
documentlibrary |
Name of the document library. Optional. Note: If
documentlibrary is not set in GET Service,
value from the Begin Session or
Adapter Configuration will be used.
The precedence order of documentlibrary is
Individual Services >
Begin Session > Adapter
Configuration. If the value is not set in any of
the mentioned fields, then the default
documentlibrary for site (Shared
Documents) will be used. |
foldername |
Name of the directory from where you want to get a file. Optional. If you do not provide a folder name, it will be searched from the document library. |
remotefilename |
Name of the file to be retrieved from a specific document
library. Optional. Only a single file can be downloaded through this
parameter. Note:
remotefilename should begin
from the path after
documentlibrary. |
remotefilelist |
It is a comma separated list of files present in a document library. It is used for getting the list of files from Sharepoint server. Optional. |
filepattern
|
This is a valid regular expression supported by Java 8. Optional
and only valid for leaf file name. Note:
filepattern
is applicable either to foldername or
documentlibrary. |
Tip: You can only use one of the following parameters at once as
they are mutually exclusive:
foldernameremotefilenameremotefilelist
Note: When you use GET service on a document library, then it will get
all the files from the given document library and its sub-folders.