alfresco-ng2-components/docs/content-services/services/legal-hold.service.md

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
    

• 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
    

• 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

• 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
    

• 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

• 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>

• bulkAssignHold(holdId: string, query: RequestQuery): Observable<BulkAssignHoldResponseEntry>
  Assign multiple files to a hold.

  • holdId: string - The hold id
  • query: RequestQuery - Search query
  • Returns Observable<BulkAssignHoldResponseEntry> - Bulk operation description
    

• bulkAssignHoldToFolder(holdId: string, folderId: string, language: string): Observable<BulkAssignHoldResponseEntry>
  Assign a folder to a hold.

  • holdId: string - The hold id

  • folderId: string - The folder id

  • language: string - Language code. afts can be used for search query

  • Returns Observable<BulkAssignHoldResponseEntry> - Bulk operation description
    

• getBulkOperationStatus(bulkStatusId: string, holdId: string): Observable<HoldBulkStatusEntry>
  Get current status of bulk operation.

  • bulkStatusId: string - The bulk operation id

  • holdId: string - The hold id

  • Returns Observable<HoldBulkStatusEntry> - Current status of bulk operation
    

Details

To create, delete or get holds Records Management should be created and user should be added to it.

See also

• LegalHoldApi