Collaboration APIs
Lists folders
| HTTP method | GET |
| URI | https://api.rambase.net/collaboration/folders |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 400 |
| Successful HTTP status code | 200 |
| API resource identifier | 5499, version 23 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| CreatedAt Datetime | Time and date when the company file folder was first defined. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ExternalReference String | Internal field. Used to map folders from external systems to RamBase folders. |
| FolderId Integer | File folder id for a spesific file container or forlder. |
| Name String | Verbose folder text in english. |
| ParentFolderId Integer | File folders can be nested. The parent folderid is used to place the current folder in relation to its parent. |
| SortingPriority Integer | A number that will be used for sorting the company file folder. |
| Status Integer | The current status of this folder . Statuses can be: Edit, protected or obsolete. |
| Visibility String | 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. |
Read more about filters and sorting on how to use sortable parameters
| CreatedAt Datetime | Time and date when the company file folder was first defined |
| ExternalReference String | Internal field. Used to map folders from external systems to RamBase folders |
| FolderId Integer | File folder id for a spesific file container or forlder. |
| Name String | Verbose folder text in english. |
| ParentFolderId Integer | File folders can be nested. The parent folderid is used to place the current folder in relation to its parent. |
| SortingPriority Integer | A number that will be used for sorting the company file folder |
| Status Integer | The current status of this folder . Statuses can be: Edit, protected or obsolete |
| Visibility String | 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 |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable 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>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>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}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 |