Constructor
# new OsduV1SchemaService(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 createSchema(schema, schemaInfo) → {Object}
Adds a schema to the schema repository
Parameters:
| Name | Type | Description |
|---|---|---|
schema |
Object | The schema to create |
schemaInfo |
Object | The schema info including the schema identity that uniquely identifies the schema and the status of the schema |
The API Response
Object
# async getSchema(schemaId) → {Object}
Get a schema in the schema repository
Parameters:
| Name | Type | Description |
|---|---|---|
schemaId |
String | The system id of the schema |
The API Response
Object
# async listSchemasByFilter(query_params) → {Object}
Find a schema in the schema repository
Parameters:
| Name | Type | Description |
|---|---|---|
query_params |
String | Query parameters built using the OsduSchemaQueryBuilder |
The API Response
Object
# async updateSchema(schema, schemaInfo) → {Object}
Updates a schema in the schema repository The schema must be in DEVELOPMENT status
Parameters:
| Name | Type | Description |
|---|---|---|
schema |
Object | The schema to create |
schemaInfo |
Object | The schema info including the schema identity that uniquely identifies the schema and the status of the schema |
The API Response
Object