Collaboration APIs
Creates a new task process
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/task-processes |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 2476, version 7 |
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.
DeadlineAt
Date and time for all the Tasks under a process to be completed
This field is optional.
>{Datetime}</DeadlineAt>Description
Descriptive text for a Process
This field is optional.
>{String}</Description>IsPrivate
True if the task is only visible for the creator of the task
Default value: False
This field is optional.
>{Boolean}</IsPrivate>Name
Required/mandatory field
The name of this process
>{String}</Name>ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
>RoleId
Role identifier
Minimum value: 100000
This field is optional.
>{Integer}</RoleId>AssignedTo
The userId of the person this task process is assigned to
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>DeadlineAt
Date and time for all the Tasks under a process to be completed
This field is optional.
": "{Datetime}",Description
Descriptive text for a Process
This field is optional.
": "{String}",IsPrivate
True if the task is only visible for the creator of the task
Default value: False
This field is optional.
": "{Boolean}",Name
Required/mandatory field
The name of this process
": "{String}",ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
": {RoleId
Role identifier
Minimum value: 100000
This field is optional.
": "{Integer}"AssignedTo
The userId of the person this task process is assigned to
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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. |
| $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] |
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.
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>CanView
Grants permission to view process and underlyig tasks
>{Boolean}</CanView>CanEdit
Grants permission to edit process and underlying tasks
>{Boolean}</CanEdit>CanDelete
Grants permission to delete process and underlying tasks
>{Boolean}</CanDelete>CanAssign
Grants permission to assign underlying tasks
>{Boolean}</CanAssign>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}",CanView
Grants permission to view process and underlyig tasks
": "{Boolean}",CanEdit
Grants permission to edit process and underlying tasks
": "{Boolean}",CanDelete
Grants permission to delete process and underlying tasks
": "{Boolean}",CanAssign
Grants permission to assign underlying tasks
": "{Boolean}"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 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 107327 HTTP 400 | You are not authorized to to approve or reject this task |
| Error 108882 HTTP 400 | Approver is required in this stage |
| Error 107367 HTTP 400 | Cannot close the task. Unchecked required checklist items remaining. |