Delete List Item activity

An activity that deletes SharePoint list items.

Configure the Delete List Item activity

To configure the Delete List Item activity, do the procedure in this topic.

Examples

(Example) Create a SharePoint Access Token

Good to Know

In this activity, you can delete a specified list of SharePoint list items. If you want to delete all the items in a list, a loop is required.
For more information, refer to (Example) Create a Loop to Repeat an Action and Store the Information in a SharePoint List.

This example shows how to use a loop to add more than one list item. A similar loop procedure can be used to delete more than one list item.
To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, and open the SharePoint tab.
On the SharePoint tab, drag the Delete List Item activity onto your process.

General Configuration

Specifies the basic settings for the Delete List Item activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Delete List Items Configuration

Specifies the SharePoint list items you want to delete. You can delete all list items within a SharePoint list or a folder, or you can specify a field name and value pair to delete a set of list items.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
List	Description: Specifies the name of your SharePoint list. Allowed Values: The name of your SharePoint list. Default Value: None Accepts Variables: Yes Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List
Folder	Description: Specifies the name of your SharePoint folder. Allowed Values: The name of your SharePoint folder If the folder does not exist within the specified SharePoint list, the AgilePoint system creates it. Default Value: None Accepts Variables: Yes
List Item Field	Description: Specifies the name of a SharePoint list column or field. Each field name-value pair specifies a list item to delete. Allowed Values: The name of your SharePoint list column. Default Value: ID Accepts Variables: Yes Example: If ListItem Field Name is set to ID, and ListItem Field Value is set to 5, only the list item with the ID equal to 5 is deleted. If ListItem Field Name is set to Created By, and ListItem Field Value is set to Mary Jones, all list items created by Mary Jones are deleted.
List Item Field Value	Description: Specifies the value of the field defined in ListItem Field Name. Each field name-value pair specifies a list item to delete.. Allowed Values: The value of the list column specified in the ListItem Field Name. Default Value: None Accepts Variables: Yes Example: If ListItem Field Name is set to ID, and ListItem Field Value is set to 5, only the list item with the ID equal to 5 is deleted. If ListItem Field Name is set to Created By, and ListItem Field Value is set to Mary Jones, all list items created by Mary Jones are deleted.
Move To Recycle Bin	Description: Specifies whether to move the list items from the SharePoint list to the recycle bin. Allowed Values: Selected - Deletes the list items from the SharePoint list and moves them to the recycle bin. Deselected - Deletes the SharePoint list items permanently. Default Value: Deselected Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher