API

Collaboration APIs

GET collaboration/tasks

List tasks

HTTP method GET
URI https://api.rambase.net/collaboration/tasks
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2446, version 74

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Lists all tasks that is not done or archived yet
Archived() Named filter Lists all archived tasks
AssignedToMe() Named filter Lists all tasks assigned to me
CreatedByMe() Named filter All tasks I have created
Done() Named filter Lists all tasks finished
InProgress() Named filter Lists all tasks in progress
MyActiveTasks() Named filter Active unassigned tasks that I have created or active tasks I am assigned to
MyTasks() Named filter All tasks that is assigned to me or unnasigned tasks that I created
MyUnfinishedTasks() Named filter My tasks that are in "to do" state either "in progress"
Private() Named filter List only my private tasks
TasksInMyCompany() Named filter The company the task was created in
UnfinishedTasks() Named filter All tasks that are in "to do" state either "in progress"
Activity Integer Task type: Email, Phone call, Followup.
AssignedTo Integer The userId of the person this task is assigned to (responsible for doing the work).
ContainingTagName String All tasks containing this TAG.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy Integer Information about the user who created the task.
CreatedInCompany String The compnay the task was created in.
DeadlineAt Datetime Date and time of when this task must be completed. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IsPrivate Boolean True if the task is only visible for the creator of the task.
Priority Integer The priority of the task..
ProcessId Integer The identifier of the process this task belongs to.
ProcessName String The name of this process.
ResponsibleRoleId Integer Role (department etc.) responsible for a task.
ReviewedBy Integer Information about the user who approved or rejected the task.
StartedAt Datetime The date and time when the task was started (status="In progress"). Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer The status of a task.
TaskId Integer Unique task identifier.
Title String The title/summary of the task.
TotalRegisteredHours Decimal Aggregate hours registered for task.
Type String The type of the task.

Read more about filters and sorting on how to use sortable parameters

Activity Integer Task type: Email, Phone call, Followup
AssignedTo Integer The userId of the person this task is assigned to (responsible for doing the work)
CreatedAt Datetime Date and time of creation
CreatedInCompany String The compnay the task was created in
DeadlineAt Datetime Date and time of when this task must be completed.
Priority Integer The priority of the task.
ProcessId Integer The identifier of the process this task belongs to.
ProcessName String The name of this process
StartedAt Datetime The date and time when the task was started (status="In progress")
Status Integer The status of a task
TaskId Integer Unique task identifier
Title String The title/summary of the task
TotalRegisteredHours Decimal Aggregate hours registered for task
Type String The type of the task

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
<Tasks>
2
     <Task>
3
          <TaskId
TaskId

Unique task identifier

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

The type of the task

Possible domain values can be found here

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

The title/summary of the task

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

Date and time of creation

>{Datetime}</CreatedAt>
7
          <Status
Status

The status of a task

Possible domain values can be found here

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

The priority of the task.

Possible domain values can be found here

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

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

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

Date and time of when this task must be completed.

>{Datetime}</DeadlineAt>
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
          <CreatedInCompany
CreatedInCompany

The compnay the task was created in

>
34
               <CompanyId
CompanyId

Company identifier

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

Abbreviation/code to identify the company

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

Company reference

>{String}</CompanyLink>
37
          </CreatedInCompany>
38
          <AssignedTo
AssignedTo

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

>
39
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
43
          </AssignedTo>
44
          <ResponsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

>
45
               <RoleId
RoleId

Role identifier

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

Name of the role

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

Description of the role

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

Role reference

>{String}</RoleLink>
49
          </ResponsibleRole>
50
          <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=Task.Process in your request URI to get this field

>
51
               <ProcessId
ProcessId

Unique identifier for Process

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

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

The name of this process

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

>{String}</Name>
53
               <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=Task.Process in your request URI to get this field

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

Task-process reference

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

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

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

>
57
               <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=Task.Folder in your request URI to get this field

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

Verbose folder text in english.

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

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

Company folder id

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

>{String}</FolderLink>
60
          </Folder>
61
          <TaskLink
TaskLink

Task reference

>{String}</TaskLink>
62
     </Task>
63
     <Paging
Paging

Detailed paging information for this list.

>
64
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
65
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
66
          <Page
Page

Page index

>{Integer}</Page>
67
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
68
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
69
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
70
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
71
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
72
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
73
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
74
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
75
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
76
     </Paging>
77
</Tasks>
1
{
2
     "tasks": [
3
          {
4
               "taskId
TaskId

Unique task identifier

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

The type of the task

Possible domain values can be found here

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

The title/summary of the task

": "{String}",
7
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
               "status
Status

The status of a task

Possible domain values can be found here

": "{Integer}",
9
               "priority
Priority

The priority of the task.

Possible domain values can be found here

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

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

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

Date and time of when this task must be completed.

": "{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
               "createdInCompany
CreatedInCompany

The compnay the task was created in

": {
35
                    "companyId
CompanyId

Company identifier

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

Abbreviation/code to identify the company

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

Company reference

": "{String}"
38
               },
39
               "assignedTo
AssignedTo

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

": {
40
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
44
               },
45
               "responsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

": {
46
                    "roleId
RoleId

Role identifier

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

Name of the role

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

Description of the role

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

Role reference

": "{String}"
50
               },
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=Task.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=Task.Process in your request URI to get this field

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

The name of this process

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

": "{String}",
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=Task.Process in your request URI to get this field

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

Task-process reference

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Task.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=Task.Folder in your request URI to get this field

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

Verbose folder text in english.

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

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

Company folder id

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

": "{String}"
61
               },
62
               "taskLink
TaskLink

Task reference

": "{String}"
63
          }
64
     ],
65
     "paging
Paging

Detailed paging information for this list.

": {
66
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
67
          "position
Position

Position of the first element in the list

": "{Integer}",
68
          "page
Page

Page index

": "{Integer}",
69
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
70
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
71
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
72
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
73
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
74
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
75
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
76
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
77
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
78
     }
79
}

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