Collaboration APIs

GET collaboration/folders/{folderId}

Gets details of a folder

HTTP method	GET
URI	https://api.rambase.net/collaboration/folders/{folderId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {folderId}	File folder id for a spesific file container or forlder. Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	5472, 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.

Format:

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
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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. Fields colored in grey is expandable fields.

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

Format:

                                        <Folder>
                                    

<FolderId

FolderId

File folder id for a spesific file container or forlder.

>{Integer}</FolderId>

<Name

Name

Verbose folder text in english.

>{String}</Name>

<Status

Status

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

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Time and date when the company file folder was first defined

>{Datetime}</CreatedAt>

<SortingPriority

SortingPriority

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

>{Integer}</SortingPriority>

<Visibility

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>

<ExternalReference

ExternalReference

Internal field. Used to map folders from external systems to RamBase folders

This field is greyed out because it is an expandable field. You have to add $expand=ExternalReference in your request URI to get this field

>{String}</ExternalReference>

<ParentFolder

ParentFolder

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

<FolderId

FolderId

File folder id for a spesific file container or forlder.

>{Integer}</FolderId>

<FolderLink

FolderLink

Company folder id

>{String}</FolderLink>

                                             </ParentFolder>
                                    

<FolderLink

FolderLink

Company folder id

>{String}</FolderLink>

                                        </Folder>
                                    

{

                                             "folder": {
                                    

"folderId

FolderId

File folder id for a spesific file container or forlder.

": "{Integer}",

"name

Name

Verbose folder text in english.

": "{String}",

"status

Status

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

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Time and date when the company file folder was first defined

": "{Datetime}",

"sortingPriority

SortingPriority

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

": "{Integer}",

"visibility

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}",

"externalReference

ExternalReference

Internal field. Used to map folders from external systems to RamBase folders

This field is greyed out because it is an expandable field. You have to add $expand=ExternalReference in your request URI to get this field

": "{String}",

"parentFolder

ParentFolder

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

": {

"folderId

FolderId

File folder id for a spesific file container or forlder.

": "{Integer}",

"folderLink

FolderLink

Company folder id

": "{String}"

},

"folderLink

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