Skip to main content

​
URL structure

where {itemId} is the ID of a file object/Secure Object or folder/collection.

​
Supported methods and overview

  • GET - retrieves a list of information about the ancestral folders/collections of a specified file object/Secure Object or folder (i.e. item), specified by itemId.
This method takes no parameters.

​
Detailed description

This API endpoint retrieves a list of information about the ancestral folders of a file object or folder, specified by itemId. The item’s ID can be obtained by calling the <access-service>/api/v1/organisations/{orgId}/items API endpoint, which retrieves a list of information associated with file objects and folders that can be filtered using various ‘search’ criteria. The list of folder information returned is ordered from the root location (whose ID is 0) first, through to the immediate parent folder last.

​
Supported roles and conditions

This API endpoint supports requests utilising Cocoon Data user accounts with the following roles (as described in the Organisation Administrator’s Guide):
  • Originator - when this user owns the item whose ID is specified by {itemId} in the request’s URL.
  • Originator, Collaborator and Ad hoc - when this user is a collaborator on the item whose ID is specified by {itemId} in the URL.
The Cocoon Data Platform’s resources available to one of these Cocoon Data users (above) is determined by the access token submitted in the header of requests to this endpoint.

​
Required headers

The appropriate access token as the Bearer token:
  • Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

​
Returns

If the request succeeded, then an HTTP response status 200 OK is returned. For successful requests only, a JSON-formatted response containing an array of objects with the following members is also returned:
  • id - The ID of the location/folder represented by this JSON object. For the root location, this value is 0. For a folder location, this value is the folder’s ID.
  • name - The name of the folder represented by this JSON object. For the root location, this value is an empty string. For a folder location, this value is the folder’s name.
  • parentId - The ID of the parent location of the folder represented by this JSON object. For the root location, this value is 0. For a folder location, this value is the immediate parent folder’s ID (or 0 if the immediate parent location is the root location).
    Example (response):