SharePoint Remote Connector 12.13

# Hold and Release Documents

You can use the SharePoint Remote Connector to place holds on list items in SharePoint.

When the connector places a hold on a document, the document is left where it is and cannot be edited or deleted. The connector does not support in-place holds, introduced in SharePoint 2013, which allow documents to be edited or deleted while the version that was held is preserved.

The connector can be used to place multiple holds on a document - for example when you are placing holds for different legal cases. An item cannot be edited or deleted until all of the holds placed on it are removed. The hold to which you want to add items is specified by the `HoldName` parameter in the connector's configuration file. You can override this parameter in the `hold` fetch action by using the `config` action parameter to supply a different configuration.

To place and release holds, the following properties must be present in the document identifiers used in the `hold` or `releasehold` actions:

`SITECOLLECTIONURL` | The URL of the site collection that contains the item.
`SITEID` | The GUID of the site that contains the item.
`LISTID` | The GUID of the list that contains the item.
`LISTITEMID` | The integer ID of the item in the list.

These properties are included in all identifiers returned by the connector.

Place a Hold on a List Item

To place a hold, use the `Hold` fetch action. You must specify the identifiers of the documents to hold. You can use the `config` action parameter to specify configuration settings to use, such as the name of the hold to which you want to add the documents:

    http://host:port/action=Fetch
                              &FetchAction=Hold
                              &Identifiers=Document_Identifiers
                              &Config=...

For more information about this action, refer to the SharePoint Remote Connector Reference.

Release Documents

To release documents, use the `ReleaseHold` fetch action. You must specify the identifiers of the documents to release:

    http://host:port/action=Fetch
                              &FetchAction=ReleaseHold
                              &Identifiers=Document_Identifiers
                              &Config=...

For more information about this action, refer to the SharePoint Remote Connector Reference.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL SharePoint Remote Connector 12.13

Topic Title: Hold and Release Documents