Changes
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
* Delete Content* Get DisplayValues of Content* Get Property DisplayValue of Content* Update Property Value
= Create Content =
|-
| uid|| String/Guid || ID of the object to be deleted
|-
| authentication|| String || Valid auth token
|-
| version|| String || Indicator of the expected data format version
|-
|}
= Web GetDisplayValues =
== WebGetDisplayValues ==
WebGetDisplayValues provides the possibility to fetch the display strings of one content object
<source lang="csharp">
/// <summary>
/// WebGetDisplayValues provides the possibility to fetch the display strings of one content object
/// WebGetDisplayValues provides a simplified interface optimized for being used in simple use cases (IOT).
/// <param name="app">The application.</param>
/// <param name="context">The context.</param>
/// <param name="uid">The id of the content object.</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 Displaystrings (as array) for the given content object if successfull, null otherwise.</returns>
[OperationContract]
[WebInvoke(UriTemplate = "WebGetDisplayValues/{app}/{context}/{uid}/{authentication}/{version}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
string[] WebGetDisplayValues(string app, string context, string uid, string authentication, string version);
</source>
=== List ofParameters ===
{| class="wikitable" | width = "50%"
|-
! Name!! Type !! Description
|-
| app|| String || Name of the Application
|-
| context|| String || Name of the Context
|-
| uid|| String/Guid || ID of the object
|-
| authentication|| String || Valid auth token
|-
| version|| String || Indicator of the expected data format version
|-
|}
= Get Property Display Value =
== WebGetPropertyDisplayValue ==
WebGetPropertyDisplayValue provides the possibility to fetch the display strings of one property of one content object
<source lang="csharp">
/// WebGetPropertyDisplayValue provides the possibility to fetch the display strings of one property of one content object
/// WebGetPropertyDisplayValue provides a simplified interface optimized for being used in simple use cases (IOT).
/// <param name="app">The application.</param>
/// <param name="context">The context.</param>
/// <param name="uid">The id of the content object.</param>
/// <param name="metaProperty">The id or the name of the meta property.</param>
/// <param name="index">The index of the proeprty.</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 display value of the given property if successfull, null otherwise</returns>
[OperationContract]
[WebInvoke(UriTemplate = "WebGetPropertyDisplayValue/{app}/{context}/{uid}/{metaProperty}/{index}/{authentication}/{version}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
string WebGetPropertyDisplayValue(string app, string context, string uid, string metaProperty, string index, string authentication, string version);
</source>
=== List ofParameters ===
{| class="wikitable" | width = "50%"
|-
! Name!! Type !! Description
|-
| app|| String || Name of the Application
|-
| context|| String || Name of the Context
|-
| uid|| String/Guid || ID of the object
|-
| metaProperty|| String/Guid || Name of MetaID of the Property you want to fetch
|-
| index|| int|| Index of the property value
|-
| authentication|| String || Valid auth token
|-
| version|| String || Indicator of the expected data format version
|-
|}
= Update Property Value =
== WebUpdatePropertyValue ==
WebUpdatePropertyValue provides the possibility to edit the value of one property of one content object
<source lang="csharp">
/// WebUpdatePropertyValue provides the possibility to edit the value of one property of one content object
/// WebUpdatePropertyValue provides a simplified interface optimized for being used in simple use cases (IOT).
/// <param name="app">The application.</param>
/// <param name="context">The context.</param>
/// <param name="uid">The id of the content object.</param>
/// <param name="metaProperty">The id or the name of the meta property to edit.</param>
/// <param name="index">The index of the proeprty.</param>
/// <param name="value">The value to set.</param>
/// <param name="VTS">Validation time stamp.</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 = "WebUpdatePropertyValue/{app}/{context}/{uid}/{metaProperty}/{index}/{value}/{vts}/{authentication}/{version}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
bool WebUpdatePropertyValue(string app, string context, string uid, string metaProperty, string index, string value, string VTS, string authentication, string version);
</source>
=== List ofParameters ===
{| class="wikitable" | width = "50%"
|-
! Name!! Type !! Description
|-
| app|| String || Name of the Application
|-
| context|| String || Name of the Context
|-
| uid|| String/Guid || ID of the object
|-
| metaProperty|| String/Guid || Name of MetaID of the Property you want to fetch
|-
| index|| int|| Index of the property value
|-
| authentication|| String || Valid auth token
