Jump to: navigation, search

Changes


UBIK Web Service

1,955 bytes removed, 12:18, 22 August 2019
== Fetch MetaDefinitions ==
Provides the configured ACM (see [[Application_Context_Management]]) Datemodell to the client.
== Download Content ==
GetHierarchyDeltasV212 is used for downloading single objects as well as branches, root objects and the infrastructure.
== Download a Document ==
Method provides a stream to the document referenced by the contentId.
== Create a single Content ==
Method for creating a single content object and retrieving the new object as result
== Update Contents ==
Method for updating a set of content objects and retrieving the updated objects as result
== Upload Document ==
Method for updating a set of content objects and retrieving the updated objects as result
}
</source>
 
 
= UBIK Webservice with simplified Interface =
 
 
== Create Content ==
 
WebCreateContent provides the possibility to create a single content object.
 
<source lang="csharp">
/// <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);
</source>
 
 
=== List ofParameters ===
{| class="wikitable" | width = "50%"
|-
! 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
|-
|}
1,579
edits