API

Collaboration APIs

POST collaboration/folders

Creates a new folder

HTTP method POST
URI https://api.rambase.net/collaboration/folders
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5498, version 18

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Folder>
2
     <Name
Name

Required/mandatory field

Verbose folder text in english.

>{String}</Name>
3
     <SortingPriority
SortingPriority

A number that will be used for sorting the company file folder

Minimum value: 1

This field is optional.

>{Integer}</SortingPriority>
4
     <ShortName
ShortName

Short name of the folder

This field is optional.

>{String}</ShortName>
5
     <Tooltip
Tooltip

Tooltip for the folder

This field is optional.

>{String}</Tooltip>
6
     <ParentFolder
ParentFolder

File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.

This field is optional.

>
7
          <FolderId
FolderId

Folder identifier

Minimum value: 100000

Default value: 100000

This field is optional.

>{Integer}</FolderId>
8
     </ParentFolder>
9
</Folder>
1
{
2
     "folder": {
3
          "name
Name

Required/mandatory field

Verbose folder text in english.

": "{String}",
4
          "sortingPriority
SortingPriority

A number that will be used for sorting the company file folder

Minimum value: 1

This field is optional.

": "{Integer}",
5
          "shortName
ShortName

Short name of the folder

This field is optional.

": "{String}",
6
          "tooltip
Tooltip

Tooltip for the folder

This field is optional.

": "{String}",
7
          "parentFolder
ParentFolder

File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.

This field is optional.

": {
8
               "folderId
FolderId

Folder identifier

Minimum value: 100000

Default value: 100000

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Folder>
2
     <FolderId
FolderId

Folder identifier

>{Integer}</FolderId>
3
     <Name
Name

Verbose folder text in english.

>{String}</Name>
4
     <Status
Status

The current status of this folder . Statuses can be: Edit, protected or obsolete

Possible domain values can be found here

>{Integer}</Status>
5
     <CreatedAt
CreatedAt

Time and date when the company file folder was first defined

>{Datetime}</CreatedAt>
6
     <SortingPriority
SortingPriority

A number that will be used for sorting the company file folder

>{Integer}</SortingPriority>
7
     <ShortName
ShortName

Short name of the folder

>{String}</ShortName>
8
     <Tooltip
Tooltip

Tooltip for the folder

>{String}</Tooltip>
9
     <ParentFolder
ParentFolder

File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.

>
10
          <FolderId
FolderId

Folder identifier

>{Integer}</FolderId>
11
          <FolderLink
FolderLink

Company folder id

>{String}</FolderLink>
12
     </ParentFolder>
13
     <FolderLink
FolderLink

Company folder id

>{String}</FolderLink>
14
</Folder>
1
{
2
     "folder": {
3
          "folderId
FolderId

Folder identifier

": "{Integer}",
4
          "name
Name

Verbose folder text in english.

": "{String}",
5
          "status
Status

The current status of this folder . Statuses can be: Edit, protected or obsolete

Possible domain values can be found here

": "{Integer}",
6
          "createdAt
CreatedAt

Time and date when the company file folder was first defined

": "{Datetime}",
7
          "sortingPriority
SortingPriority

A number that will be used for sorting the company file folder

": "{Integer}",
8
          "shortName
ShortName

Short name of the folder

": "{String}",
9
          "tooltip
Tooltip

Tooltip for the folder

": "{String}",
10
          "parentFolder
ParentFolder

File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.

": {
11
               "folderId
FolderId

Folder identifier

": "{Integer}",
12
               "folderLink
FolderLink

Company folder id

": "{String}"
13
          },
14
          "folderLink
FolderLink

Company folder id

": "{String}"
15
     }
16
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 107643 HTTP 404 File folder not found