Hold

The Hold action places a hold on one or more documents in the repository. When a document has been placed on hold, it cannot be deleted or modified by a regular user. This action might be used by applications that perform legal hold.

Type: asynchronous

Parameter Description Required
ConnectorGroup

The name of the connector group to send the request to. This must match the name you specified when you configured the ConnectorGroupRouter processor in your dataflow.

Yes
Documents A comma-separated list of identifiers to specify the documents to hold. Yes

Example

http://host:10000/action=Hold
	                  &ConnectorGroup=Documentum
		          &Documents=...

Response

This is an asynchronous action, so you receive a token in response to the request. You can use the QueueInfo action to see the result of the action.


_FT_HTML5_bannerTitle.htm