Skip to content

Latest commit

 

History

History
245 lines (143 loc) · 8.15 KB

collection.md

File metadata and controls

245 lines (143 loc) · 8.15 KB
title summary
Collection
`/api/collection` endpoints. By default, these endpoints operate on Collections in the 'default' namespace, which is the namespace that has things like Dashboards and Cards. Other namespaces of Collections exist as well, such as the `:snippet` namespace, ('Snippet folders' in the UI). These namespaces are independent hierarchies. To use these endpoints for other Collections namespaces, you can pass the `?namespace=` parameter (e.g., `?namespace=snippet`).

Collection

/api/collection endpoints. By default, these endpoints operate on Collections in the 'default' namespace, which is the namespace that has things like Dashboards and Cards. Other namespaces of Collections exist as well, such as the :snippet namespace, ('Snippet folders' in the UI). These namespaces are independent hierarchies. To use these endpoints for other Collections namespaces, you can pass the ?namespace= parameter (e.g., ?namespace=snippet).

GET /api/collection/

Fetch a list of all Collections that the current user has read permissions for (:can_write is returned as an additional property of each Collection so you can tell which of these you have write permissions for.)

By default, this returns non-archived Collections, but instead you can show archived ones by passing ?archived=true.

By default, admin users will see all collections. To hide other user's collections pass in ?exclude-other-user-collections=true.

If personal-only is true, then return only personal collections where personal_owner_id is not nil.

PARAMS:

  • archived nullable value must be a valid boolean string ('true' or 'false').

  • exclude-other-user-collections nullable value must be a valid boolean string ('true' or 'false').

  • namespace nullable value must be a non-blank string.

  • personal-only nullable value must be a valid boolean string ('true' or 'false').

GET /api/collection/:id

Fetch a specific Collection with standard details added.

PARAMS:

  • id value must be an integer greater than zero.

GET /api/collection/:id/items

Fetch a specific Collection's items with the following options:

  • models - only include objects of a specific set of models. If unspecified, returns objects of all models
  • archived - when true, return archived objects instead of unarchived ones. Defaults to false.
  • pinned_state - when is_pinned, return pinned objects only. when is_not_pinned, return non pinned objects only. when all, return everything. By default returns everything.

PARAMS:

  • id value must be an integer greater than zero.

  • models nullable vector of enum of dashboard, dataset, no_models, timeline, snippet, collection, pulse, metric, card.

  • archived nullable value must be a valid boolean string ('true' or 'false').

  • pinned_state nullable enum of is_not_pinned, is_pinned, all.

  • sort_column nullable enum of model, name, last_edited_by, last_edited_at.

  • sort_direction nullable enum of desc, asc.

  • official_collections_first nullable value must be a valid boolean string ('true' or 'false').

GET /api/collection/:id/timelines

Fetch a specific Collection's timelines.

PARAMS:

  • id value must be an integer greater than zero.

  • include nullable must equal events.

  • archived nullable boolean.

GET /api/collection/graph

Fetch a graph of all Collection Permissions.

You must be a superuser to do this.

PARAMS:

  • namespace nullable value must be a non-blank string.

GET /api/collection/root

Return the 'Root' Collection object with standard details added.

PARAMS:

  • namespace nullable value must be a non-blank string.

GET /api/collection/root/items

Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no collection_id exist. It does, however, have its own set of Permissions.

This endpoint will actually show objects with no collection_id for Users that have Root Collection permissions, but for people without Root Collection perms, we'll just show the objects that have an effective location of /.

This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the top-level objects you're allowed to access.

By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as snippets, you can pass the ?namespace= parameter.

PARAMS:

  • models nullable vector of enum of dashboard, dataset, no_models, timeline, snippet, collection, pulse, metric, card.

  • archived nullable value must be a valid boolean string ('true' or 'false').

  • namespace nullable value must be a non-blank string.

  • pinned_state nullable enum of is_not_pinned, is_pinned, all.

  • sort_column nullable enum of model, name, last_edited_by, last_edited_at.

  • sort_direction nullable enum of desc, asc.

  • official_collections_first nullable value must be a valid boolean string ('true' or 'false').

GET /api/collection/root/timelines

Fetch the root Collection's timelines.

PARAMS:

  • include nullable must equal events.

  • archived nullable boolean.

GET /api/collection/trash

Fetch the trash collection, as in /api/collection/:trash-id.

GET /api/collection/tree

Similar to GET /, but returns Collections in a tree structure, e.g.

[{:name     "A"
:below    #{:card :dataset}
:children [{:name "B"}
           {:name     "C"
            :here     #{:dataset :card}
            :below    #{:dataset :card}
            :children [{:name     "D"
                        :here     #{:dataset}
                        :children [{:name "E"}]}
                       {:name     "F"
                        :here     #{:card}
                        :children [{:name "G"}]}]}]}
{:name "H"}]

The here and below keys indicate the types of items at this particular level of the tree (here) and in its subtree (below).

TODO: for historical reasons this returns Saved Questions AS 'card' AND Models as 'dataset'; we should fix this at some point in the future.

PARAMS:

  • exclude-archived nullable boolean.

  • exclude-other-user-collections nullable boolean.

  • namespace nullable value must be a non-blank string.

  • shallow nullable boolean.

  • collection-id nullable value must be an integer greater than zero.

POST /api/collection/

Create a new Collection.

PARAMS:

  • name value must be a non-blank string.

  • description nullable value must be a non-blank string.

  • parent_id nullable value must be an integer greater than zero.

  • namespace nullable value must be a non-blank string.

  • authority_level nullable enum of official.

PUT /api/collection/:id

Modify an existing Collection, including archiving or unarchiving it, or moving it.

PARAMS:

  • id value must be an integer greater than zero.

  • name nullable value must be a non-blank string.

  • description nullable value must be a non-blank string.

  • archived nullable value must be a valid boolean string ('true' or 'false').

  • parent_id nullable value must be an integer greater than zero.

  • authority_level nullable enum of official.

  • collection-updates

PUT /api/collection/graph

Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph that are present in the request, and leave the rest unchanged.

If the skip_graph query parameter is true, it will only return the current revision.

You must be a superuser to do this.

PARAMS:

  • namespace nullable value must be a non-blank string.

  • revision value must be an integer.

  • groups map.

  • skip_graph nullable value must be a valid boolean string ('true' or 'false').

<< Back to API index