API

Collaboration APIs

PUT collaboration/tasks/{taskId}

Updates a task

HTTP method PUT
URI https://api.rambase.net/collaboration/tasks/{taskId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {taskId} Unique task identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2477, version 23

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
<Task
Task

This field is optional.

>
2
     <Status
Status

The status of a task

Applicable domain values can be found here

This field is optional.

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

The title/summary of the task

This field is optional.

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

The description of the task

This field is optional.

>{String}</Description>
5
     <Priority
Priority

The priority of the task.

Applicable domain values can be found here

This field is optional.

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

True if the task is only visible for the creator of the task

This field is optional.

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

Date and time of when this task must be completed.

This field is optional.

>{Datetime}</DeadlineAt>
8
     <StartedAt
StartedAt

The date and time when the task was started (status="In progress")

This field is optional.

>{Datetime}</StartedAt>
9
     <CompletedAt
CompletedAt

The full date and time when a task was completed

This field is optional.

>{Datetime}</CompletedAt>
10
     <Activity
Activity

Task type: Email, Phone call, Followup

Applicable domain values can be found here

This field is optional.

>{Integer}</Activity>
11
     <ReviewedBy
ReviewedBy

Information about the user who approved or rejected the task.

This field is optional.

>
12
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
13
     </ReviewedBy>
14
     <AssignedTo
AssignedTo

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

This field is optional.

>
15
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
16
     </AssignedTo>
17
     <Process
Process

Information about the process this task belongs to.

This field is optional.

>
18
          <ProcessId
ProcessId

Unique identifier for Process

Minimum value: 100000

This field is optional.

>{Integer}</ProcessId>
19
     </Process>
20
     <ResponsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

This field is optional.

>
21
          <RoleId
RoleId

Role identifier

Minimum value: 100000

This field is optional.

>{Integer}</RoleId>
22
     </ResponsibleRole>
23
</Task>
1
{
2
     "task
Task

This field is optional.

": {
3
          "status
Status

The status of a task

Applicable domain values can be found here

This field is optional.

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

The title/summary of the task

This field is optional.

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

The description of the task

This field is optional.

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

The priority of the task.

Applicable domain values can be found here

This field is optional.

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

True if the task is only visible for the creator of the task

This field is optional.

": "{Boolean}",
8
          "deadlineAt
DeadlineAt

Date and time of when this task must be completed.

This field is optional.

": "{Datetime}",
9
          "startedAt
StartedAt

The date and time when the task was started (status="In progress")

This field is optional.

": "{Datetime}",
10
          "completedAt
CompletedAt

The full date and time when a task was completed

This field is optional.

": "{Datetime}",
11
          "activity
Activity

Task type: Email, Phone call, Followup

Applicable domain values can be found here

This field is optional.

": "{Integer}",
12
          "reviewedBy
ReviewedBy

Information about the user who approved or rejected the task.

This field is optional.

": {
13
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
14
          },
15
          "assignedTo
AssignedTo

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

This field is optional.

": {
16
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
17
          },
18
          "process
Process

Information about the process this task belongs to.

This field is optional.

": {
19
               "processId
ProcessId

Unique identifier for Process

Minimum value: 100000

This field is optional.

": "{Integer}"
20
          },
21
          "responsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

This field is optional.

": {
22
               "roleId
RoleId

Role identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
23
          }
24
     }
25
}

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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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.

Format:
1
1

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 101013 HTTP 404 Sub-module not found
Error 105887 HTTP 404 The cause not found.
Error 101420 HTTP 404 Setting definition not found
Error 106156 HTTP 400 Department cannot be empty.
Error 106155 HTTP 400 OccuredAt cannot be empty.
Error 105858 HTTP 400 Responsible cannot be empty.
Error 105061 HTTP 400 Private task cannot be part of a non-private process
Error 105062 HTTP 400 Non-private task cannot be part of a private process
Error 105060 HTTP 400 Private task can be added to a private process only if both were created by the same user
Error 107952 HTTP 400 You are not authorized to change status of this task
Error 108114 HTTP 400 Only pre production tasks can be approved
Error 108125 HTTP 403 You're not authorized to edit the reviewer of this task
Error 107327 HTTP 400 You are not authorized to to approve or reject this task
Error 107367 HTTP 400 Cannot close the task. Unchecked required checklist items remaining.