Difference between revisions of "UBIK Web ServiceV264"

Revision as of 12:28, 22 August 2019

The following section describes UBIK Webservice Methods with a simplyfied interface designed to be used from external systems (e.g. IOT use case)

Create Content

[edit]

Create Content
Delete Content

Create Content

WebCreateContent

WebCreateContent provides the possibility to create a single content object.

/// <summary>
/// WebCreateContent provides the possibility to create a single content object.
/// WebCreateContent provides a simplified interface optimized for being used in simple use cases (IOT).
/// </summary>
/// <param name="app">The application.</param>
/// <param name="context">The context.</param>
/// <param name="metaClassUID">ID of the MetaClass (Type) of the new instance.</param>
/// <param name="parentUID">ID of the hierarchical parent of the new instance.</param>
/// <param name="authentication">Authentication (tokenid) for the user/device to access this service</param>
/// <param name="version">Client Web Service Version number.</param>
/// <returns>The ID of the new instance if creation was successfull, Guid.Empty otherwise. </returns>
[OperationContract]
[WebInvoke(UriTemplate = "WebCreateContent/{app}/{context}/{metaClassUID}/{parentUID}/{authentication}/{version}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
Guid WebCreateContent(string app, string context, string metaClassUID, string parentUID, string authentication, string version);

List ofParameters

Name	Type	Description
app	String	Name of the Application
context	String	Name of the Context
metaClassUID	String/Guid	ID of the MetaClass (Type) of the new instance.
parentUID	String/Guid	ID of the hierarchical parent of the new instance.
authentication	String	Valid auth token
version	String	Indicator of the expected data format version

Delete Content

WebDeleteContent

WebDeleteContent provides the possibility to delete a single content object.

/// <summary>
/// WebDeleteContent provides the possibility to delete a single content object.
/// WebDeleteContent provides a simplified interface optimized for being used in simple use cases (IOT).
/// </summary>
/// <param name="app">The application.</param>
/// <param name="context">The context.</param>
/// <param name="uid">The id of the object to delete.</param>
/// <param name="authentication">Authentication (tokenid) for the user/device to access this service</param>
/// <param name="version">Client Web Service Version number.</param>
/// <returns>True if deletion was successfull, False otherwise.</returns>
[OperationContract]
[WebInvoke(UriTemplate = "WebDeleteContent/{app}/{context}/{uid}/{authentication}/{version}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
bool WebDeleteContent(string app, string context, string uid, string authentication, string version);

List ofParameters

Name	Type	Description
app	String	Name of the Application
context	String	Name of the Context
uid	String/Guid	ID of the object to be deleted
authentication	String	Valid auth token
version	String	Indicator of the expected data format version