Collaboration APIs

GET collaboration/file-types

Lists all file types

HTTP method	GET
URI	https://api.rambase.net/collaboration/file-types
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	500
Successful HTTP status code	200
API resource identifier	3975, version 24

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
$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.

ActiveFiletypes() Named filter	List only filetypes in stats 4
AllowNewVersions Boolean	Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
Category Integer	Categorizes files. Image, report, specifications etc. (DOV).
ContainingRamBaseKeyReference String	Referenced document.
CreatedAt Datetime	Time and date when the file type was first defined. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedById Integer	User identifier. Available macros: currentUser()
Description String	Descriptive name for a file type.
FileTypeId Integer	Unique identifier for a file type.
FileTypeStatus Integer	Status of a file type is edit, protected or obsolete.
IsExternallyApproved Boolean	Files coming from external sourced that should not undergo inhouse approval flow.
IsExternallyOwned Boolean	Flag to lock further binding and linking of a file to other objects that is not the same account or account group.
IsShareable Boolean	True if files with this filetype can be shared externally.
IsSystemGenerated Boolean	Flag to indicate that a filetype is generated by the system. (Read-only).
Name String	Strong typed name for a file type.
RequireCertificate Boolean	Flag to indicate that uploading a file using this file type also requires a certificate from the uploader to sign and authenticate the file.
Status Integer	Status of file version.

Read more about filters and sorting on how to use sortable parameters

AllowNewVersions Boolean	Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
Category Integer	Categorizes files. Image, report, specifications etc. (DOV)
ContainingRamBaseKeyReference String	Referenced document
CreatedAt Datetime	Time and date when the file type was first defined
CreatedById Integer	User identifier
Description String	Descriptive name for a file type
FileTypeId Integer	Unique identifier for a file type
FileTypeStatus Integer	Status of a file type is edit, protected or obsolete.
IsExternallyApproved Boolean	Files coming from external sourced that should not undergo inhouse approval flow.
IsExternallyOwned Boolean	Flag to lock further binding and linking of a file to other objects that is not the same account or account group
IsShareable Boolean	True if files with this filetype can be shared externally
IsSystemGenerated Boolean	Flag to indicate that a filetype is generated by the system. (Read-only)
Name String	Strong typed name for a file type
RequireCertificate Boolean	Flag to indicate that uploading a file using this file type also requires a certificate from the uploader to sign and authenticate the file
Status Integer	Status of file version

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:

                                        <FileTypes>
                                    

                                             <FileType>
                                    

<FileTypeId

FileTypeId

Unique identifier for a file type

>{Integer}</FileTypeId>

<Status

Status

Status of a file type is edit, protected or obsolete.

Possible domain values can be found here

>{Integer}</Status>

<Name

Name

Strong typed name for a file type

>{String}</Name>

<Category

TranslatedName

Translated strong typed name for a file type.

>{String}</TranslatedName>

<Description

Description

Descriptive name for a file type

>{String}</Description>

<TranslatedDescripton

TranslatedDescripton

Translated description of a file type

>{String}</TranslatedDescripton>

<CreatedAt

CreatedAt

Time and date when the file type was first defined

>{Datetime}</CreatedAt>

<AllowNewVersions

AllowNewVersions

Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.

>{Boolean}</AllowNewVersions>

<IsExternallyOwned

IsExternallyOwned

Flag to lock further binding and linking of a file to other objects that is not the same account or account group

>{Boolean}</IsExternallyOwned>

<IsExternallyApproved

IsExternallyApproved

Files coming from external sourced that should not undergo inhouse approval flow.

>{Boolean}</IsExternallyApproved>

<IsSystemGenerated

IsSystemGenerated

Flag to indicate that a filetype is generated by the system. (Read-only)

>{Boolean}</IsSystemGenerated>

<IsShareable

IsShareable

True if files with this filetype can be shared externally

>{Boolean}</IsShareable>

<FileTypeLink

FileTypeLink

Unique identifier for a file type

>{String}</FileTypeLink>

<RequireCertificate

RequireCertificate

Flag to indicate that uploading a file using this file type also requires a certificate from the uploader to sign and authenticate the file

>{Boolean}</RequireCertificate>

                                             </FileType>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </FileTypes>
                                    

{

                                             "fileTypes": [
                                    

{

"fileTypeId

FileTypeId

Unique identifier for a file type

": "{Integer}",

"status

Status

Status of a file type is edit, protected or obsolete.

Flag to indicate that uploading a file using this file type also requires a certificate from the uploader to sign and authenticate the file

": "{Boolean}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

Page key to use for navigating to last page in the list

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

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

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 104978 HTTP 404

File type is not found