Collaboration APIs

GET collaboration/file-folders/{fileFolderId}

Gets details for a file folder.

HTTP method	GET
URI	https://api.rambase.net/collaboration/file-folders/{fileFolderId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {fileFolderId}	File folder id for a spesific file container or forlder. Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	3831, version 11

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:

                                        <FileFolder>
                                    

<FileFolderId

FileFolderId

File folder id for a spesific file container or forlder.

>{Integer}</FileFolderId>

<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

Date and time when the folder was created

>{Datetime}</CreatedAt>

<HasChildren

HasChildren

Flag to make known that this folder has children.

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

>{Boolean}</HasChildren>

<FileFolderType

FileFolderType

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.

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

<FileFolderTypeId

FileFolderTypeId

Unique identificator for a folder type

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

>{Integer}</FileFolderTypeId>

<IsReadOnly

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.

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

>{Boolean}</IsReadOnly>

<FileFolderTypeLink

FileFolderTypeLink

Unique identificator for a folder type

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

>{String}</FileFolderTypeLink>

                                             </FileFolderType>
                                    

                                             <ParentFileFolder>
                                    

<FileFolderId

FileFolderId

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

>{Integer}</FileFolderId>

<FileFolderLink

FileFolderLink

File folder id for a spesific file container or forlder.

>{String}</FileFolderLink>

                                             </ParentFileFolder>
                                    

                                             <Owner>
                                    

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ItemType

ItemType

Type of item

>{String}</ItemType>

<ItemId

ItemId

Item-number of the object

>{Integer}</ItemId>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

<ItemLink

ItemLink

API reference to the item

>{String}</ItemLink>

                                             </Owner>
                                    

<FileFolderLink

FileFolderLink

File folder id for a spesific file container or forlder.

>{String}</FileFolderLink>

                                        </FileFolder>
                                    

{

                                             "fileFolder": {
                                    

"fileFolderId

FileFolderId

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

Date and time when the folder was created

": "{Datetime}",

"hasChildren

HasChildren

Flag to make known that this folder has children.

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

": "{Boolean}",

"fileFolderType

FileFolderType

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.

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

": {

"fileFolderTypeId

FileFolderTypeId

Unique identificator for a folder type

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

": "{Integer}",

"isReadOnly

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.

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

": "{Boolean}",

"fileFolderTypeLink

FileFolderTypeLink

Unique identificator for a folder type

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

": "{String}"

},

                                                  "parentFileFolder": {
                                    

"fileFolderId

FileFolderId

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

": "{Integer}",

"fileFolderLink

FileFolderLink

File folder id for a spesific file container or forlder.

": "{String}"

},

                                                  "owner": {
                                    

"objectType

ObjectType

Type of object

": "{String}",

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"itemType

ItemType

Type of item

": "{String}",

"itemId

ItemId

Item-number of the object

": "{Integer}",

"objectLink

ObjectLink

API reference to the object

": "{String}",

"itemLink

ItemLink

API reference to the item

": "{String}"

},

"fileFolderLink

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.

POST

Create FileFolder Job

Create a job that matches the file folder type name. The job that is started will gather files within the context of the folder type and link to the folder.

AOP/100894

Possible error codes the response might return:

Error 104979 HTTP 404

Folder type id not found