SharePoint - Get List Items
Declaration
<AMSHAREPOINT ACTIVITY="get_list_items" SITE="text" VERSION="text (options)" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" DOMAIN="text" IGNOREINVALIDCERTIFICATE="YES/NO" CERTIFICATE="text" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" TIMEOUT="number" TIMEOUT="number" LIST="text" RESULTDATASET="text" />
Description: Retrieves information with regards to specified list item(s) and populates a dataset with results. This activity also allows you to further define data to retrieve using the Collaborative Application Markup Language (CAML) query feature, supported in SharePoint 2010. CAML is an XML-based query language that helps you query, build and customize Web sites based on Windows SharePoint Services. You can assign CAML query strings, for example, to the Query property of several classes in the server and client object models to return data, or to method parameters of the Lists Web Service to work remotely with data.
Practical Usage
Used to get information regarding SharePoint list items.
Connection Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Connection |
--- |
--- |
--- |
--- |
Indicates where this activity's SharePoint credentials should originate from. This is a visual parameter used only during design-time, thus, contains no properties or markups. The available options are:
|
Session |
Text |
Yes if Connection set to Session |
SharePoint Session1 |
SESSION="mySession1" |
The name of the session to associate with this activity. This parameter is active only if the Connection parameter above is set to Session. If the Connection parameter is set to Host, this parameter is ignored and the remainder of the parameters specified below become active. |
Version |
Text (options) |
Yes if Connection set to Host |
SharePoint 2010 |
|
The SharePoint version to associate with this activity. The available options are:
NOTE: Some SharePoint activities are only supported in SharePoint 2010 or newer. |
Site |
Text |
Yes if Connection set to Host |
(Empty) |
SITE="http://myServer/tech" |
The SharePoint site to access. A SharePoint site is a collection of pages, site templates, lists, and libraries configured for the purpose of achieving an express goal. |
Authentication type |
Text (options) |
No |
Default |
|
The method of authentication to utilize. Authentication types vary depending on the SharePoint version. Different parameters become active depending on which authentication method is selected. Below lists available authentication methods and their compatibility.
|
Username |
Text |
Yes |
(Empty) |
USERNAME="theUserName" |
A valid SharePoint username. This parameter may or may not be active depending on which option is selected under the Authentication type parameter. |
Password |
Text |
Yes |
(Empty) |
PASSWORD="encryptedText" |
A valid SharePoint password to authenticate the username entered above. This parameter may or may not be active depending on which option is selected under the Authentication type parameter. |
Domain |
Text |
Yes |
(Empty) |
DOMAIN="myServer" |
The domain that the user belongs to. This parameter may or may not be active depending on which option is selected under the Authentication type parameter. |
Certificate |
Text |
No |
(Empty) |
CERTIFICATE="C:\Temp\file.cer" |
The (DER encoded) certificate to use for SharePoint authentication. This parameter may or may not be active depending on which option is selected under the Authentication type parameter. |
Ignore invalid certificate |
Yes/No |
No |
No |
IGNOREINVALIDCERTIFICATE="yes" |
If set to YES, specifies that invalid server certificates that are detected will be automatically ignored. Set to NO by default. |
Timeout (seconds) |
Number |
No |
600 |
TIMEOUT="500" |
The total number of seconds allowed to connect to the SharePoint server before a timeout error is generated. The default value is 600 seconds. |
Proxy type |
Text (options) |
No |
Default |
|
The type of proxy required for SharePoint connections that pass through a proxy server. The available options are:
|
Use authentication |
--- |
--- |
--- |
--- |
If enabled, specifies that proxy authentication is required, enabling authentication-based parameters (disabled by default). This is a design-time parameter, therefore, contains no properties or markups. It is active only if the Proxy type parameter is set to HTTP. |
Proxy server |
Text |
No |
(Empty) |
PROXYSERVER="proxy.host.com" |
The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. |
Proxy username |
Text |
No |
(Empty) |
PROXYUSERNAME=username |
The proxy username to authenticate with. This parameter is available only if the Use Authentication parameter is enabled. |
Proxy password |
Text |
No |
(Empty) |
PROXYPASSWORD="encrypted" |
The proxy password to authenticate with. This parameter is available only if the Use Authentication parameter is enabled. |
Proxy port |
Number |
No |
808 |
PROXYPORT="8080" |
The port that should be used to connect to the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 808. |
List Item Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
List Title |
Text |
Yes |
(Empty) |
LIST="Calendar" |
The displayed title for the list. Click the folder icon to use the SharePoint Browser, a user-friendly interface that enables connection to a SharePoint site to view or select specific contents. |
CAML Query |
Text |
No |
(Empty) |
LIBRARY="TEXT" |
The CAML Query to run. NOTE: This option is only supported in SharePoint 2010. |
Create and populate dataset with SharePoint list (s) information. |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the list items that are queried. See Datasets below for more details. |
Datasets
A dataset is a multiple column, multiple row container object where every column represents a particular variable, and each row corresponds to a given member of the dataset in question. This activity creates and populates a dataset containing specific fields (rows) in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned was theDataset).
Name |
Type |
Return Value |
---|---|---|
theDataset.Expires |
Date |
The expiration date/time of the item. |
theDataset.Body |
Text |
The body of the item. |
theDataset.Level |
Text |
The level of publication for the item. |
theDataset.MetaInfo |
Text |
The unique ID of the list. |
theDataset.ProgID |
Text |
The Program identifier for the item. |
theDataset.SortBehavior |
Text |
The type of this item when sorting within a view. |
theDataset.FileRef |
Text |
The file that is represented by the item from a document library. |
theDataset.GUID |
Text |
The value that is contained by the field identified by the specified GUID. |
theDataset.ModerationComments |
Text |
Content Approval information for the item, particularly any comments. |
theDataset.ModerationStatus |
Text |
Content Approval information for the item, particularly the status. |
theDataset.Attachments |
Text |
A collection of attachments that are associated with the item. |
theDataset.CopySource |
Text |
The URL of the source item from which this item was copied, if the item results from a copy operation. |
theDataset.Editor |
Text |
The editor of the item. |
theDataset.Author |
Text |
The author of the item. |
theDataset.Created |
Date |
The date/time the item was initially created. The returned date/time format matches the following: MM/DD/YYYY HH:MM:SS AM/PM. |
theDataset.Modified |
Date |
The date/time the item was last modified. The returned date/time format matches the following: MM/DD/YYYY HH:MM:SS AM/PM. |
theDataset.Title |
Text |
The title of the item. |
theDataset.ContentTypeID |
Text |
The identifier of the content type that is associated with this item. |
theDataset.ID |
Text |
The integer that identifies the item. |
Example
Description: Get SharePoint list "Calendar" items(s) and store information in dataset "myListItems". Session is "SharePointSession3".
<AMSHAREPOINT ACTIVITY="get_listitems" LIST="Calendar" RESULTDATASET="myListItems" PROVIDER="session_based" SESSION="SharePointSession3" />