Class DataSourceController
Controller for the REST API interface to DataSource management functions.
Inheritance
DataSourceController
Assembly: WMServer.dll
Syntax
[Route("dataSource")]
[Authorize]
[ApiController]
public class DataSourceController : ControllerBase
Constructors
DataSourceController(WMAppDbContext)
Constructor that injects the database context.
Declaration
public DataSourceController(WMAppDbContext context)
Parameters
Methods
CommitTransaction(string)
Commit the transaction with the specified ID
Declaration
[HttpPost("commitTransaction/{xid}")]
public Task<ActionResult<string>> CommitTransaction(string xid)
Parameters
| Type |
Name |
Description |
| string |
xid |
|
Returns
Delete(string)
Delete an existing instance of a DataSource
Declaration
[HttpDelete("{id}")]
public Task<IActionResult> Delete(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
DeleteData(string, List<InsertUpdateDeleteArgs>)
delete existing data in the DataSource.
Declaration
[HttpPost("{id}/delete")]
public Task<ActionResult> DeleteData(string id, List<InsertUpdateDeleteArgs> args)
Parameters
Returns
Evaluate(string, DataSourceArgs)
Evaluates the query using the WMDataSource whose ID is specified in the URL argument, using the query
text specified as the value of the sourceString key in the request body.
Declaration
[HttpPost("{id}/evaluate")]
public Task<ActionResult<OpenDIValue>> Evaluate(string id, DataSourceArgs args)
Parameters
| Type |
Name |
Description |
| string |
id |
ID of the data source against which the query is to be run
|
| DataSourceArgs |
args |
The source string, query action ('ReadTable' or 'ReadScalar'), output type ('CSV' or 'JSON') and
and required query arguments.
|
Returns
Get()
Declaration
[HttpGet]
public Task<ActionResult<IEnumerable<OpenDIDataSource>>> Get()
Returns
Get(string)
Get the DataSource with the specified ID
Declaration
[HttpGet("{id}")]
public Task<ActionResult<OpenDIDataSource>> Get(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
GetAccessorString(string)
Get the DataSource with the specified ID's connection/accessor string
Declaration
[HttpGet("{id}/accessorString")]
public Task<ActionResult<OpenDIDataSource>> GetAccessorString(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
InsertData(string, List<InsertUpdateDeleteArgs>)
Insert new data into the DataSource.
Declaration
[HttpPost("{id}/add")]
public Task<ActionResult> InsertData(string id, List<InsertUpdateDeleteArgs> args)
Parameters
Returns
OpenTransaction(string)
Open a transaction on the datasource identified by the id URL parameter.
Declaration
[HttpPost("{id}/openTransaction")]
public Task<ActionResult<string>> OpenTransaction(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
Post(OpenDIDataSource)
Create a new instance of a DataSource
Declaration
[HttpPost]
public Task<ActionResult<OpenDIDataSource>> Post(OpenDIDataSource openDI_ds)
Parameters
Returns
Put(string, OpenDIDataSource)
Update an existing instance of a DataSource
Declaration
[HttpPut("{id}")]
public Task<IActionResult> Put(string id, OpenDIDataSource openDI_ds)
Parameters
Returns
RollbackTransaction(string)
Commit the transaction with the specified ID
Declaration
[HttpPost("rollbackTransaction/{xid}")]
public Task<ActionResult<string>> RollbackTransaction(string xid)
Parameters
| Type |
Name |
Description |
| string |
xid |
|
Returns
SetAccessorString(string, AccessorStringArgs)
Set the DataSource with the specified ID's connection/accessor string
Declaration
[HttpPut("{id}/accessorString")]
public Task<ActionResult<OpenDIDataSource>> SetAccessorString(string id, AccessorStringArgs args)
Parameters
Returns
UpdateData(string, List<InsertUpdateDeleteArgs>)
Update existing data in the DataSource.
Declaration
[HttpPost("{id}/update")]
public Task<ActionResult> UpdateData(string id, List<InsertUpdateDeleteArgs> args)
Parameters
Returns