Collaboration APIs
Creates a new file folder
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/file-folders |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3990, version 5 |
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
Verbose folder text in english.
This field is optional.
>{String}</Name>FileFolderType
Required/mandatory field
The type of folder. Folder types differs in system owned which are read only, and work folders. Work folders are the type of open folders for temporary storing files in.
>FileFolderTypeId
Required/mandatory field
Unique identificator for a folder type
Minimum value: 100000
>{Integer}</FileFolderTypeId>ParentFileFolder
This field is optional.
>FileFolderId
File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.
Minimum value: 100000
This field is optional.
>{Integer}</FileFolderId>ObjectType
Required/mandatory field
Type of object
>{String}</ObjectType>ObjectId
Required/mandatory field
Identifier of the object
Minimum value: 1
>{Integer}</ObjectId>ItemId
Item-number of the object
Minimum value: 1
This field is optional.
>{Integer}</ItemId>Name
Verbose folder text in english.
This field is optional.
": "{String}",FileFolderType
Required/mandatory field
The type of folder. Folder types differs in system owned which are read only, and work folders. Work folders are the type of open folders for temporary storing files in.
": {FileFolderTypeId
Required/mandatory field
Unique identificator for a folder type
Minimum value: 100000
": "{Integer}"ParentFileFolder
This field is optional.
": {FileFolderId
File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.
Minimum value: 100000
This field is optional.
": "{Integer}"ObjectType
Required/mandatory field
Type of object
": "{String}",ObjectId
Required/mandatory field
Identifier of the object
Minimum value: 1
": "{Integer}",ItemId
Item-number of the object
Minimum value: 1
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.
FileFolderId
File folder id for a spesific file container or forlder.
>{Integer}</FileFolderId>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
Date and time when the folder was created
>FileFolderTypeId
Unique identificator for a folder type
>{Integer}</FileFolderTypeId>IsReadOnly
The type of folder. Folder types differs in system owned which are read only, and work folders. Work folders are the type of open folders for temporary storing files in.
>{Boolean}</IsReadOnly>FileFolderTypeLink
Unique identificator for a folder type
>{String}</FileFolderTypeLink>FileFolderId
File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.
>{Integer}</FileFolderId>FileFolderLink
File folder id for a spesific file container or forlder.
>{String}</FileFolderLink>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ItemType
Type of item
>{String}</ItemType>ItemId
Item-number of the object
>{Integer}</ItemId>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>FileFolderLink
File folder id for a spesific file container or forlder.
>{String}</FileFolderLink>FileFolderId
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
Date and time when the folder was created
": {FileFolderTypeId
Unique identificator for a folder type
": "{Integer}",IsReadOnly
The type of folder. Folder types differs in system owned which are read only, and work folders. Work folders are the type of open folders for temporary storing files in.
": "{Boolean}",FileFolderTypeLink
Unique identificator for a folder type
": "{String}"FileFolderId
File folders can be nested. The parent folderid is used to place the current folder in relation to its parent.
": "{Integer}",FileFolderLink
File folder id for a spesific file container or forlder.
": "{String}"ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemId
Item-number of the object
": "{Integer}",ObjectLink
API reference to the object
": "{String}",ItemLink
API reference to the item
": "{String}"FileFolderLink
File folder id for a spesific file container or forlder.
": "{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 104980 HTTP 404 | File folder not found |