WebAPI v2 Reference

Note

This document has been machine translated.

WebAPI v2 is available from xData Edge v5.0 onwards.

Dataset API

API Method	Description
dataset.create	Creates a new dataset.
dataset.delete	Deletes a dataset.
dataset.get_columns	Retrieves the column definition of a dataset.
dataset.citation.create	Issues a citation for the current state of the dataset.
dataset.citation.delete	Deletes a citation.
dataset.record.put	Registers or updates a record in the dataset.
dataset.record.delete	Deletes a record from the dataset.
dataset.record.get	Retrieves records from the dataset by specifying a citation.

API Method	Description
model_store.create	Creates a new model store.
model_store.delete	Deletes a model store.
model_store.model.put	Registers a model in the model store.
model_store.model.put_aggregated	Registers an aggregated model in the model store.
model_store.model.delete	Deletes a model from the model store.
model_store.model.get_info	Retrieves information about models registered in the model store.
model_store.model.get	Retrieves a record from the model store by specifying a model ID.

API Method	Description
fl.feedback	Feeds back the model in the model store to the upstream model store.
fl.request_transfer	Retrieves the latest aggregated model from the upstream model store and stores it in the model store.
fl.create_upstream_info	Registers the model store of the upstream node, which is the destination for model feedback, in the model store.
fl.update_upstream_info	Updates the upstream information registered in the model store.
fl.delete_upstream_info	Deletes the upstream information, which is the destination for model feedback, from the model store.
fl.list_upstream_info	Lists the upstream information of the model store.
fl.get_upstream_info	Retrieves the upstream information of the model store.

API Method	Description
module.exec	Executes a method provided by the module.
module.request	Issues a request to a service exposed by the module.

API Method	Description
session.open_session	Starts a new session.
session.close_session	Ends the session.
session.verify_session_token	Checks whether the session token is currently valid.