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
|
XML that specifies the documents to hold. <documents custom_attribute1="..."> <document custom_attribute2="..."> <CONNECTOR_GROUP>FileSystem</CONNECTOR_GROUP> <AUTN_IDENTIFIER>BASE64</AUTN_IDENTIFIER> </document> ... </documents> The The In NiFi Ingest, actions are represented by FlowFiles. You can specify custom attributes on the |
Set this or Identifiers |
Identifiers
|
A comma-separated list of identifiers to specify the documents to hold. | Set this or Documents |
Custom parameters |
Any other parameters that you set are added to the FlowFile, created by the HandleAciRequest processor, that represents the action. When a connector processes the action, it adds the parameters to any FlowFiles that it generates. The parameters are added as FlowFile attributes named FlowFile attributes can be referenced by processor properties that support expression language, and can be read by Lua scripts. You can therefore set custom parameters to customize processing within NiFi. The maximum size for a custom parameter value is 4KB. |
No |
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.