Method UpdateRemoteFolder

UpdateRemoteFolder(String, RemoteFolderContract, List<String>)

Update a remote folder

Declaration

RemoteFolderContract UpdateRemoteFolder(string connectionId, RemoteFolderContract folder, List<string> documentProperties)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
RemoteFolderContract	folder	Folder to update
System.Collections.Generic.List<System.String>	documentProperties	Ids of the properties which are returned in the Properties[] array of the document.

Returns

Type	Description
RemoteFolderContract	Updated folder

Examples

POST http://YourServerName/InfoShare/Json/RemoteFolder/UpdateRemoteFolder

Example for update a remote folder.

{
   "connectionId": "e3b3b164-9b0b-4d00-9981-83fe4835df1a",
   "folder": {
     "AccessRightsEnum": ["SetMasterColumnConfiguration"],
     "ColumnConfiguration": {
       "Columns": [{
         "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
         "Width": -2 }],
       "GroupedColumnIds": [],
       "InheritProperties": true,
       "ShowAggregateFunctions": false,
       "ShowColumnFilters": false,
       "ShowGroupsExpanded": false,
       "SortedColumns": [] },
     "Documents": [],
     "Id": "db8835d5-30e0-e911-a94a-00155d290a08",
     "ImportTemplateId": "e8ccb88b-17d0-e911-a93a-00155d290a08",
     "Name": "RemoteFolderNew",
     "Path": "1eb9edb4-2ce0-e911-a94a-00155d290a08\\db8835d5-30e0-e911-a94a-00155d290a08",
     "Properties": [],
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "SubFolders": [] }
}

Response:

{
   "UpdateRemoteFolderResult": {
     "AccessRightsEnum": ["SetMasterColumnConfiguration"],
     "ColumnConfiguration": {
       "Columns": [{
         "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
         "Width": -2 }],
       "GroupedColumnIds": [],
       "InheritProperties": true,
       "ShowAggregateFunctions": false,
       "ShowColumnFilters": false,
       "ShowGroupsExpanded": false,
       "SortedColumns": [] },
     "Documents": [],
     "Id": "db8835d5-30e0-e911-a94a-00155d290a08",
     "ImportTemplateId": "e8ccb88b-17d0-e911-a93a-00155d290a08",
     "Name": "RemoteFolderNew",
     "Path": "1eb9edb4-2ce0-e911-a94a-00155d290a08\\db8835d5-30e0-e911-a94a-00155d290a08",
     "Properties": [],
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "SubFolders": [] }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Root folder not found (10023)
ServiceException	Folder not found {folderPath} (10025)
ServiceException	Property type not found {propertyTypeId} (10034)
ServiceException	Unknown data type for property type (10035)
ServiceException	String was not recognized as a valid DateTime: {dateTimeValue}. Expected format {expectedFormat} (10059)
ServiceException	Name is not unique for culture ({culture}): {name} (10066)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Failure while inserting value: '{propertyTypeValue}' into propertyType: {propertyTypeId} (10190)
ServiceException	Property type {propertyTypeId} value is too long: {value} (10179)