Collaboration APIs
Creates a new file folder type
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/file-folder-types |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3983, version 3 |
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
Descriptive name for a folder type
>{String}</Name>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.
Default value: True
This field is optional.
>{Boolean}</IsReadOnly>Name
Required/mandatory field
Descriptive name for a folder type
": "{String}",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.
Default value: True
This field is optional.
": "{Boolean}"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.
FileFolderTypeId
Unique identificator for a folder type
>{Integer}</FileFolderTypeId>Status
The current status of this folder type. Statuses can be: Edit, protected or obsolete
Possible domain values can be found here
>{Integer}</Status>Name
Descriptive name for a folder type
>{String}</Name>TranslatedName
Translated descriptive name for a folder type
>{String}</TranslatedName>Description
Folder type description
>{String}</Description>TranslatedDescripton
Translated folder type description
>{String}</TranslatedDescripton>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>CreatedAt
Date and time when this folder type was created
>{Datetime}</CreatedAt>FileFolderTypeLink
Unique identificator for a folder type
>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>Scope
Scope of a folder type
>{String}</Scope>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>FileFolderTypeId
Unique identificator for a folder type
": "{Integer}",Status
The current status of this folder type. Statuses can be: Edit, protected or obsolete
Possible domain values can be found here
": "{Integer}",Name
Descriptive name for a folder type
": "{String}",TranslatedName
Translated descriptive name for a folder type
": "{String}",Description
Folder type description
": "{String}",TranslatedDescripton
Translated folder type description
": "{String}",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}",CreatedAt
Date and time when this folder type was created
": "{Datetime}",FileFolderTypeLink
Unique identificator for a folder type
": {IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",Scope
Scope of a folder type
": "{String}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{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 104979 HTTP 404 | Folder type id not found |