Collaboration APIs
Creates a new task process template
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/task-process-templates |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 2499, version 9 |
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.
Name
Required/mandatory field
Name of the task process template
>{String}</Name>Description
Description of a task-process template
This field is optional.
>{String}</Description>Type
The type of the process
Applicable domain values can be found here
This field is optional.
>{Integer}</Type>ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
>RoleId
Role identifier
Minimum value: 100000
This field is optional.
>{Integer}</RoleId>Name
Required/mandatory field
Name of the task process template
": "{String}",Description
Description of a task-process template
This field is optional.
": "{String}",Type
The type of the process
Applicable domain values can be found here
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. |
| $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.
TaskProcessTemplateId
Unique identifier for task process template
>{Integer}</TaskProcessTemplateId>Description
Description of a task-process template
>{String}</Description>Name
Name of the task process template
>{String}</Name>Status
Status of a task process template
Possible domain values can be found here
>{Integer}</Status>TotalTaskTemplates
Number of task templates being assigned to the process template
>{Integer}</TotalTaskTemplates>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>TaskProcessTemplateId
Unique identifier for task process template
": "{Integer}",Type
The type of the process
Possible domain values can be found here
": "{Integer}",Description
Description of a task-process template
": "{String}",Name
Name of the task process template
": "{String}",Status
Status of a task process template
Possible domain values can be found here
": "{Integer}",TotalTaskTemplates
Number of task templates being assigned to the process template
": "{Integer}",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}"
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 102699 HTTP 404 | Task template was not found |
| Error 107255 HTTP 404 | Task template permission set not found |
| Error 106965 HTTP 400 | This entity already exists in the task permissions |