Method GetWorkspace

GetWorkspace(String, WorkspacePreloadOptionsContract)

Get the workspace

Declaration

WorkspaceContract GetWorkspace(string connectionId, WorkspacePreloadOptionsContract preLoadOptions)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
WorkspacePreloadOptionsContract	preLoadOptions	The workspace preload options. They determine which parts of the workspace need to be loaded. See also WorkspacePreloadOptionsContract

Returns

Type	Description
WorkspaceContract	The workspace. See also WorkspaceContract

Examples

POST http://YourServerName/InfoShare/Json/Common/GetWorkspace

Example for get workspace.

{
   "connectionId": "adb26c2e-c9ca-4091-aa59-4ff714539272",
   "preLoadOptions": {
     "PreloadAll": true,
     "SchemaStore": false,
     "InfoStores": false,
     "BlobStoreProviders": false,
     "UserStore": false,
     "CloudSchemaStore": false,
     "SecurityStore": false,
     "GlobalSettings": false,
     "UserAdminAccessRights": false,
     "ServerInfo": false,
     "DocumentConvertingSettings": false,
     "TaskTemplates": false,
     "CurrentlyAllowedImportTemplatesForCreating": false,
     "CurrentlyAllowedInfoStoresForCreating": false,
     "CurrentlyAllowedProtectionDomainsForCreating": true}
}

Response:

{
   "GetWorkspaceResult": {
     "BlobStoreProviders": null,
     "CloudSchemaStore": null,
     "CurrentlyAllowedImportTemplatesForCreating": null,
     "CurrentlyAllowedInfoStoresForCreating": null,
     "CurrentlyAllowedProtectionDomainsForCreating": [{
       "Id": "0100a000-38a7-11d8-a902-0050bf427e8f",
       "Name": {
         "Values": [{
           "Culture": "de",
           "Text": "Standardsicherheit" }, {
           "Culture": "en",
           "Text": "Default security" }, {
           "Culture": "fr",
           "Text": "Sécurité par défaut" }] },
       "RoleIds": ["5329a0a6-bacf-e911-a939-00155d290a08",
             "aabf9e5d-fee0-e911-a94b-00155d290a08", "19c39e5d-fee0-e911-a94b-00155d290a08", 
             "9bc69e5d-fee0-e911-a94b-00155d290a08", "08ca9e5d-fee0-e911-a94b-00155d290a08"]   
        ....      },
       "RoleIds": ["aabf9e5d-fee0-e911-a94b-00155d290a08", "19c39e5d-fee0-e911-a94b-00155d290a08", 
       "9bc69e5d-fee0-e911-a94b-00155d290a08", "08ca9e5d-fee0-e911-a94b-00155d290a08"] }],
     "DocumentConvertingSettings": null,
     "GlobalSettings": null,
     "InfoStores": null,
     "SchemaStore": null,
     "SecurityStore": null,
     "ServerInfo": {
       "ApplicationUser": "KENDOX\\koj",
       "AvailableSystemMemory": 1705889792,
        "CacheFolderPath": "C:\\Temp\\InfoShareCache",
        "Culture": "en-CH",
        "FrameworkVersion": "4.8.03752",
        "IP": ["fe80::b8b5:103b:c238:7a4e", "172.28.5.120"],
        "InstalledMemory": 5807927296,
    ..... },
     "UserAdminAccessRights": null,
     "UserStore": null }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Root folder not found (10023)
ServiceException	Unknown data type for property type (10035)
ServiceException	Unknown property type (10096)
ServiceException	Verification code is needed: Verification code not yet verified (10152)