Collaboration APIs
Register hours on a provided task
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/tasks/{taskId}/work-log |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {taskId} |
Unique task identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 3769, version 6 |
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.
RegisteredHours
Required/mandatory field
Duration of the work period
Minimum value: 0
>{Decimal}</RegisteredHours>StartedAt
Required/mandatory field
Date and time of when the task item was registered
>{Datetime}</StartedAt>Comment
Description for the registered time
This field is optional.
>{String}</Comment>RegisteredHours
Required/mandatory field
Duration of the work period
Minimum value: 0
": "{Decimal}",StartedAt
Required/mandatory field
Date and time of when the task item was registered
": "{Datetime}",Comment
Description for the registered time
This field is optional.
": "{String}"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. |
| $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.
WorkPeriodId
Registered time unique id
>{Integer}</WorkPeriodId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Comment
Description for the registered time
>{String}</Comment>StartedAt
Date and time of when the task item was registered
>{Datetime}</StartedAt>RegisteredHours
Duration of the work period
CreatedBy
The person who registered hours for this task
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>WorkPeriodId
Registered time unique id
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Comment
Description for the registered time
": "{String}",StartedAt
Date and time of when the task item was registered
": "{Datetime}",RegisteredHours
Duration of the work period
CreatedBy
The person who registered hours for this task
": {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 101079 HTTP 400 | Mismatch in size of revision parameters |
| Error 108272 HTTP 403 | You are not authorized to view this task |