# 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 |
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 |
The API Response
# 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 |
The API Response
# 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 |
The API Response
# 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 |
The API Response
# 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 |
The API Response
# async registerDatasets(datasetRegistries) → {Object}
Register a list of datasets
Parameters:
Name | Type | Description |
---|---|---|
datasetRegistries |
Array.<object> | List of dataset registry objects to register |
The API Response