== Web Service Interface ==
The most important web service following list of members are listed here, where is supported since {{Version/ServerSince|3.0}} Where more detailed information and a comprehensive list of all members and data types are located in the {{UBIK}} class documentation.
*ContextDefinitions[] GetContexts <syntaxhighlight lang="csharp">/// <summary>/// Uploads the given stream and saves it as a file/// </summary>/// <param name="stream">The stream.</param>/// <returns></returns>UBIK.Service.BCDataShipment UploadFile(applicationIDStream stream);Delivers /// <summary>/// Provides a list stream to the document referenced by the contentId./// </summary>/// <param name="appName">Name of all useable Context objects the application</param>/// <param name="contextName">Name of the context</param>/// <param name="documentId">ID of the document content object</param>/// <param name="authentication">authentication (tokenid) for the given ApplicationID. user/device to access this service</param>*DataShipment[] GetInfraStructure/// <param name="version">Version of the data contract</param>/// <returns>A stream to the document</returns>Stream DownloadDocumentV212(deviceIDstring appName, applicationIDstring contextName, contextIDstring documentId, string authentication, string version); /// <summary>/// Delivers a list of basic content objects needed to be updated all defined MetaClass Objects for the given application Application and given context on the given device DeviceID/// </summary>/// <param name="appName">Name of the Application</param>/// <param name="contextName">Name of the Context</param>/// <param name="authentication">authentication (e.g. tokenid) for the user/device to access this service</param>/// <param name="version">Version of the data contract</param>/// <returns>a list of all TAG objects inclMetaDefinitions</returns>UBIK. properties that changed since the last infrastructure update)Service.*DataShipment[] GetDefaultInfraStructureBCMetaDefinitions GetMetaDefinitionsV212(deviceIDString appName, String contextName, string authentication, applicationIDstring version);Delivers a list /// <summary>/// Gets the hierarchy deltas/// </summary>/// <param name="appName">Name of basic content objects needed to be updated for the given application and its default .</param>/// <param name="contextName">Name of the context on .</param>/// <param name="args">The arguments.</param>/// <param name="authentication">The authentication.</param>/// <param name="version">The version of the given device (edata contract.g</param>/// <returns></returns>UBIK. a Service.DTO.V211.BCHierarchyDeltaShipments GetHierarchyDeltasV212(string appName, string contextName, HierarchyDeltaArguments args, String authentication, string version); /// <summary>/// Updates the content list ./// </summary>/// <param name="appName">Name of all TAG objects inclthe application. properties that changed since </param>/// <param name="contextName">Name of the last infrastructure update)context.</param>*DataShipment GetContent /// <param name="authentication">The authentication.</param>/// <param name="dataShipments">The data shipments.</param>/// <param name="version">The version of the data contract.</param>/// <returns></returns>UBIK.Service.BCDataShipments UpdateContentListV212(idstring appName, contextstring contextName, string authentication, UbikContent[] dataShipments, lockstring version);Delivers a /// <summary>/// Creates the single content object with V212./// </summary>/// <param name="appName">Name of the given primary key (id)application. </param>/// <param name="contextName">Name of the context.</param>/// <param name="ownerID">The scope defines owner identifier.</param>/// <param name="authentication">The authentication.</param>/// <param name="dataShipment">The data shipment.</param>/// <param name="version">The version of the collection data contract.</param>/// <returns></returns>UBIK.Service.BCDataShipment CreateSingleContentV212(string appName, string contextName, string ownerID, string authentication, UbikContent dataShipment, string version); /// <summary>/// Provides a Testaccess to GetHierarchyDeltas./// args must be either ("root", "infra" or a valid UID of properties that are delivered together with the content start object)/// </summary>/// <param name="appName">Name of the application. If </param>/// <param name="contextName">Name of the lock context.</param>/// <param name="args">The arguments as string parameter is false.</param>/// <param name="childDepth">child depth as string</param>/// <param name="parentDepth">parent depth as string</param>/// <param name="authentication">The authentication.</param>/// <param name="version">The version of the data contract.</param>/// <returns></returns>UBIK.Service.DTO.V211.BCHierarchyDeltaShipments DebugHierarchyDeltas(string appName, only read access is grantedstring contextName, if the lock parameter is truestring args, string childDepth, string parentDepth, string authentication, string version); /// <summary>/// Gets the system grants write access for live values./// </summary>/// <param name="appName">Name of the given content object (all properties for application.</param>/// <param name="contextName">Name of the given context are marked as locked on the server side).</param>*ids/// <param name="args">The arguments.</param>/// <param name="authentication">The authentication.</param>/// <param name="version">The version.</param>/// <returns></returns>UBIK.Service.DTO.V244.BCLiveValues GetLiveValues(string appName, string contextName, PropertyKey[] GetNextContentLevelIds (contextIDargs, ownerIDstring authentication, string version); /// <summary>/// Delivers info about the current status of the Live Value Server./// </summary>/// <param name="token">authentication token</param>string GetLiveValueServerStatus(string token); /// <summary>/// Starts a list diagnosis of the ids for the next viewLevel for web service infrastructure and delivers the given owner result as SystemDiagnosisResult object. *DataShipment[] GetNextContentLevel /// </summary>/// <param name="authentication">The authentication.</param>/// <param name="version">The version.</param>/// <returns></returns>UBIK.Service.DTO.V243.SystemDiagnosisResult SystemDiagnosis(contextIDstring authentication, ownerIDstring version); /// <summary>/// Uploads a document for diagnosis issues/// </summary>/// <param name="stream">The stream.</param>/// <returns></returns>UBIK.Service.BroadcastEnvelope UploadDocumentDiagnosis(Stream stream); /// <summary>/// Downloads a document for diagnosis issues/// </summary>/// <param name="fileExtension">The file extension.</param>/// <param name="authentication">The authentication.</param>/// <param name="version">The version.</param>/// <returns></returns>Stream DownloadDocumentDiagnosis(string fileExtension, string authentication, string version); /// <summary>/// Delivers a list collection of content objects all configured service urls for the next content level in the given context diagnosis issues/// </summary>/// <param name="authentication">The authentication.</param>/// <param name="version">The version.</param>/// <returns></returns>UBIK.Service.DTO.V243.ServiceURLInformation[] ServiceURLDiagnosis(uses string authentication, string version); /// <summary>/// Gets information abut the state of view cache./// </summary>/// <param name="appName">Name of the application.</param>/// <param name="contextName">Name of the context.</param>/// <param name="authentication">The authentication.</param>/// <returns>Information about the state of the view cache as human readable string</returns>string GetViewStateInformation(string appName, string contextName, string authentication) for ; /// <summary>/// Triggers a refresh of the given owner objectview cache. /// The context defines scope current cache stays valid until the collection new cache was fully built./// </summary>/// <param name="appName">Name of properties that are delivered together with the content objectapplication. Only read access is granted</param>/// <param name="contextName">Name of the context.</param>/// <param name="authentication">The authentication.</param>/// <returns>true as the refresh was triggered successfully, false otherwise</returns>*UpdateContentClassbool TriggerViewStateRefresh(ContractIDstring appName, IDstring contextName, dataobjectstring authentication); Updates /// <summary>/// Test member for testing the content with View Cache./// </summary>/// <param name="appName">Name of the given IDapplication. To perform an update a valid contractID is necessary. After a successful update </param>/// <param name="contextName">Name of the contractID looses its validitycontext.</param>*DataShipment CreateNewContent/// <param name="ownerUID">UID of the object the test should be executed for (contextID, contentIDe.g. root object). All data below this object will be delivered.</param>Creates a new updateable (incl/// <param name="authentication">The authentication. valid </param>/// <returns>data contractstored in the view cache as BCHierarchyDeltaShipments</returns>UBIK.Service.DTO.V211.BCHierarchyDeltaShipments TestViewState(string appName, string contextName, string ownerUID, string authentication) content record; /// <summary>/// Downloads the custom images. This record is sent back to /// </summary>/// <param name="appName">Name of the client and can be updated via UpdateContentClassapplication.</param>/// <param name="contextName">Name of the context.</param>/// <param name="authentication">The authentication.</param>/// <param name="deviceID">The device identifier.</param>/// <returns></returns>Stream DownloadCustomImages(string appName, string contextName, string authentication, string deviceID); </syntaxhighlight>
[[Category:Web service|Setup UBIK WebServices]]
