Files
alfresco-ng2-components/docs/content-services/services/legal-hold.service.md
Darya Blavanovich 0843263ce3 [ACS-7690] Saving adding o a new hold (#9862)
* ACS-7689 Save and delete to existing hold

* ACS-7689 Save and delete to existing hold, cleanup

* ACS-7689 Save and delete to existing hold, revert to separate methods

* ACS-7689 Save and delete to existing hold, fix specs

* ACS-7689 Save and delete to existing hold, fix specs

* ACS-7689 Save and delete to existing hold

* ACS-8055 add listAssignedHolds API

* ACS-8055 create legal-hold service

* ACS-8055 add documentation

* ACS-8055 fix imports

* ACS-8055 add HoldPaging class and documentation

* ACS-8055 add interface and fix test

* ACS-7689 Save and delete to existing hold, fix specs

* ACS-7689 Save and delete to existing hold, fix specs

* ACS-7690 integrate create and assign holds endpoints

* ACS-7690 fix imports

* ACS-7690 add bulk method

* ACS-7690 update readme file

* ACS-7690 add tests

* ACS-7690 update docs file

* ACS-7690 remove interface

* ACS-7690 update geHolds description and md file with createHold

* ACS-7690 add createHolds to md file

* ACS-7690 fix typo in spec, and description in legal-hold service

* ACS-7690 refactor create hold parameter and documentation

* ACS-7690 fixed test

* ACS-7690 fix test for getHolds

* ACS-7690 fix md for create hold action

* ACS-7690 fix rebase conflicts

---------

Co-authored-by: Tomasz Nastaly <tomasz.nastaly@hyland.com>
Co-authored-by: DaryaBalvanovich <darya.balvanovich1@hyland.com>
2024-08-13 10:27:22 +02:00

4.0 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
  • createHold(filePlanId: string, hold: Hold): Observable<HoldEntry>
    Create new hold in File Plan.

    • filePlanId: string - The identifier of a file plan. You can also use the -filePlan- alias
    • hold: Hold - Hold that should be created
    • Returns Observable<HoldEntry> - Hold entry
  • createHolds(filePlanId: string, holds: Hold[]): Observable<Hold[]>
    Create new holds in File Plan.

    • filePlanId: string - The identifier of a file plan. You can also use the -filePlan- alias
    • holds: <Hold[]> - 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 a node 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]>
    Assign a node to a hold.

    • holdId: string - The hold Id
    • nodeId: string - The Id of the node which is unassigned
    • Returns [void]

Details

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

See also