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.
176 lines
5.5 KiB
176 lines
5.5 KiB
# /api/v3/work_packages/{id}/activities
|
|
---
|
|
get:
|
|
parameters:
|
|
- description: Work package id
|
|
example: '1'
|
|
in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
response:
|
|
value:
|
|
_embedded:
|
|
elements:
|
|
- _links:
|
|
self:
|
|
href: "/api/v3/activity/1"
|
|
user:
|
|
href: "/api/v3/users/1"
|
|
workPackage:
|
|
href: "/api/v3/work_packages/1"
|
|
_type: Activity
|
|
comment:
|
|
format: markdown
|
|
html: "<p>Lorem ipsum dolor sit amet.</p>"
|
|
raw: Lorem ipsum dolor sit amet.
|
|
createdAt: '2014-05-21T08:51:20Z'
|
|
details: []
|
|
id: 1
|
|
version: 1
|
|
- _links:
|
|
self:
|
|
href: "/api/v3/activity/2"
|
|
user:
|
|
href: "/api/v3/users/1"
|
|
workPackage:
|
|
href: "/api/v3/work_packages/1"
|
|
_type: Activity
|
|
comment:
|
|
format: markdown
|
|
html: "<p>Lorem ipsum dolor sit amet.</p>"
|
|
raw: Lorem ipsum dolor sit amet.
|
|
createdAt: '2014-05-21T08:51:22Z'
|
|
details: []
|
|
id: 2
|
|
version: 2
|
|
_links:
|
|
self:
|
|
href: "/api/v3/work_packages/1/revisions"
|
|
_type: Collection
|
|
count: 2
|
|
total: 2
|
|
schema:
|
|
"$ref": "../components/schemas/work_package_activities_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 specified work package does not exist.
|
|
description: |-
|
|
Returned if the work package does not exist or the client does not have sufficient permissions to see it.
|
|
|
|
**Required permission:** view work package
|
|
headers: {}
|
|
tags:
|
|
- Work Packages
|
|
description: ''
|
|
operationId: List_work_package_activities
|
|
summary: List work package activities
|
|
post:
|
|
parameters:
|
|
- description: Work package id
|
|
example: '1'
|
|
in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
- description: |-
|
|
Indicates whether change notifications (e.g. via E-Mail) should be sent.
|
|
Note that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),
|
|
not just the current user.
|
|
example: 'false'
|
|
in: query
|
|
name: notify
|
|
required: false
|
|
schema:
|
|
default: 'true'
|
|
type: boolean
|
|
responses:
|
|
'201':
|
|
description: Created
|
|
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 allowed to create a comment here.
|
|
description: |-
|
|
Returned if the client does not have sufficient permissions.
|
|
|
|
**Required permission:** create journals
|
|
|
|
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*
|
|
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 specified work package does not exist.
|
|
description: |-
|
|
Returned if the work package does not exist or the client does not have sufficient permissions to see it.
|
|
|
|
**Required permission:** view work package
|
|
headers: {}
|
|
tags:
|
|
- Work Packages
|
|
description: |-
|
|
Creates an activity for the selected work package and, on success, returns the
|
|
updated activity.
|
|
operationId: Comment_work_package
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
example:
|
|
comment:
|
|
raw: I think this is awesome!
|
|
properties:
|
|
comment:
|
|
properties:
|
|
raw:
|
|
type: string
|
|
type: object
|
|
type: object
|
|
summary: Comment work package
|
|
|