Collaboration APIs
Updates main fields on a task template
| HTTP method | PUT |
| URI | https://api.rambase.net/collaboration/task-templates/{taskTemplateId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {taskTemplateId} |
TaskTemplate unique identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2487, 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.
TaskTemplate
This field is optional.
>Status
The status of a task template
Applicable domain values can be found here
This field is optional.
>{Integer}</Status>DeadlineOffset
Days offset to the Process DEADLINE. If this is set to 4 (just an example), the deadline of this task will be calculated to 4 days after the process deadline.
Minimum value: 0
This field is optional.
>{Integer}</DeadlineOffset>Description
The description of the task template
This field is optional.
>{String}</Description>IsPrivate
-True if the task template is only for the owner
This field is optional.
>{Boolean}</IsPrivate>Priority
The task template priority
Applicable domain values can be found here
This field is optional.
>{Integer}</Priority>Title
The title of a task template
This field is optional.
>{String}</Title>Type
The type of the task
Applicable domain values can be found here
This field is optional.
>{String}</Type>AssignedTo
The userId of the person this task will be assigned to (responsible for doing the work)
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>TaskProcessTemplate
refers to the process template this task template belongs to
This field is optional.
>TaskProcessTemplateId
Unique identifier for task process template
Minimum value: 100000
This field is optional.
>{Integer}</TaskProcessTemplateId>ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
>RoleId
Role identifier
Minimum value: 100000
This field is optional.
>{Integer}</RoleId>TaskTemplate
This field is optional.
": {Status
The status of a task template
Applicable domain values can be found here
This field is optional.
": "{Integer}",DeadlineOffset
Days offset to the Process DEADLINE. If this is set to 4 (just an example), the deadline of this task will be calculated to 4 days after the process deadline.
Minimum value: 0
This field is optional.
": "{Integer}",Description
The description of the task template
This field is optional.
": "{String}",IsPrivate
-True if the task template is only for the owner
This field is optional.
": "{Boolean}",Priority
The task template priority
Applicable domain values can be found here
This field is optional.
": "{Integer}",Title
The title of a task template
This field is optional.
": "{String}",Type
The type of the task
Applicable domain values can be found here
This field is optional.
": "{String}",AssignedTo
The userId of the person this task will be assigned to (responsible for doing the work)
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"TaskProcessTemplate
refers to the process template this task template belongs to
This field is optional.
": {TaskProcessTemplateId
Unique identifier for task process template
Minimum value: 100000
This field is optional.
": "{Integer}"ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
": {RoleId
Role identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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 101606 HTTP 404 | Module not found |