Scispot API - ELN API - List

List Documentations

Get a list of documentation pages inside a location path(labspace,folder or subfolder separated by colon(:)) based on the provided query parameters.

NOTE:

  • It is necessary to provide the location. location always starts from labspace name.

  • Labspace, Folder, and Subfolder names should not contain the colon (:) character.

Validation notes: provide at least one of labspace, folder.

get/labspace/documentation/fetch-list

Request

  • Base URL: https://cloudlab.scispot.io
  • URL: https://cloudlab.scispot.io/labspace/documentation/fetch-list
  • Auth: HTTP bearer

Query parameters

locationstring required

The location path from where the protocols will be fetched. You can seperate the labspace,folders and subfolders by colon(:). It always starts from labspace name. For Example: Labspace_Name:Folder_Name:Subfolder_Name.

pagestring required

The index of desired pages. For example setting page as 2 and pageSize as 10 fetches items 11-20.

pageSizestring required

The number of items to be fetched.

Response

OK

itemsobject[]
totalnumber
successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.