Class

OsduV1DatasetService

OsduV1DatasetService(osdu_client, data_partition)

Class that provides named access to OSDU Dataset endpoints

Constructor

# new OsduV1DatasetService(osdu_client, data_partition)

Parameters:
Name Type Description
osdu_client BaseOsduClient

An implementation of the OSDU client class to broker communication with the OSDU API

data_partition string

The data partition against which requests will be made

View Source service/dataset/v1.js, line 11

Methods

# async getDatasetRegistries(registryIds) → {Object}

Get dataset registry objects for the given list dataset registry IDs

Parameters:
Name Type Description
registryIds Array.<string>

Identifiers for the dataset registries you wish to retrieve

View Source service/dataset/v1.js, line 35

The API Response

Object

# async getDatasetRegistry(registryId) → {Object}

Get dataset registry object for the given dataset registry ID

Parameters:
Name Type Description
registryId string

Identifier for the dataset registry you wish to retrieve

View Source service/dataset/v1.js, line 26

The API Response

Object

# async getMultipleRetrievalInstructions(registryIds) → {Object}

Get instructions on how to retrieve a given dataset registry

Parameters:
Name Type Description
registryIds Array.<string>

Identifiers for the dataset registries you wish to retrieve source data for

View Source service/dataset/v1.js, line 71

The API Response

Object

# async getRetrievalInstructions(registryId) → {Object}

Get instructions on how to retrieve a given dataset registry

Parameters:
Name Type Description
registryId string

Identifier for the dataset registry you wish to retrieve source data for

View Source service/dataset/v1.js, line 62

The API Response

Object

# async getStorageInstructions(kindSubType) → {Object}

Get instructions on how to store a given dataset sub type

Parameters:
Name Type Description
kindSubType string

Identifier for the kind of dataset you wish to store source data for

View Source service/dataset/v1.js, line 53

The API Response

Object

# async registerDatasets(datasetRegistries) → {Object}

Register a list of datasets

Parameters:
Name Type Description
datasetRegistries Array.<object>

List of dataset registry objects to register

View Source service/dataset/v1.js, line 44

The API Response

Object