Collaboration APIs
Creates a new file type
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/file-types |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3976, 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.
Name
Required/mandatory field
Strong typed name for a file type
>{String}</Name>Category
Categorizes files. Image, report, specifications etc. (DOV)
Applicable domain values can be found here
This field is optional.
>{Integer}</Category>Description
Descriptive name for a file type
This field is optional.
>{String}</Description>AllowNewVersions
Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
Default value: True
This field is optional.
>{Boolean}</AllowNewVersions>IsExternallyOwned
Flag to lock further binding and linking of a file to other objects that is not the same account or account group
Default value: False
This field is optional.
>{Boolean}</IsExternallyOwned>IsExternallyApproved
Files coming from external sourced that should not undergo inhouse approval flow.
Default value: False
This field is optional.
>{Boolean}</IsExternallyApproved>IsShareable
True if files with this filetype can be shared externally
Default value: True
This field is optional.
>{Boolean}</IsShareable>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
Default value: False
This field is optional.
>{Boolean}</RequireCertificate>Name
Required/mandatory field
Strong typed name for a file type
": "{String}",Category
Categorizes files. Image, report, specifications etc. (DOV)
Applicable domain values can be found here
This field is optional.
": "{Integer}",Description
Descriptive name for a file type
This field is optional.
": "{String}",AllowNewVersions
Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
Default value: True
This field is optional.
": "{Boolean}",IsExternallyOwned
Flag to lock further binding and linking of a file to other objects that is not the same account or account group
Default value: False
This field is optional.
": "{Boolean}",IsExternallyApproved
Files coming from external sourced that should not undergo inhouse approval flow.
Default value: False
This field is optional.
": "{Boolean}",IsShareable
True if files with this filetype can be shared externally
Default value: True
This field is optional.
": "{Boolean}",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
Default value: False
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.
FileTypeId
Unique identifier for a file type
>{Integer}</FileTypeId>Status
Status of a file type is edit, protected or obsolete.
Possible domain values can be found here
>{Integer}</Status>Name
Strong typed name for a file type
>{String}</Name>Category
Categorizes files. Image, report, specifications etc. (DOV)
Possible domain values can be found here
>{Integer}</Category>TranslatedName
Translated strong typed name for a file type.
>{String}</TranslatedName>Description
Descriptive name for a file type
>{String}</Description>TranslatedDescripton
Translated description of a file type
>{String}</TranslatedDescripton>CreatedAt
Time and date when the file type was first defined
>{Datetime}</CreatedAt>AllowNewVersions
Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
>{Boolean}</AllowNewVersions>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
Files coming from external sourced that should not undergo inhouse approval flow.
>{Boolean}</IsExternallyApproved>IsSystemGenerated
Flag to indicate that a filetype is generated by the system. (Read-only)
>{Boolean}</IsSystemGenerated>IsShareable
True if files with this filetype can be shared externally
>{Boolean}</IsShareable>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>FileTypeId
Unique identifier for a file type
": "{Integer}",Status
Status of a file type is edit, protected or obsolete.
Possible domain values can be found here
": "{Integer}",Name
Strong typed name for a file type
": "{String}",Category
Categorizes files. Image, report, specifications etc. (DOV)
Possible domain values can be found here
": "{Integer}",TranslatedName
Translated strong typed name for a file type.
": "{String}",Description
Descriptive name for a file type
": "{String}",TranslatedDescripton
Translated description of a file type
": "{String}",CreatedAt
Time and date when the file type was first defined
": "{Datetime}",AllowNewVersions
Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
": "{Boolean}",IsExternallyOwned
Flag to lock further binding and linking of a file to other objects that is not the same account or account group
": "{Boolean}",IsExternallyApproved
Files coming from external sourced that should not undergo inhouse approval flow.
": "{Boolean}",IsSystemGenerated
Flag to indicate that a filetype is generated by the system. (Read-only)
": "{Boolean}",IsShareable
True if files with this filetype can be shared externally
": "{Boolean}",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}"
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 101079 HTTP 400 | Mismatch in size of revision parameters |
| Error 101551 HTTP 404 | Object {0} not found |