Collaboration APIs
Get details about a task process
| HTTP method | GET |
| URI | https://api.rambase.net/collaboration/task-processes/{processId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {processId} |
Unique identifier for Process
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2473, version 26 |
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.
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. |
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.
TaskProcessId
Unique identifier for Process
>{Integer}</TaskProcessId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>DeadlineAt
Date and time for all the Tasks under a process to be completed
>{Datetime}</DeadlineAt>Description
Descriptive text for a Process
>{String}</Description>IsPrivate
True if the task is only visible for the creator of the task
>{Boolean}</IsPrivate>Name
The name of this process
>{String}</Name>TotalRegisteredHours
Aggregated hours registered on the process
>{Decimal}</TotalRegisteredHours>NumberOfTasks
Number of task including private per processs
>{Integer}</NumberOfTasks>CreatedBy
UserId of the person who created the process
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>ResponsibleRole
Role (department etc.) responsible for a task
>RoleId
Role identifier
>{Integer}</RoleId>Name
Name of the role
>{String}</Name>Description
Description of the role
>{String}</Description>RoleLink
Role reference
>{String}</RoleLink>AssignedTo
The userId of the person this task process is assigned to
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>TaskProcessId
Unique identifier for Process
": "{Integer}",Type
The type of the process
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",DeadlineAt
Date and time for all the Tasks under a process to be completed
": "{Datetime}",Description
Descriptive text for a Process
": "{String}",IsPrivate
True if the task is only visible for the creator of the task
": "{Boolean}",Name
The name of this process
": "{String}",Status
Status of the process
Possible domain values can be found here
": "{Integer}",TotalRegisteredHours
Aggregated hours registered on the process
": "{Decimal}",NumberOfTasks
Number of task including private per processs
": "{Integer}",CreatedBy
UserId of the person who created the process
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"ResponsibleRole
Role (department etc.) responsible for a task
": {RoleId
Role identifier
": "{Integer}",Name
Name of the role
": "{String}",Description
Description of the role
": "{String}",RoleLink
Role reference
": "{String}"AssignedTo
The userId of the person this task process is assigned to
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"
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 102690 HTTP 404 | Task process not found |