API: Time Entry Activities
Time entries are classified by an activity which is one item of a set of user defined activities (e.g. Design, Specification, Development).
Actions
None
Linked Properties
Link | Description | Type | Constraints | Supported operations | Condition |
---|---|---|---|---|---|
self | This time entry activity | TimeEntriesActivity | not null | READ | |
projects | List of projects the time entry is active in | []Project | not null | READ / WRITE |
Local Properties
Property | Description | Type | Constraints | Supported operations | Condition |
---|---|---|---|---|---|
id | Time entries’ id | Integer | x > 0 | READ | |
name | The human readable name chosen for this activity | String | max 30 characters | READ | |
position | The rank the activity has in a list of activities | Date | READ | ||
default | Flag to signal whether this activity is the default activity | Boolean | READ |
Methods
View time entries activity
get /api/v3/time_entries/activity/{id} id
integer
required path
Time entries activity id
Example:1
200
OK
application/hal+json
{
"_embedded": {
"projects...": [
]
},
"_links": {
"projects": [
{
"href": "/api/v3/projects/seeded_project",
"title": "Seeded Project"
},
{
"href": "/api/v3/projects/working-project",
"title": "Working Project"
}
],
"self": {
"href": "/api/v3/time_entries/activities/18",
"title": "a autem"
}
},
"_type": "TimeEntriesActivity",
"default": false,
"id": 18,
"name": "a autem",
"position": 10
}
View_time_entries_activityModel
{
"type": "object",
"example": {
"_type": "TimeEntriesActivity",
"id": 18,
"name": "a autem",
"position": 10,
"default": false,
"_embedded": {
"projects...": [
]
},
"_links": {
"self": {
"href": "/api/v3/time_entries/activities/18",
"title": "a autem"
},
"projects": [
{
"href": "/api/v3/projects/seeded_project",
"title": "Seeded Project"
},
{
"href": "/api/v3/projects/working-project",
"title": "Working Project"
}
]
}
}
}
404
Returned if the activity does not exist or if the user does not have permission to view them.
Required permission view time entries
, log time
, edit time entries
, edit own time entries
or manage project activities
in any project
application/hal+json
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The requested resource could not be found."
}
ErrorResponse
{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}