API

Collaboration APIs

POST collaboration/task-templates

Creates a new task template

HTTP method POST
URI https://api.rambase.net/collaboration/task-templates
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2488, version 13

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.

Format:
1
<TaskTemplate>
2
     <DeadlineOffset
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>
3
     <Description
Description

The description of the task template

This field is optional.

>
{String}</Description>
4
     <IsPrivate
IsPrivate

-True if the task template is only for the owner

Default value: False

This field is optional.

>
{Boolean}</IsPrivate>
5
     <Priority
Priority

The task template priority

Applicable domain values can be found here

Default value: 3

This field is optional.

>
{Integer}</Priority>
6
     <Title
Title

Required/mandatory field

The title of a task template

>
{String}</Title>
7
     <Type
Type

The type of the task

Applicable domain values can be found here

This field is optional.

>
{String}</Type>
8
     <AssignedTo
AssignedTo

The userId of the person this task will be assigned to (responsible for doing the work)

This field is optional.

>
9
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
10
     </AssignedTo>
11
     <TaskProcessTemplate
TaskProcessTemplate

refers to the process template this task template belongs to

This field is optional.

>
12
          <TaskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

Minimum value: 100000

This field is optional.

>
{Integer}</TaskProcessTemplateId>
13
     </TaskProcessTemplate>
14
     <ResponsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

This field is optional.

>
15
          <RoleId
RoleId

Role identifier

Minimum value: 100000

This field is optional.

>
{Integer}</RoleId>
16
     </ResponsibleRole>
17
</TaskTemplate>
1
{
2
     "taskTemplate": {
3
          "deadlineOffset
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}",
4
          "description
Description

The description of the task template

This field is optional.

":
"{String}",
5
          "isPrivate
IsPrivate

-True if the task template is only for the owner

Default value: False

This field is optional.

":
"{Boolean}",
6
          "priority
Priority

The task template priority

Applicable domain values can be found here

Default value: 3

This field is optional.

":
"{Integer}",
7
          "title
Title

Required/mandatory field

The title of a task template

":
"{String}",
8
          "type
Type

The type of the task

Applicable domain values can be found here

This field is optional.

":
"{String}",
9
          "assignedTo
AssignedTo

The userId of the person this task will be assigned to (responsible for doing the work)

This field is optional.

":
{
10
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
11
          },
12
          "taskProcessTemplate
TaskProcessTemplate

refers to the process template this task template belongs to

This field is optional.

":
{
13
               "taskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

Minimum value: 100000

This field is optional.

":
"{Integer}"
14
          },
15
          "responsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

This field is optional.

":
{
16
               "roleId
RoleId

Role identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
17
          }
18
     }
19
}

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.

Format:
1
<TaskTemplate>
2
     <TaskTemplateId
TaskTemplateId

TaskTemplate unique identifier

>
{Integer}</TaskTemplateId>
3
     <Status
Status

The status of a task template

Possible domain values can be found here

>
{Integer}</Status>
4
     <DeadlineOffset
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>
5
     <Description
Description

The description of the task template

>
{String}</Description>
6
     <IsPrivate
IsPrivate

-True if the task template is only for the owner

>
{Boolean}</IsPrivate>
7
     <Priority
Priority

The task template priority

Possible domain values can be found here

>
{Integer}</Priority>
8
     <Title
Title

The title of a task template

>
{String}</Title>
9
     <Type
Type

The type of the task

Possible domain values can be found here

>
{String}</Type>
10
     <AssignedTo
AssignedTo

The userId of the person this task will be assigned to (responsible for doing the work)

>
11
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
12
          <LastName
LastName

Last name of employee

>
{String}</LastName>
13
          <FirstName
FirstName

First name of employee

>
{String}</FirstName>
14
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
15
          <TaskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

>
{Integer}</TaskProcessTemplateId>
16
          <TaskProcessTemplateLink
TaskProcessTemplateLink

Unique identifier for task process template

>
{String}</TaskProcessTemplateLink>
17
     </AssignedTo>
18
     <ResponsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

>
19
          <RoleId
RoleId

Role identifier

>
{Integer}</RoleId>
20
          <Name
Name

Name of the role

>
{String}</Name>
21
          <Description
Description

Description of the role

>
{String}</Description>
22
          <RoleLink
RoleLink

Role reference

>
{String}</RoleLink>
23
     </ResponsibleRole>
24
     <TaskTemplateLink
TaskTemplateLink

Reference to the task template

>
{String}</TaskTemplateLink>
25
</TaskTemplate>
1
{
2
     "taskTemplate": {
3
          "taskTemplateId
TaskTemplateId

TaskTemplate unique identifier

":
"{Integer}",
4
          "status
Status

The status of a task template

Possible domain values can be found here

":
"{Integer}",
5
          "deadlineOffset
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}",
6
          "description
Description

The description of the task template

":
"{String}",
7
          "isPrivate
IsPrivate

-True if the task template is only for the owner

":
"{Boolean}",
8
          "priority
Priority

The task template priority

Possible domain values can be found here

":
"{Integer}",
9
          "title
Title

The title of a task template

":
"{String}",
10
          "type
Type

The type of the task

Possible domain values can be found here

":
"{String}",
11
          "assignedTo
AssignedTo

The userId of the person this task will be assigned to (responsible for doing the work)

":
{
12
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
13
               "lastName
LastName

Last name of employee

":
"{String}",
14
               "firstName
FirstName

First name of employee

":
"{String}",
15
               "employeeLink
EmployeeLink

Employee reference

":
"{String}",
16
               "taskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

":
"{Integer}",
17
               "taskProcessTemplateLink
TaskProcessTemplateLink

Unique identifier for task process template

":
"{String}"
18
          },
19
          "responsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

":
{
20
               "roleId
RoleId

Role identifier

":
"{Integer}",
21
               "name
Name

Name of the role

":
"{String}",
22
               "description
Description

Description of the role

":
"{String}",
23
               "roleLink
RoleLink

Role reference

":
"{String}"
24
          },
25
          "taskTemplateLink
TaskTemplateLink

Reference to the task template

":
"{String}"
26
     }
27
}

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
Error 107255 HTTP 404 Task template permission set not found
Error 106965 HTTP 400 This entity already exists in the task permissions