SharePoint Remote Connector 12.13

# ReleaseHold

The `ReleaseHold` action releases a document that has been placed on hold.

Documents are specified by their identifier.

Type: Asynchronous

Parameter Name | Description | Required
--- | --- | ---
`Config` | A base-64 encoded configuration. The configuration parameters that are set override the same parameters in the connector's configuration file. | No
`failedDirectory` | The directory in which the action reports failures. | No
`Identifiers` | A comma-separated list of document identifiers. The documents with these identifiers are released from hold. | Yes
`Override_Config_Parameters` | Any other action parameters that you set override settings in the connector's configuration file. For example:
    /action=fetch&fetchaction=...
                 &[Section]Parameter=Value
where `[Section]` (optional) is the name of a configuration file section, `Parameter` is the name of a configuration parameter, and `Value` is the parameter value. | No

## Example

    http://localhost:1234/action=Fetch&FetchAction=ReleaseHold
                                      &Identifiers=PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg%3D%3D

## Response

As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the `queueinfo` action) appears below.

This response shows that one document was successfully released.

    <action>
      <documentcounts>
        <documentcount
            added="0"          collected="0"       deleted="0"
            errors="0"         holds="0"           ingestadded="0"
            ingestdeleted="0"  ingestfailed="0"    ingestupdated="0"
            inserted="0"       releasedholds="1"   seen="0"
            task="DIR1"        unchanged="0"       updated="0"/>
      </documentcounts>
      <fetchaction>HOLD</fetchaction>
      <tasks>
        <success>
            PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg==
        </success>
      </tasks>
      <token>MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTgwNDU4NzIxMQ==</token>
      <status>Finished</status>
      <queued_time>2009-Oct-15 16:43:17</queued_time>
      <time_in_queue>0</time_in_queue>
      <process_start_time>2009-Oct-15 16:43:17</process_start_time>
      <time_processing>0</time_processing>
      <process_end_time>2009-Oct-15 16:43:17</process_end_time>
    </action>

If a document cannot be released successfully, the document identifier appears between `<failed>` tags and a message explains the reason for the failure:

    <tasks>
      <failed message="Error message">
        PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxmaWxlOS50eHQiLz4=
      </failed>
    </tasks>

© 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: ReleaseHold