Collaboration APIs
Updates a file type on a unique identifer
| HTTP method | PUT |
| URI | https://api.rambase.net/collaboration/file-types/{fileTypeId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {fileTypeId} |
Unique identifier for a file type
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 3978, version 12 |
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.
FileType
This field is optional.
>Name
Strong typed name for a file type
This field is optional.
>{String}</Name>Description
Descriptive name for a file type
This field is optional.
>{String}</Description>Category
Categorizes files. Image, report, specifications etc. (DOV)
Applicable domain values can be found here
This field is optional.
>{Integer}</Category>IsExternallyApproved
Files coming from external sourced that should not undergo inhouse approval flow.
This field is optional.
>{Boolean}</IsExternallyApproved>AllowNewVersions
Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
This field is optional.
>{Boolean}</AllowNewVersions>IsSystemGenerated
Flag to indicate that a filetype is generated by the system. (Read-only)
This field is optional.
>{Boolean}</IsSystemGenerated>IsExternallyOwned
Flag to lock further binding and linking of a file to other objects that is not the same account or account group
This field is optional.
>{Boolean}</IsExternallyOwned>IsShareable
True if files with this filetype can be shared externally
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
This field is optional.
>{Boolean}</RequireCertificate>FileType
This field is optional.
": {Name
Strong typed name for a file type
This field is optional.
": "{String}",Description
Descriptive name for a file type
This field is optional.
": "{String}",Category
Categorizes files. Image, report, specifications etc. (DOV)
Applicable domain values can be found here
This field is optional.
": "{Integer}",IsExternallyApproved
Files coming from external sourced that should not undergo inhouse approval flow.
This field is optional.
": "{Boolean}",AllowNewVersions
Flag to block new versions of a file. Used to lock the contents of a file awaiting external approval.
This field is optional.
": "{Boolean}",IsSystemGenerated
Flag to indicate that a filetype is generated by the system. (Read-only)
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
This field is optional.
": "{Boolean}",IsShareable
True if files with this filetype can be shared externally
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
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. |
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.
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 |