# List bookmarks compatible with this VDB Group.

Endpoint: GET /vdb-groups/{vdbGroupId}/bookmarks
Version: 3.18.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Path parameters:

  - `vdbGroupId` (string, required)
    The ID or name of the VDB Group.

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The Bookmark object entity ID.
    Example: bookmark-123

  - `items.name` (string)
    The user-defined name of this bookmark.
    Example: my-bookmark-123

  - `items.creation_date` (string)
    The date and time that this bookmark was created.
    Example: 2021-07-04T08:51:34.148Z

  - `items.data_timestamp` (string)
    The timestamp for the data that the bookmark refers to.
    Example: 2021-06-03T08:51:34.148Z

  - `items.timeflow_id` (string)
    The timeflow for the snapshot that the bookmark was created of.
    Example: 1-TIMEFLOW-1

  - `items.location` (string)
    The location for the data that the bookmark refers to.
    Example: 200000

  - `items.vdb_ids` (array)
    The list of VDB IDs associated with this bookmark.
    Example: ["vdb-123","vdb-456"]

  - `items.dsource_ids` (array)
    The list of dSource IDs associated with this bookmark.
    Example: ["dsource-123","dsource-456"]

  - `items.vdb_group_id` (string)
    The ID of the VDB group on which bookmark is created.
    Example: vdb-group-123

  - `items.vdb_group_name` (string)
    The name of the VDB group on which bookmark is created.
    Example: my-vdb-group

  - `items.vdbs` (array)
    The list of VDB IDs and VDB names associated with this bookmark.

  - `items.vdbs.vdb_id` (string)
    The VDB id.
    Example: vdb-id-1

  - `items.vdbs.vdb_name` (string)
    The VDB name.
    Example: vdb-name

  - `items.dsources` (array)
    The list of dSource IDs and dSource names associated with this bookmark.

  - `items.dsources.dsource_id` (string)
    The dSource id.
    Example: dsource-id-1

  - `items.dsources.dsource_name` (string)
    The dSource name.
    Example: dsource-name

  - `items.retention` (integer)
    The retention policy for this bookmark, in days. A value of -1 indicates the bookmark should be kept forever. Deprecated in favor of expiration.
    Example: 365

  - `items.expiration` (string)
    The expiration for this bookmark. When unset, indicates the bookmark is kept forever except for bookmarks of replicated datasets. Expiration cannot be set for bookmarks of replicated datasets.
    Example: 2021-07-04T00:00:00.000Z

  - `items.status` (string)
    A message with details about operation progress or state of this bookmark.
    Example: RESTORED

  - `items.replicated_dataset` (boolean)
    Whether this bookmark is created from a replicated dataset or not.

  - `items.bookmark_source` (string)
    Source of the bookmark, default is DCT. In case of self-service bookmarks, this value would be ENGINE.
    Enum: "DCT", "ENGINE"

  - `items.bookmark_status` (string)
    Status of the bookmark. It can have INACTIVE value for engine bookmarks only. If this value is INACTIVE then ss_bookmark_errors would have the list of associated errors.
    Enum: "ACTIVE", "INACTIVE"

  - `items.ss_data_layout_id` (string)
    Data-layout Id for engine-managed bookmarks.

  - `items.ss_bookmark_reference` (string)
    Engine reference of the self-service bookmark.

  - `items.ss_bookmark_errors` (array)
    List of errors if any, during bookmark creation in DCT from self-service.
    Example: ["No snapshots found for JS_BOOKMARK-1 at timestamp 2021-07-04T08:51:34.148"]

  - `items.bookmark_type` (string)
    Type of the bookmark, either PUBLIC or PRIVATE.
    Enum: "PUBLIC", "PRIVATE"

  - `items.tags` (array)
    The tags to be created for this Bookmark.
    Example: [{"key":"key-1","value":"value-1"},{"key":"key-2","value":"value-2"}]

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.