Collaboration APIs
Creates a new permission set for a file
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/files/{fileId}/file-permissions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {fileId} |
File identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 4015, version 1 |
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.
Entity
Required/mandatory field
The entity holding the permission. Can be either role (ROT) or user (USR).
>ObjectId
Required/mandatory field
Identifier of the object
>{Integer}</ObjectId>ObjectType
Required/mandatory field
Type of object
Applicable domain values can be found here
>{String}</ObjectType>CanRead
Permission to view the contents of a file. This permission does not inhibit accessibility to see metadata for a file, such as filename, searchtags etc.
Default value: False
This field is optional.
>{Boolean}</CanRead>CanWrite
Permission to make a new version of a file. This permission deos not inhibit a user from updating a files metadata such as filename and searhtags etc
Default value: False
This field is optional.
>{Boolean}</CanWrite>CanDetach
Permission to detach a file from its RamBase Object.
Default value: False
This field is optional.
>{Boolean}</CanDetach>Entity
Required/mandatory field
The entity holding the permission. Can be either role (ROT) or user (USR).
": {ObjectId
Required/mandatory field
Identifier of the object
": "{Integer}",ObjectType
Required/mandatory field
Type of object
Applicable domain values can be found here
": "{String}"CanRead
Permission to view the contents of a file. This permission does not inhibit accessibility to see metadata for a file, such as filename, searchtags etc.
Default value: False
This field is optional.
": "{Boolean}",CanWrite
Permission to make a new version of a file. This permission deos not inhibit a user from updating a files metadata such as filename and searhtags etc
Default value: False
This field is optional.
": "{Boolean}",CanDetach
Permission to detach a file from its RamBase Object.
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.
FilePermissionId
Uniqe identificator for a file type permission.
>{Integer}</FilePermissionId>EntityDescription
Descriptive name for the permission entity
>{String}</EntityDescription>Entity
The entity holding the permission. Can be either role (ROT) or user (USR).
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectLink
API reference to the object
>{String}</ObjectLink>CanRead
Permission to view the contents of a file. This permission does not inhibit accessibility to see metadata for a file, such as filename, searchtags etc.
>{Boolean}</CanRead>CanWrite
Permission to make a new version of a file. This permission deos not inhibit a user from updating a files metadata such as filename and searhtags etc
>{Boolean}</CanWrite>CanDetach
Permission to detach a file from its RamBase Object.
>{Boolean}</CanDetach>FilePermissionLink
Full id reference and object name to this permission
>{String}</FilePermissionLink>FilePermissionId
Uniqe identificator for a file type permission.
": "{Integer}",EntityDescription
Descriptive name for the permission entity
": "{String}",Entity
The entity holding the permission. Can be either role (ROT) or user (USR).
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
Possible domain values can be found here
": "{String}",ObjectLink
API reference to the object
": "{String}"CanRead
Permission to view the contents of a file. This permission does not inhibit accessibility to see metadata for a file, such as filename, searchtags etc.
": "{Boolean}",CanWrite
Permission to make a new version of a file. This permission deos not inhibit a user from updating a files metadata such as filename and searhtags etc
": "{Boolean}",CanDetach
Permission to detach a file from its RamBase Object.
": "{Boolean}",FilePermissionLink
Full id reference and object name to this permission
": "{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 103580 HTTP 404 | Setting definition not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |
| Error 105992 HTTP 403 | This entity already exists in the permissions |