Collaboration APIs
Creates a new task
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/tasks |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 2483, version 18 |
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.
Type
The type of the task
Applicable domain values can be found here
This field is optional.
>{String}</Type>Title
Required/mandatory field
The title/summary of the task
>{String}</Title>Description
The description of the task
This field is optional.
>{String}</Description>Priority
The priority of the task.
Applicable domain values can be found here
Default value: 3
This field is optional.
>{Integer}</Priority>IsPrivate
True if the task is only visible for the creator of the task
Default value: False
This field is optional.
>{Boolean}</IsPrivate>DeadlineAt
Date and time of when this task must be completed.
This field is optional.
>{Datetime}</DeadlineAt>Activity
Task type: Email, Phone call, Followup
Applicable domain values can be found here
This field is optional.
>{Integer}</Activity>AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Process
Information about the process this task belongs to.
This field is optional.
>ProcessId
Unique identifier for Process
Minimum value: 100000
This field is optional.
>{Integer}</ProcessId>Folder
This field is optional.
>FolderId
File folder id for a spesific file container or forlder.
Minimum value: 100000
This field is optional.
>{Integer}</FolderId>ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
>RoleId
Role identifier
Minimum value: 100000
This field is optional.
>{Integer}</RoleId>Type
The type of the task
Applicable domain values can be found here
This field is optional.
": "{String}",Title
Required/mandatory field
The title/summary of the task
": "{String}",Description
The description of the task
This field is optional.
": "{String}",Priority
The priority of the task.
Applicable domain values can be found here
Default value: 3
This field is optional.
": "{Integer}",IsPrivate
True if the task is only visible for the creator of the task
Default value: False
This field is optional.
": "{Boolean}",DeadlineAt
Date and time of when this task must be completed.
This field is optional.
": "{Datetime}",Activity
Task type: Email, Phone call, Followup
Applicable domain values can be found here
This field is optional.
": "{Integer}",AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Process
Information about the process this task belongs to.
This field is optional.
": {ProcessId
Unique identifier for Process
Minimum value: 100000
This field is optional.
": "{Integer}"Folder
This field is optional.
": {FolderId
File folder id for a spesific file container or forlder.
Minimum value: 100000
This field is optional.
": "{Integer}"ResponsibleRole
Role (department etc.) responsible for a task
This field is optional.
": {RoleId
Role identifier
Minimum value: 100000
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] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
TaskId
Unique task identifier
>{Integer}</TaskId>Title
The title/summary of the task
>{String}</Title>Description
The description of the task
>{String}</Description>Priority
The priority of the task.
Possible domain values can be found here
>{Integer}</Priority>IsPrivate
True if the task is only visible for the creator of the task
>{Boolean}</IsPrivate>DeadlineAt
Date and time of when this task must be completed.
>{Datetime}</DeadlineAt>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>StartedAt
The date and time when the task was started (status="In progress")
>{Datetime}</StartedAt>CompletedAt
The full date and time when a task was completed
>{Datetime}</CompletedAt>Activity
Task type: Email, Phone call, Followup
Possible domain values can be found here
>{Integer}</Activity>TotalRegisteredHours
Aggregate hours registered for task
>{Decimal}</TotalRegisteredHours>CompletedBy
The user who completed the task
>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>ReviewedBy
Information about the user who approved or rejected the task.
>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>CreatedBy
Information about the user who created the task.
>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 task
>{Boolean}</CanView>CanEdit
Grants permission to edit task
>{Boolean}</CanEdit>CanDelete
Grants permission to delete task
>{Boolean}</CanDelete>CanAssign
Grants permission to assign task
>{Boolean}</CanAssign>CanChangeStatus
Grants permission to assign task
>{Boolean}</CanChangeStatus>CreatedInCompany
The compnay the task was created in
>CompanyId
Company identifier
>{Integer}</CompanyId>Database
Abbreviation/code to identify the company
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProcessId
Unique identifier for Process
>{Integer}</ProcessId>Name
The name of this process
>{String}</Name>DeadlineAt
Date and time for all the Tasks under a process to be completed
>{Datetime}</DeadlineAt>ProcessLink
Task-process reference
>{String}</ProcessLink>FolderId
File folder id for a spesific file container or forlder.
>{Integer}</FolderId>Name
Verbose folder text in english.
>{String}</Name>FolderLink
Company folder id
>{String}</FolderLink>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>TaskLink
Task reference
>{String}</TaskLink>TaskId
Unique task identifier
": "{Integer}",Type
The type of the task
Possible domain values can be found here
": "{String}",Status
The status of a task
Possible domain values can be found here
": "{Integer}",Title
The title/summary of the task
": "{String}",Description
The description of the task
": "{String}",Priority
The priority of the task.
Possible domain values can be found here
": "{Integer}",IsPrivate
True if the task is only visible for the creator of the task
": "{Boolean}",DeadlineAt
Date and time of when this task must be completed.
": "{Datetime}",CreatedAt
Date and time of creation
": "{Datetime}",StartedAt
The date and time when the task was started (status="In progress")
": "{Datetime}",CompletedAt
The full date and time when a task was completed
": "{Datetime}",Activity
Task type: Email, Phone call, Followup
Possible domain values can be found here
": "{Integer}",TotalRegisteredHours
Aggregate hours registered for task
": "{Decimal}",CompletedBy
The user who completed the task
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"ReviewedBy
Information about the user who approved or rejected the task.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"CreatedBy
Information about the user who created the task.
": {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 task
": "{Boolean}",CanEdit
Grants permission to edit task
": "{Boolean}",CanDelete
Grants permission to delete task
": "{Boolean}",CanAssign
Grants permission to assign task
": "{Boolean}",CanChangeStatus
Grants permission to assign task
": "{Boolean}"CreatedInCompany
The compnay the task was created in
": {CompanyId
Company identifier
": "{Integer}",Database
Abbreviation/code to identify the company
": "{String}",CompanyLink
Company reference
": "{String}"AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",ProcessId
Unique identifier for Process
": "{Integer}",Name
The name of this process
": "{String}",DeadlineAt
Date and time for all the Tasks under a process to be completed
": "{Datetime}",ProcessLink
Task-process reference
": "{String}",FolderId
File folder id for a spesific file container or forlder.
": "{Integer}",Name
Verbose folder text in english.
": "{String}",FolderLink
Company folder id
": "{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}"TaskLink
Task 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. |