# new OsduV1LegalService(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 createLegalTag(tagData) → {Object}
Create a new legal tag in the given data partition
Parameters:
| Name | Type | Description |
|---|---|---|
tagData |
Object | The JSON representation of the tag you wish to create |
The API Response
# async deleteLegalTag(tagData) → {Object}
Delete an existing legal tag in the given data partition
Parameters:
| Name | Type | Description |
|---|---|---|
tagData |
string | The name of the tag you wish to delete |
The API Response
# async getLegalTag(name) → {Object}
Retrieve a specific legal tag in the given data partition
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the tag you wish to retrieve |
The API Response
# async getLegalTagProperties() → {Object}
List the allowed legal tag properties and values in the given data partition
The API Response
# async getLegalTags(names) → {Object}
Get requested legal tags in the given data partition
Parameters:
| Name | Type | Description |
|---|---|---|
names |
Array.<string> | The list of tag names you wish to retrieve |
The API Response
# async listLegalTags() → {Object}
Get all supported legal tags in the given data partition
The API Response
# async updateLegalTag(tagData) → {Object}
Update an existing legal tag in the given data partition
Parameters:
| Name | Type | Description |
|---|---|---|
tagData |
Object | The JSON representation of the tag you wish to update |
The API Response
# async validateLegalTags(names) → {Object}
Validate requested legal tags in the given data partition
Parameters:
| Name | Type | Description |
|---|---|---|
names |
Array.<string> | The list of tag names you wish to validate |
The API Response