Delete Time Entry task.elapseditem.delete
Scope:
taskWho can execute the method: any user
This method deletes a time entry.
Note
You can check the permission to delete using the special method task.elapseditem.isactionallowed
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
TASKID* |
Task identifier. The task identifier can be obtained when creating a new task or by using the getting task list method |
|
ITEMID* |
Time entry identifier. It can be obtained when creating a new entry or by using the getting time entry list method |
Warning
It is mandatory to follow the specified order of parameters in the request as shown in the table. 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, "ITEMID": 5}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.elapseditem.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID" : 691, "ITEMID": 5,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.elapseditem.delete
try
{
const response = await $b24.callMethod(
'task.elapseditem.delete',
{
"TASKID": 691,
"ITEMID": 5,
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'task.elapseditem.delete',
[
'TASKID' => 691,
'ITEMID' => 5,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting elapsed item: ' . $e->getMessage();
}
BX24.callMethod(
'task.elapseditem.delete',
{
"TASKID": 691,
"ITEMID": 5,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.elapseditem.delete',
[
'TASKID' => 691,
'ITEMID' => 5,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
In case of successful request execution, the server will return result:null
{
"result": null,
"time": {
"start": 1712137817.343984,
"finish": 1712137817.605804,
"duration": 0.26182007789611816,
"processing": 0.018325090408325195,
"date_start": "2024-04-03T12:50:17+03:00",
"date_finish": "2024-04-03T12:50:17+03:00"
}
}
Error Handling
HTTP status: 400
{
"error": "ERROR_CORE",
"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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". 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
- Add Time Entry task.elapseditem.add
- Update Time Entry task.elapseditem.update
- Get elapsed time record by identifier task.elapseditem.get
- Get a list of time spent records task.elapseditem.getlist
- Check Action Permission for task.elapseditem.isactionallowed
- Get a list of methods and their descriptions task.elapseditem.getmanifest