Skip to content
Data Ocean

# Table of Contents

Table of Contents

Section titled “Table of Contents”

_directoriesAPI

Section titled “_directoriesAPI”

Parameters

Section titled “Parameters”
  • httpClientProvider : The provider used to dispatch HTTP requests
  • publishCallback : The callback used to publish events
  • configuration : The configuration object
  • analyticshttpclient : The analytics http client
  • consumerKey : The consumer key

GetDirectoriesList

Section titled “GetDirectoriesList”

Parameters

Section titled “Parameters”
  • id : The ID of the directory

Returns any The directories list response object

GetDirectoriesListByPath

Section titled “GetDirectoriesListByPath”

Parameters

Section titled “Parameters”
  • path : The path of the directory

Returns any The directories list response object

GetFilesList

Section titled “GetFilesList”

Parameters

Section titled “Parameters”
  • id : The ID of the directory

Returns any The files list response object

GetFilesListByPath

Section titled “GetFilesListByPath”

Parameters

Section titled “Parameters”
  • path : The path of the directory

Returns any The files list response object

Create

Section titled “Create”

Parameters

Section titled “Parameters”
  • value : The input value of directory request

Returns any Created directory response object

Read

Section titled “Read”

Parameters

Section titled “Parameters”
  • id : The ID of the directory

Returns any The directory response object

ReadByPath

Section titled “ReadByPath”

Parameters

Section titled “Parameters”
  • path : The path of the directory

Returns any The directory response object

Delete

Section titled “Delete”

Parameters

Section titled “Parameters”
  • id : The ID of the directory

DeleteByPath

Section titled “DeleteByPath”

Parameters

Section titled “Parameters”
  • path : The path of the directory

_filesAPI

Section titled “_filesAPI”

Parameters

Section titled “Parameters”
  • httpClientProvider : The provider used to dispatch HTTP requests
  • uploadClientProvider : The provider used to dispatch HTTP requests for upload
  • publishCallback : The callback used to publish events
  • configuration : The configuration object
  • analyticshttpclient : The analytics http client
  • consumerKey : The consumer key

Create

Section titled “Create”

Parameters

Section titled “Parameters”
  • value : The file request object
  • queryParams : The query parameters (optional, default {})

Returns any Created file response object

GetVersionsList

Section titled “GetVersionsList”

Parameters

Section titled “Parameters”
  • id : The ID of the file

Returns any File response object

GetVersionsListByPath

Section titled “GetVersionsListByPath”

Parameters

Section titled “Parameters”
  • path :The Path of the file

Returns any File response object

Read

Section titled “Read”

Parameters

Section titled “Parameters”
  • id :The ID of the file
  • version : The version of the file
  • options (optional, default null)

Returns any File response object

ReadByPath

Section titled “ReadByPath”

Parameters

Section titled “Parameters”
  • path :The path of the file
  • version : The version of the file
  • options (optional, default null)

Returns any File response object

Update

Section titled “Update”

Parameters

Section titled “Parameters”
  • id :The ID of the file
  • value : Update file request object

Returns any Updated File response object

UpdateByPath

Section titled “UpdateByPath”

Parameters

Section titled “Parameters”
  • path
  • value : Update file request object
  • id :The path of the file

Returns any Updated File response object

Delete

Section titled “Delete”

Parameters

Section titled “Parameters”
  • id : The ID of the file
  • version

DeleteByPath

Section titled “DeleteByPath”

Parameters

Section titled “Parameters”
  • path : The path of the file
  • version

Copy

Section titled “Copy”

Parameters

Section titled “Parameters”
  • id
  • version
  • value

CopyByPath

Section titled “CopyByPath”

Parameters

Section titled “Parameters”
  • path
  • version
  • value

_dataoceanClient

Section titled “_dataoceanClient”

Represents a DataOcean3 client.

Parameters

Section titled “Parameters”

  • httpClientProvider The HTTP client provider.

  • uploadClientProvider The upload client provider.

  • configuration The configuration options.

    • configuration.chunkSize The chunk size for multipart uploads.
    • configuration.pageLimit The page limit for list requests.
    • configuration.maxConcurrentRequests The maximum number of concurrent requests for multipart uploads.