kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
203 lines
6.6 KiB
203 lines
6.6 KiB
# /api/v3/time_entries/{id}
|
|
---
|
|
delete:
|
|
parameters:
|
|
- description: Time entry id
|
|
example: '1'
|
|
in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'204':
|
|
description: Returned if the time entry was deleted successfully.
|
|
headers: {}
|
|
'403':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
$ref: "../components/schemas/error_response.yml"
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
|
|
message: You are not authorized to access this resource.
|
|
description: Returned if the client does not have sufficient permissions
|
|
headers: {}
|
|
'404':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
$ref: "../components/schemas/error_response.yml"
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
|
|
message: The requested resource could not be found.
|
|
description: |-
|
|
Returned if the time entry does not exist or if the user does not have sufficient permissions to see the time entry.
|
|
|
|
**Required permission** `view time entries` in the project the time entry is assigned to or `view own time entries` for time entries belonging to the user
|
|
headers: {}
|
|
tags:
|
|
- Time Entries
|
|
description: Permanently deletes the specified time entry.
|
|
operationId: Delete_time_entry
|
|
summary: Delete time entry
|
|
get:
|
|
parameters:
|
|
- description: time entry id
|
|
example: '1'
|
|
in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
response:
|
|
value:
|
|
_embedded:
|
|
activity...: {}
|
|
project...: {}
|
|
user...: {}
|
|
workPackage...: {}
|
|
_links:
|
|
activity:
|
|
href: "/api/v3/time_entries/activities/18"
|
|
title: Some time entry activity
|
|
customField4:
|
|
href: "/api/v3/users/5"
|
|
title: Some other user
|
|
delete:
|
|
href: "/api/v3/time_entries/1"
|
|
method: delete
|
|
project:
|
|
href: "/api/v3/projects/1"
|
|
title: Some project
|
|
self:
|
|
href: "/api/v3/time_entries/1"
|
|
updateImmediately:
|
|
href: "/api/v3/time_entries/1"
|
|
method: patch
|
|
user:
|
|
href: "/api/v3/users/2"
|
|
title: Some user
|
|
workPackage:
|
|
href: "/api/v3/work_packages/1"
|
|
title: Some work package
|
|
_type: TimeEntry
|
|
comment:
|
|
format: plain
|
|
html: "<p>Some text explaining why the time entry was created</p>"
|
|
raw: Some text explaining why the time entry was created
|
|
createdAt: '2015-03-20T12:56:56Z'
|
|
customField12: 5
|
|
hours: PT5H
|
|
id: 1
|
|
spentOn: '2015-03-20'
|
|
updatedAt: '2015-03-20T12:56:56Z'
|
|
schema:
|
|
"$ref": "../components/schemas/view_time_entry_model.yml"
|
|
description: OK
|
|
headers: {}
|
|
'404':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
$ref: "../components/schemas/error_response.yml"
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
|
|
message: The requested resource could not be found.
|
|
description: |-
|
|
Returned if the time entry does not exist or if the user does not have permission to view them.
|
|
|
|
**Required permission** `view time entries` in the project the time entry is assigned to or `view own time entries` for time entries belonging to the user
|
|
headers: {}
|
|
tags:
|
|
- Time Entries
|
|
description: ''
|
|
operationId: View_time_entry
|
|
summary: View time entry
|
|
patch:
|
|
parameters:
|
|
- description: Time entry id
|
|
example: '1'
|
|
in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
"$ref": "../components/schemas/view_time_entry_model.yml"
|
|
description: OK
|
|
headers: {}
|
|
'400':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
$ref: "../components/schemas/error_response.yml"
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
|
|
message: The request body was not a single JSON object.
|
|
description: Occurs when the client did not send a valid JSON object in the
|
|
request body.
|
|
headers: {}
|
|
'403':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
$ref: "../components/schemas/error_response.yml"
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
|
|
message: You are not authorized to access this resource.
|
|
description: |-
|
|
Returned if the client does not have sufficient permissions.
|
|
|
|
**Required permission:** Edit (own) time entries, depending on what time entry is being modified.
|
|
headers: {}
|
|
'422':
|
|
content:
|
|
application/hal+json:
|
|
schema:
|
|
$ref: "../components/schemas/error_response.yml"
|
|
examples:
|
|
response:
|
|
value:
|
|
_embedded:
|
|
details:
|
|
attribute: workPackage
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
|
|
message: Work package is invalid.
|
|
description: |-
|
|
Returned if:
|
|
|
|
* a constraint for a property was violated (`PropertyConstraintViolation`)
|
|
headers: {}
|
|
tags:
|
|
- Time Entries
|
|
description: Updates the given time entry by applying the attributes provided in
|
|
the body. Please note that while there is a fixed set of attributes, custom fields
|
|
can extend a time entries' attributes and are accepted by the endpoint.
|
|
operationId: Update_Time_entry
|
|
summary: Update Time entry
|
|
|