Collaboration APIs
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 15 |
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.
Name
Required/mandatory field
Verbose folder text in english.
>{String}</Name>SortingPriority
A number that will be used for sorting the company file folder
Minimum value: 1
This field is optional.
>{Integer}</SortingPriority>Visibility
Required/mandatory field
This is the type of folder and how visibile it is going to be.
Shared (SHARED): available accross companies
Company (COM): available in current company
Private (PER): available for the given user
Applicable domain values can be found here
>{String}</Visibility>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.
>FolderId
File folder id for a spesific file container or forlder.
Minimum value: 100000
This field is optional.
>{Integer}</FolderId>Name
Required/mandatory field
Verbose folder text in english.
": "{String}",SortingPriority
A number that will be used for sorting the company file folder
Minimum value: 1
This field is optional.
": "{Integer}",Visibility
Required/mandatory field
This is the type of folder and how visibile it is going to be.
Shared (SHARED): available accross companies
Company (COM): available in current company
Private (PER): available for the given user
Applicable domain values can be found here
": "{String}",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.
": {FolderId
File folder id for a spesific file container or forlder.
Minimum value: 100000
This field is optional.
": "{Integer}"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.
FolderId
File folder id for a spesific file container or forlder.
>{Integer}</FolderId>Name
Verbose folder text in english.
>{String}</Name>Status
The current status of this folder . Statuses can be: Edit, protected or obsolete
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Time and date when the company file folder was first defined
>{Datetime}</CreatedAt>SortingPriority
A number that will be used for sorting the company file folder
>{Integer}</SortingPriority>Visibility
This is the type of folder and how visibile it is going to be.
Shared (SHARED): available accross companies
Company (COM): available in current company
Private (PER): available for the given user
Possible domain values can be found here
>{String}</Visibility>ParentFolder
File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.
>FolderId
File folder id for a spesific file container or forlder.
>{Integer}</FolderId>FolderLink
Company folder id
>{String}</FolderLink>FolderLink
Company folder id
>{String}</FolderLink>FolderId
File folder id for a spesific file container or forlder.
": "{Integer}",Name
Verbose folder text in english.
": "{String}",Status
The current status of this folder . Statuses can be: Edit, protected or obsolete
Possible domain values can be found here
": "{Integer}",CreatedAt
Time and date when the company file folder was first defined
": "{Datetime}",SortingPriority
A number that will be used for sorting the company file folder
": "{Integer}",Visibility
This is the type of folder and how visibile it is going to be.
Shared (SHARED): available accross companies
Company (COM): available in current company
Private (PER): available for the given user
Possible domain values can be found here
": "{String}",ParentFolder
File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.
": {FolderId
File folder id for a spesific file container or forlder.
": "{Integer}",FolderLink
Company folder id
": "{String}"FolderLink
Company folder id
": "{String}"
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 |