# Table of Contents

Table of Contents

• _directoriesAPI
  • Parameters
  • GetDirectoriesList
    • Parameters
  • GetDirectoriesListByPath
    • Parameters
  • GetFilesList
    • Parameters
  • GetFilesListByPath
    • Parameters
  • Create
    • Parameters
  • Read
    • Parameters
  • ReadByPath
    • Parameters
  • Delete
    • Parameters
  • DeleteByPath
    • Parameters
• _filesAPI
  • Parameters
  • Create
    • Parameters
  • GetVersionsList
    • Parameters
  • GetVersionsListByPath
    • Parameters
  • Read
    • Parameters
  • ReadByPath
    • Parameters
  • Update
    • Parameters
  • UpdateByPath
    • Parameters
  • Delete
    • Parameters
  • DeleteByPath
    • Parameters
  • Copy
    • Parameters
  • CopyByPath
    • Parameters
• _dataoceanClient
  • Parameters

_directoriesAPI

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

Parameters

• id : The ID of the directory

Returns any The directories list response object

GetDirectoriesListByPath

Parameters

• path : The path of the directory

Returns any The directories list response object

GetFilesList

Parameters

• id : The ID of the directory

Returns any The files list response object

GetFilesListByPath

Parameters

• path : The path of the directory

Returns any The files list response object

Create

Parameters

• value : The input value of directory request

Returns any Created directory response object

Read

Parameters

• id : The ID of the directory

Returns any The directory response object

ReadByPath

Parameters

• path : The path of the directory

Returns any The directory response object

Delete

Parameters

• id : The ID of the directory

DeleteByPath

Parameters

• path : The path of the directory

_filesAPI

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

Parameters

• value : The file request object
• queryParams : The query parameters (optional, default {})

Returns any Created file response object

GetVersionsList

Parameters

• id : The ID of the file

Returns any File response object

GetVersionsListByPath

Parameters

• path :The Path of the file

Returns any File response object

Read

Parameters

• id :The ID of the file
• version : The version of the file
• options (optional, default null)

Returns any File response object

ReadByPath

Parameters

• path :The path of the file
• version : The version of the file
• options (optional, default null)

Returns any File response object

Update

Parameters

• id :The ID of the file
• value : Update file request object

Returns any Updated File response object

UpdateByPath

Parameters

• path
• value : Update file request object
• id :The path of the file

Returns any Updated File response object

Delete

Parameters

• id : The ID of the file
• version

DeleteByPath

Parameters

• path : The path of the file
• version

Copy

Parameters

• id
• version
• value

CopyByPath

Parameters

• path
• version
• value

_dataoceanClient

Represents a DataOcean3 client.

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.