Nodes

List all view only links

List of view only links on a node.

Returns

Returns a JSON object containing data and links keys.

The data key contains an array of up to 10 view only links. Each resource in the array is a view only link object.

The links key contains a dictionary of links that can be used for pagination.

Permissions

View only links on a node, public or private, are readable and writeable only by users that are administrators on the node.

Filtering

You can optionally request that the response only include view only links that match your filters by utilizing the filter query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/view_only_links/?filter[anonymous]=true.

View Only Links may be filtered based on their name, anonymous and date_created fields. Possible comparison operators include 'gt' (greater than), 'gte'(greater than or equal to), 'lt' (less than) and 'lte' (less than or equal to). The date must be in the format YYYY-MM-DD and the time is optional.

get/nodes/{node_id}/view_only_links/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/nodes/{node_id}/view_only_links/
  • Auth
    none declared

Path parameters

node_idstring required

The unique identifier of the node.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.