API

Collaboration APIs

GET collaboration/tasks/{taskId}

Will return details of one specific task.

HTTP method GET
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 2455, version 48

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
1

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.
$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
<Task>
2
     <TaskId
TaskId

Unique task identifier

>{Integer}</TaskId>
3
     <Type
Type

The type of the task

Possible domain values can be found here

>{String}</Type>
4
     <Status
Status

The status of a task

Possible domain values can be found here

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

The title/summary of the task

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

The description of the task

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

The priority of the task.

Possible domain values can be found here

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

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

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

Date and time of when this task must be completed.

>{Datetime}</DeadlineAt>
10
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
11
     <StartedAt
StartedAt

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

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

The full date and time when a task was completed

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

Task type: Email, Phone call, Followup

Possible domain values can be found here

>{Integer}</Activity>
14
     <TotalRegisteredHours
TotalRegisteredHours

Aggregate hours registered for task

>{Decimal}</TotalRegisteredHours>
15
     <CompletedBy
CompletedBy

The user who completed the task

>
16
          <UserId
UserId

User identifier

>{Integer}</UserId>
17
          <Name
Name

Name of the user

>{String}</Name>
18
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
19
          <UserLink
UserLink

User reference

>{String}</UserLink>
20
     </CompletedBy>
21
     <ReviewedBy
ReviewedBy

Information about the user who approved or rejected the task.

>
22
          <UserId
UserId

User identifier

>{Integer}</UserId>
23
          <Name
Name

Name of the user

>{String}</Name>
24
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
25
          <UserLink
UserLink

User reference

>{String}</UserLink>
26
     </ReviewedBy>
27
     <CreatedBy
CreatedBy

Information about the user who created the task.

>
28
          <UserId
UserId

User identifier

>{Integer}</UserId>
29
          <Name
Name

Name of the user

>{String}</Name>
30
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
31
          <UserLink
UserLink

User reference

>{String}</UserLink>
32
     </CreatedBy>
33
     <CurrentUserPermissions
CurrentUserPermissions

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

>
34
          <CanView
CanView

Grants permission to view task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanView>
35
          <CanEdit
CanEdit

Grants permission to edit task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanEdit>
36
          <CanDelete
CanDelete

Grants permission to delete task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanDelete>
37
          <CanAssign
CanAssign

Grants permission to assign task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanAssign>
38
          <CanChangeStatus
CanChangeStatus

Grants permission to assign task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanChangeStatus>
39
     </CurrentUserPermissions>
40
     <CreatedInCompany
CreatedInCompany

The compnay the task was created in

>
41
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
42
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
43
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
44
     </CreatedInCompany>
45
     <AssignedTo
AssignedTo

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

>
46
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
50
     </AssignedTo>
51
     <Process
Process

Information about the process this task belongs to.

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

>
52
          <ProcessId
ProcessId

Unique identifier for Process

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

>{Integer}</ProcessId>
53
          <Name
Name

The name of this process

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

>{String}</Name>
54
          <DeadlineAt
DeadlineAt

Date and time for all the Tasks under a process to be completed

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

>{Datetime}</DeadlineAt>
55
          <ProcessLink
ProcessLink

Task-process reference

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

>{String}</ProcessLink>
56
     </Process>
57
     <Folder
Folder

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

>
58
          <FolderId
FolderId

File folder id for a spesific file container or forlder.

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

>{Integer}</FolderId>
59
          <Name
Name

Verbose folder text in english.

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

>{String}</Name>
60
          <FolderLink
FolderLink

Company folder id

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

>{String}</FolderLink>
61
     </Folder>
62
     <ResponsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

>
63
          <RoleId
RoleId

Role identifier

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

Name of the role

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

Description of the role

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

Role reference

>{String}</RoleLink>
67
     </ResponsibleRole>
68
     <TaskLink
TaskLink

Task reference

>{String}</TaskLink>
69
</Task>
1
{
2
     "task": {
3
          "taskId
TaskId

Unique task identifier

": "{Integer}",
4
          "type
Type

The type of the task

Possible domain values can be found here

": "{String}",
5
          "status
Status

The status of a task

Possible domain values can be found here

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

The title/summary of the task

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

The description of the task

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

The priority of the task.

Possible domain values can be found here

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

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

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

Date and time of when this task must be completed.

": "{Datetime}",
11
          "createdAt
CreatedAt

Date and time of creation

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

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

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

The full date and time when a task was completed

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

Task type: Email, Phone call, Followup

Possible domain values can be found here

": "{Integer}",
15
          "totalRegisteredHours
TotalRegisteredHours

Aggregate hours registered for task

": "{Decimal}",
16
          "completedBy
CompletedBy

The user who completed the task

": {
17
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
20
               "userLink
UserLink

User reference

": "{String}"
21
          },
22
          "reviewedBy
ReviewedBy

Information about the user who approved or rejected the task.

": {
23
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
26
               "userLink
UserLink

User reference

": "{String}"
27
          },
28
          "createdBy
CreatedBy

Information about the user who created the task.

": {
29
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
32
               "userLink
UserLink

User reference

": "{String}"
33
          },
34
          "currentUserPermissions
CurrentUserPermissions

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

": {
35
               "canView
CanView

Grants permission to view task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

": "{Boolean}",
36
               "canEdit
CanEdit

Grants permission to edit task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

": "{Boolean}",
37
               "canDelete
CanDelete

Grants permission to delete task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

": "{Boolean}",
38
               "canAssign
CanAssign

Grants permission to assign task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

": "{Boolean}",
39
               "canChangeStatus
CanChangeStatus

Grants permission to assign task

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserPermissions in your request URI to get this field

": "{Boolean}"
40
          },
41
          "createdInCompany
CreatedInCompany

The compnay the task was created in

": {
42
               "companyId
CompanyId

Company identifier

": "{Integer}",
43
               "database
Database

Abbreviation/code to identify the company

": "{String}",
44
               "companyLink
CompanyLink

Company reference

": "{String}"
45
          },
46
          "assignedTo
AssignedTo

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

": {
47
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
51
          },
52
          "process
Process

Information about the process this task belongs to.

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

": {
53
               "processId
ProcessId

Unique identifier for Process

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

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

The name of this process

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

": "{String}",
55
               "deadlineAt
DeadlineAt

Date and time for all the Tasks under a process to be completed

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

": "{Datetime}",
56
               "processLink
ProcessLink

Task-process reference

This field is greyed out because it is an expandable field. You have to add $expand=Process in your request URI to get this field

": "{String}"
57
          },
58
          "folder
Folder

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

": {
59
               "folderId
FolderId

File folder id for a spesific file container or forlder.

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

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

Verbose folder text in english.

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

": "{String}",
61
               "folderLink
FolderLink

Company folder id

This field is greyed out because it is an expandable field. You have to add $expand=Folder in your request URI to get this field

": "{String}"
62
          },
63
          "responsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

": {
64
               "roleId
RoleId

Role identifier

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

Name of the role

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

Description of the role

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

Role reference

": "{String}"
68
          },
69
          "taskLink
TaskLink

Task reference

": "{String}"
70
     }
71
}

Possible error codes the response might return:

Error 101606 HTTP 404 Module not found
Error 108271 HTTP 403 You are not authorized to view this process