ddd508ba60
* ACS-8329 Manage bulks endpoint (#9972) * ACS-8325 extend ContentActionRef with tooltip (#9998) * [ACS-8425] Add functionality to select folder and assign it to a hold (#10011) * ACS-8425 add bulkFolderHold method * ACS-8425 refactor names and add more specific query to folder * ACS-8425 refactor names * ACS-8425 fix description in md file * ACS-8425 update interfaces and add constant * ACS-8425 fix readme file and refactor tests * ACS-8425 fix readme * ACS-8425 fix readme * ACS-8036 fix import path --------- Co-authored-by: Tomasz Nastaly <tomasz.nastaly@hyland.com>
5.5 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Legal Hold service | v6.10.0 | Active | 2024-06-19 |
Legal Hold service
Manages holds for nodes.
Class members
Methods
-
getHolds(filePlanId:
string, options?:ContentPagingQuery):Observable<Hold[]>
Gets the list of holds for a node.- filePlanId:
string- The identifier of a file plan. You can also use the -filePlan- alias - options:
ContentPagingQuery- Optional parameters supported by JS-API - Returns
Observable<Hold[]>- List of holds
- filePlanId:
-
createHold(filePlanId:
string, hold:HoldBody):Observable<HoldEntry>
Create new hold in File Plan.- filePlanId:
string- The identifier of a file plan. You can also use the -filePlan- alias - hold:
HoldBody- Hold that should be created - Returns
Observable<HoldEntry>- Hold entry
- filePlanId:
-
createHolds(filePlanId:
string, holds:HoldBody[]):Observable<Hold[]>
Create new holds in File Plan.- filePlanId:
string- The identifier of a file plan. You can also use the -filePlan- alias - holds:
<HoldBody[]>- Array of holds that should be created - Returns
Observable<HoldPaging>- List of paginated holds entries
- filePlanId:
-
assignHold(nodeId:
string, holdId:string):Observable<HoldEntry>
Assign a node to a hold.- nodeId:
string- The Id of the node which will be assigned to a hold - holdId:
string- The Id of the hold to which nodes will be assigned - Returns
Observable<HoldEntry>- Entry with the hold
- nodeId:
-
assignHolds(nodeIds:
<{id: string}[]>, holdId:string):Observable<HoldPaging>
Assign multiple nodes to a hold.- nodeIds:
<{id: string}[]>- The Ids of the nodes which will be assigned to a hold - holdId:
string- The Id of the hold to which nodes will be assigned - Returns
Observable<HoldPaging>- Hold paging
- nodeIds:
-
unassignHold(holdId:
string, nodeId:string):Observable<void>
Unassign a node from a hold.- holdId:
string- The hold Id - nodeId:
string- The Id of the node which is unassigned - Returns
Observable<void>
- holdId:
-
bulkAssignHold(holdId:
string, query:RequestQuery):Observable<BulkAssignHoldResponse>
Assign multiple files to a hold.- holdId:
string- The hold id - query:
RequestQuery- Search query - Returns
Observable<BulkAssignHoldResponse>- Bulk status
- holdId:
-
bulkAssignHoldToFolder(holdId:
string, folderId:string, language:string):Observable<BulkAssignHoldResponse>
Assign a folder to a hold.-
holdId:
string- The hold id -
folderId:
string- The folder id -
language:
string- Language code.aftscan be used for search query -
Returns
Observable<BulkAssignHoldResponse>- Bulk status
-
Details
To create, delete or get holds Records Management should be created and user should be added to it.