Collaboration APIs
Creates a new permission set for a task process
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/task-processes/{processId}/permissions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {processId} |
Unique identifier for Process
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 5062, version 5 |
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 employee (PER).
>ObjectId
Required/mandatory field
Identifier of the object
Minimum value: 100
>{Integer}</ObjectId>ObjectType
Required/mandatory field
Type of object
Applicable domain values can be found here
>{String}</ObjectType>CanView
Grants permission to view process and underlyig tasks
Default value: True
This field is optional.
>{Boolean}</CanView>CanEdit
Grants permission to edit process and underlying tasks
Default value: True
This field is optional.
>{Boolean}</CanEdit>CanDelete
Grants permission to delete process and underlying tasks
Default value: True
This field is optional.
>{Boolean}</CanDelete>CanAssign
Grants permission to assign underlying tasks
Default value: True
This field is optional.
>{Boolean}</CanAssign>Entity
Required/mandatory field
The entity holding the permission. Can be either role (ROT) or employee (PER).
": {ObjectId
Required/mandatory field
Identifier of the object
Minimum value: 100
": "{Integer}",ObjectType
Required/mandatory field
Type of object
Applicable domain values can be found here
": "{String}"CanView
Grants permission to view process and underlyig tasks
Default value: True
This field is optional.
": "{Boolean}",CanEdit
Grants permission to edit process and underlying tasks
Default value: True
This field is optional.
": "{Boolean}",CanDelete
Grants permission to delete process and underlying tasks
Default value: True
This field is optional.
": "{Boolean}",CanAssign
Grants permission to assign underlying tasks
Default value: True
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.
TaskProcessPermissionId
Uniqe identificator for a task process permission.
>{Integer}</TaskProcessPermissionId>Entity
The entity holding the permission. Can be either role (ROT) or employee (PER).
>Name
Name of a role or user
>{String}</Name>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectLink
API reference to the object
>{String}</ObjectLink>CanView
Grants permission to view process and underlyig tasks
>{Boolean}</CanView>CanEdit
Grants permission to edit process and underlying tasks
>{Boolean}</CanEdit>CanDelete
Grants permission to delete process and underlying tasks
>{Boolean}</CanDelete>CanAssign
Grants permission to assign underlying tasks
>{Boolean}</CanAssign>TaskProcessPermissionId
Uniqe identificator for a task process permission.
": "{Integer}",Entity
The entity holding the permission. Can be either role (ROT) or employee (PER).
": {Name
Name of a role or user
": "{String}",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}"CanView
Grants permission to view process and underlyig tasks
": "{Boolean}",CanEdit
Grants permission to edit process and underlying tasks
": "{Boolean}",CanDelete
Grants permission to delete process and underlying tasks
": "{Boolean}",CanAssign
Grants permission to assign underlying tasks
": "{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 101030 HTTP 404 | Role not found |
| Error 106934 HTTP 404 | Task permission set not found |
| Error 106933 HTTP 400 | ObjectId is required |
| Error 106965 HTTP 400 | This entity already exists in the task permissions |
| Error 107820 HTTP 400 | It is not allowed to add more than 300 permission rulesets per task |