Method CreateFolder
CreateFolder(String, FolderContract)
Create a folder
Declaration
FolderContract CreateFolder(string connectionId, FolderContract folder)
Parameters
Type | Name | Description |
---|---|---|
System.String | connectionId |
|
FolderContract | folder | Folder to create |
Returns
Type | Description |
---|---|
FolderContract | The created folder id |
Examples
POST http://YourServerName/InfoShare/Json/Folder/CreateFolder
Example for create a folder.{
"connectionId": "23a97160-3a3d-4acf-bb93-8040848440f4",
"folder": {
"Properties": [],
"SubFolders": [],
"SearchFolders": [],
"Documents": [],
"HasDocuments": false,
"Processes": [],
"ColumnConfiguration": {
"Columns": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2 }],
"GroupedColumnIds": [],
"SortedColumns": [],
"InheritProperties": true,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false },
"ColumnConfigurationResolved": {
"Columns": [],
"GroupedColumnIds": [],
"SortedColumns": [],
"InheritProperties": false,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false },
"Name": {
"Values": [{
"Text": "testFolder",
"Culture": "de" }] },
"ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
"Path": {
"FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
"Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08" } }
}
Response:
{
"CreateFolderResult": {
"AccessRightsEnum": ["SetSecurity", "Delete", "EditProperties", "EditFolder",
"SetMasterColumnConfiguration", "CreateQuery", "CreateFolder"],
"ColumnConfiguration": {
"Columns": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2 }],
"GroupedColumnIds": [],
"InheritProperties": true,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false,
"SortedColumns": [] },
"ColumnConfigurationResolved": {
"Columns": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2 }],
"GroupedColumnIds": [],
"InheritProperties": true,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false,
"SortedColumns": [] },
"Documents": [],
"HasDocuments": false,
"Id": "c5eab4be-a4de-e911-a948-00155d290a08",
"ImportTemplateId": null,
"Name": {
"Values": [{
"Culture": "de",
"Text": "testFolder" }] },
"Path": {
"Culture": "en-US",
"FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
"Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08
\\c5eab4be-a4de-e911-a948-00155d290a08",
"PathGlobal": {
"Values": [{
"Culture": "de",
"Text": "Allgemeine Suche\\testFolder" }, {
"Culture": "en",
"Text": "Default search\\testFolder" }] } },
"Processes": [],
"Properties": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Values": ["testFolder"] }, {
"PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
"Values": ["0100a000-38a7-11d8-a902-0050bf427e8f"] }],
"ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
"SearchFolders": [],
"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 | Object with id {id} already exists (10078) |
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) |
ServiceException | Not allowed (10014) |