Collaboration APIs
Gets details of a task template
| HTTP method | GET |
| 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 | 2485, version 27 |
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.
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.
| $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] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.
TaskTemplateId
TaskTemplate unique identifier
>{Integer}</TaskTemplateId>Status
The status of a task template
Possible domain values can be found here
>{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.
>{Integer}</DeadlineOffset>Description
The description of the task template
>{String}</Description>IsPrivate
-True if the task template is only for the owner
>{Boolean}</IsPrivate>Priority
The task template priority
Possible domain values can be found here
>{Integer}</Priority>Title
The title of a task template
>{String}</Title>AssignedTo
The userId of the person this task will be assigned to (responsible for doing the work)
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ResponsibleRole
Role (department etc.) responsible for a task
>RoleId
Role identifier
>{Integer}</RoleId>Name
Name of the role
>{String}</Name>Description
Description of the role
>{String}</Description>RoleLink
Role reference
>{String}</RoleLink>TaskTemplateLink
Reference to the task template
>{String}</TaskTemplateLink>TaskTemplateId
TaskTemplate unique identifier
": "{Integer}",Status
The status of a task template
Possible domain values can be found here
": "{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.
": "{Integer}",Description
The description of the task template
": "{String}",IsPrivate
-True if the task template is only for the owner
": "{Boolean}",Priority
The task template priority
Possible domain values can be found here
": "{Integer}",Title
The title of a task template
": "{String}",Type
The type of the task
Possible domain values can be found here
": "{String}",AssignedTo
The userId of the person this task will be assigned to (responsible for doing the work)
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"ResponsibleRole
Role (department etc.) responsible for a task
": {RoleId
Role identifier
": "{Integer}",Name
Name of the role
": "{String}",Description
Description of the role
": "{String}",RoleLink
Role reference
": "{String}"TaskTemplateLink
Reference to the task template
": "{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 101606 HTTP 404 | Module not found |