API

Collaboration APIs

GET collaboration/task-processes

Lists all task processes

HTTP method GET
URI https://api.rambase.net/collaboration/task-processes
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2472, version 30

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"
$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 process that is not done or archived yet
Finished() Named filter Lists all process that is finished
MyProcesses() Named filter All tasks that is created by me
OnGoing() Named filter List of all process which is on going
Private() Named filter List my private process
Production() Named filter List of production processes
Standard() Named filter List of standard (collaboration) processes
AssignedTo Integer The userId of the person this task process is assigned to.
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.
DeadlineAt Datetime Date and time for all the Tasks under a process to be completed. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Description String Descriptive text for a Process.
IsPrivate Boolean True if the task is only visible for the creator of the task.
Name String The name of this process.
ResponsibleName String Role identifier.
ResponsibleRoleId Integer Role identifier.
Status Integer Status of the process.
TaskProcessId Integer Unique identifier for Process.
TotalRegisteredHours Decimal Aggregate hours registered for task.
Type Integer The type of the process.

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

AssignedTo Integer The userId of the person this task process is assigned to
CreatedAt Datetime Date and time of creation
DeadlineAt Datetime Date and time for all the Tasks under a process to be completed
Name String The name of this process
ResponsibleName String Role identifier
ResponsibleRoleId Integer Role identifier
Status Integer Status of the process
TaskProcessId Integer Unique identifier for Process
TotalRegisteredHours Decimal Aggregate hours registered for task
Type Integer The type of the process

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
<TaskProcesses>
2
     <TaskProcess>
3
          <TaskProcessId
TaskProcessId

Unique identifier for Process

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

The type of the process

Possible domain values can be found here

>{Integer}</Type>
5
          <CreatedAt
CreatedAt

Date and time of creation

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

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

>{Datetime}</DeadlineAt>
7
          <Description
Description

Descriptive text for a Process

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

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

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

The name of this process

>{String}</Name>
10
          <Status
Status

Status of the process

Possible domain values can be found here

>{Integer}</Status>
11
          <CreatedBy
CreatedBy

UserId of the person who created the process

>
12
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
16
          </CreatedBy>
17
          <TotalRegisteredHours
TotalRegisteredHours

Aggregated hours registered on the process

>{Decimal}</TotalRegisteredHours>
18
          <TaskProcessLink
TaskProcessLink

Task-process reference

>{String}</TaskProcessLink>
19
          <ResponsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

>
20
               <RoleId
RoleId

Role identifier

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

Name of the role

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

Description of the role

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

Role reference

>{String}</RoleLink>
24
          </ResponsibleRole>
25
          <AssignedTo
AssignedTo

The userId of the person this task process is assigned to

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

>
26
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
30
          </AssignedTo>
31
     </TaskProcess>
32
     <Paging
Paging

Detailed paging information for this list.

>
33
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
36
          <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>
37
          <FirstPage
FirstPage

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

>{String}</FirstPage>
38
          <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>
39
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
40
          <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>
41
          <NextPage
NextPage

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

>{String}</NextPage>
42
          <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>
43
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
45
     </Paging>
46
</TaskProcesses>
1
{
2
     "taskProcesses": [
3
          {
4
               "taskProcessId
TaskProcessId

Unique identifier for Process

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

The type of the process

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "deadlineAt
DeadlineAt

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

": "{Datetime}",
8
               "description
Description

Descriptive text for a Process

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

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

": "{Boolean}",
10
               "name
Name

The name of this process

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

Status of the process

Possible domain values can be found here

": "{Integer}",
12
               "createdBy
CreatedBy

UserId of the person who created the process

": {
13
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
17
               },
18
               "totalRegisteredHours
TotalRegisteredHours

Aggregated hours registered on the process

": "{Decimal}",
19
               "taskProcessLink
TaskProcessLink

Task-process reference

": "{String}",
20
               "responsibleRole
ResponsibleRole

Role (department etc.) responsible for a task

": {
21
                    "roleId
RoleId

Role identifier

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

Name of the role

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

Description of the role

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

Role reference

": "{String}"
25
               },
26
               "assignedTo
AssignedTo

The userId of the person this task process is assigned to

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

": {
27
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
31
               }
32
          }
33
     ],
34
     "paging
Paging

Detailed paging information for this list.

": {
35
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
38
          "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}",
39
          "firstPage
FirstPage

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

": "{String}",
40
          "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}",
41
          "previousPage
PreviousPage

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

": "{String}",
42
          "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}",
43
          "nextPage
NextPage

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

": "{String}",
44
          "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}",
45
          "lastPage
LastPage

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

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

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

": "{Integer}"
47
     }
48
}

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 101030 HTTP 404 Role not found