List all CMS objects with policies or holds based on the filters
GET {{baseUrl}}/retention?page=61627017&items-per-page=61627017&include-total=true&filter=minim ut aliqua&sortby=minim ut aliqua&fetch-traits=true&fetch-policies=true&fetch-type-instance=false&filter-qualified-policies=false&fetch-type-instance-links=false&expandAll=false&filter-type-instance=true
List all CMS objects with policies or holds based on the filters
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | The page number required | |
items-per-page | number | Number of items per page | |
include-total | boolean | Include the total number of results | |
filter | string | Filter the list of retentions. For example, ?filter=retention_type like '%po%' | |
sortby | string | Sort by field/attribute names. Default sort order is ascending and multiple sort condition should be separated by comma. |
Pass 'asc/desc' text after the value to change the sort order. e.g., to sort by 'retention_id' and 'retention_type' attribute in ascending order use ?sortby=retention_id asc, retention_type asc
Note: Not all attributes support sort. |
| fetch-traits | boolean | | Get custom attributes when listing instances |
| fetch-policies | boolean | | Get policies when listing instances |
| fetch-type-instance | boolean | | Get type instance when query on item policy |
| filter-qualified-policies | boolean | | Filtering on fetchPolicies, only show unqualified policies |
| fetch-type-instance-links | boolean | | Get all links for type instance |
| expandAll | boolean | | |
| filter-type-instance | boolean | | Get type instance when query on item policy |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"_embedded":{"collection":[{"item_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"item_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"reason":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"qualification_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"base_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"event_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"owner":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"create_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"update_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"etag":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"approver":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"approved_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"approved_state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"delay_hours":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"_links":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"item_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"item_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"reason":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"qualification_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"base_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"event_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"owner":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"create_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"update_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"etag":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"approver":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"approved_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"approved_state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"delay_hours":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"_links":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"_links":{"next":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"previous":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"self":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"first":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"last":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}