Add Elapsed Time Record task.elapseditem.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: any user
This method adds elapsed time to a task and returns the identifier of the added record.
Note
You can check the permission to add using the special method task.elapseditem.isactionallowed.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
TASKID* |
Task identifier. You can obtain the task identifier when creating a new task or using the get task list method. |
|
ARFIELDS* |
An object containing records about the user, time, and comments (detailed description provided below) in the following structure:
|
ARFIELDS Parameter
Required parameters are marked with *
|
Name |
Description |
|
SECONDS* |
Amount of time spent in seconds. |
|
COMMENT_TEXT* |
Comment text. |
|
USER_ID |
User identifier. |
Warning
It is mandatory to follow the specified order of parameters in the request as shown in the tables. Otherwise, the request will execute with errors.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID" : 691, "ARFIELDS": {"SECONDS": 113,"COMMENT_TEXT": "comment text"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.elapseditem.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID" : 691, "ARFIELDS": {"SECONDS": 113,"COMMENT_TEXT": "comment text"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.elapseditem.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ElapsedItemAddResult = number
try {
const response = await $b24.actions.v2.call.make<ElapsedItemAddResult>({
method: 'task.elapseditem.add',
params: {
TASKID: 691,
ARFIELDS: {
SECONDS: 113,
COMMENT_TEXT: 'comment text',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('New elapsed item ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addElapsedItem() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.elapseditem.add',
params: {
TASKID: 691,
ARFIELDS: {
SECONDS: 113,
COMMENT_TEXT: 'comment text',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('New elapsed item ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addElapsedItem)
</script>
try {
$response = $b24Service
->core
->call(
'task.elapseditem.add',
[
'TASKID' => 691,
'ARFIELDS' => [
'SECONDS' => 113,
'COMMENT_TEXT' => 'comment text',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding elapsed item: ' . $e->getMessage();
}
BX24.callMethod(
'task.elapseditem.add',
{
"TASKID" : 691,
"ARFIELDS": {
"SECONDS": 113,
"COMMENT_TEXT": "comment text",
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.elapseditem.add',
[
'TASKID' => 691,
'ARFIELDS' => [
'SECONDS' => 113,
'COMMENT_TEXT' => 'comment text',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
In case of a successful request, the server will return the identifier of the new record.
{
"result": 5,
"time": {
"start": 1712137817.343984,
"finish": 1712137817.605804,
"duration": 0.26182007789611816,
"processing": 0.018325090408325195,
"date_start": "2024-04-03T12:50:17+02:00",
"date_finish": "2024-04-03T12:50:17+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the new record. |
|
time |
Information about the request execution time. |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CODE",
"error_description": "ACTION_NOT_ALLOWED"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Task not found. |
|
|
Access denied. |
|
|
Action not allowed. |
|
|
Unknown error. |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Time Tracking in Tasks: Overview of Methods
- Update Time Entry task.elapseditem.update
- Get Time Entry by ID task.elapseditem.get
- Get a List of Time Tracking Records task.elapseditem.getlist
- Delete Time Entry task.elapseditem.delete
- Check Action Permission for task.elapseditem.isActionAllowed
- Get a List of Methods and Their Descriptions task.elapseditem.getmanifest