Nothing to showTurn on at least one filter to see operations.
Actions & Capabilities5 operations5 covered0 partial0 uncovered0 not measured100%#
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
1211n/a{
2211n/a "type": "string"
3211n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK5397ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1342ms
500Internal Server Error483ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1729n/a{
2729n/a "type": "string"
3729n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the action does not exist.5665ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1633ms
Query Parameters2 of 2 keywords covered
filters1 / 1
#validinvalidschema
1283n/a{
2283n/a "type": "string"
3283n/a}
sortBy1 / 1
1272n/a{
2272n/a "type": "string"
3272n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK3814ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4182ms
400Bad Request1403ms
500Internal Server Error1353ms
Examples1 / 1 used
Query
"[[\"id\", \"asc\"]]"sortBy
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the action does not exist.2236ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5102ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1728n/a{
2728n/a "type": "string"
3728n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the capability does not exist.5826ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1463ms
Activities7 operations7 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
161843{
261843 "type": "integer"
361843}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK21244ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error927ms
401Unauthorized1313ms
404Not Found2263ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
170614{
270614 "type": "integer"
370614}
Body6 of 6 keywords covered
application/json6 / 6
ActivityCommentWriteModel
150052{
224737 "properties": {
323331 "comment": {
419324 "properties": {
519324 "raw": {
619324 "type": "string"
719324 }
819324 },
92577 "type": "object"
1023331 },
116624 "internal": {
126624 "type": "boolean"
136624 }
1424737 },
1553715 "type": "object"
1650052}
Responses3 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.7022ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit journals0never seen
406Occurs when the client did not send a Content-Type header13ms
415Occurs when the client sends an unsupported Content-Type header.11ms
422Returned if the client tries to modify a read-only property.0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found143ms
500Internal Server Error27ms
Examples2 / 2 used
Body: application/json
{
"comment": {
"raw": "I think this is awesome!"
}
}ActivityCommentWriteModel
falseActivityCommentWriteModel.internal
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
161955{
261955 "type": "integer"
361955}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK36319ms
404Returned if the activity does not exist or the client does not have sufficient permissions
to see it.
**Required permission:**
- `view_work_packages`
- for internal comments: `view_internal_comments`
*Note: A client without sufficient permissions shall not be able to test for the existence of an activity.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1554ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1063ms
400Bad Request492ms
500Internal Server Error15ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1186841{
2186841 "type": "integer"
3186841}
Body7 of 7 keywords covered
multipart/form-data7 / 7
FileUploadForm
1111311{
265111 "properties": {
3541n/a "file": {
4541n/a "format": "binary",
5541n/a "type": "string"
6541n/a },
756211 "metadata": {
83707 "properties": {
93707 "fileName": {
103707 "type": "string"
113707 }
123707 },
135694 "type": "object"
1456211 }
1565111 },
161124n/a "type": "object"
17111311}
Responses5 of 7 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting one of the required parts (metadata and file)
* sending unparsable JSON in the metadata part273ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view_work_packages or view_internal_comments (for internal comments)
*Note that you will only receive this error, if you are at least allowed to see the activity*0never seen
404Returned if the activity does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view_work_packages or view_internal_comments (for internal comments)
*Note: A client without sufficient permissions shall not be able to test for the existence of an activity.
That's why a 404 is returned here, even if a 403 might be more appropriate.*6764ms
406Occurs when the client did not send a Content-Type header1853ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if the client tries to send an invalid attachment.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Sending a file that is too large6317ms
400Returned if the client sends a not understandable request. Reasons include:
* Omitting the `metadata` part
* sending unparsable JSON in the metadata part1805ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add_work_package_comments
*Note that you will only receive this error, if you are at least allowed to see the activity*0never seen
404Returned if the activity does not exist or the client does not have sufficient permissions
to see it.
**Required permission:**
- `view_work_packages`
- for internal comments: `view_internal_comments`
*Note: A client without sufficient permissions shall not be able to test for the existence of an activity.
That's why a 404 is returned here, even if a 403 might be more appropriate.*2443ms
406Occurs when the client did not send a Content-Type header1633ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if the client tries to prepare an invalid attachment upload.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Omitting the file size (`fileSize` property of metadata part)
* The instance is not configured for direct uploads266ms
404Returned if the activity does not exist or the client does not have sufficient permissions
to see it.
**Required permission:**
- `view_work_packages`
- for internal comments: `view_internal_comments`
*Note: A client without sufficient permissions shall not be able to test for the existence of an activity.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1103ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1633ms
400Bad Request352ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169320{
269320 "type": "integer"
369320}
Body5 of 5 keywords covered
application/hal+json5 / 5
162147{
262118 "properties": {
362118 "reaction": {
462118 "enum": [
535n/a "thumbs_up",
654n/a "thumbs_down",
720n/a "grinning_face_with_smiling_eyes",
821n/a "confused_face",
950n/a "heart",
1021n/a "party_popper",
1131n/a "rocket",
12389n/a "eyes"
1362118 ],
146345 "type": "string"
1562118 }
1662118 },
1763918 "required": [
1863918 "reaction"
1963918 ],
2065711 "type": "object"
2162147}
Responses2 of 4 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the request is invalid. For example, if the reaction is not valid.2035ms
403Returned if the client does not have sufficient permissions to toggle the emoji reaction for the activity.0never seen
404Returned if the activity does not exist or the client does not have sufficient permissions
to see it.2843ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1832ms
41511ms
500Internal Server Error423ms
Examples1 / 1 used
Body: application/hal+json
"thumbs_up"reaction
Attachments17 operations17 covered0 partial0 uncovered0 not measured100%#
Responses2 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting one of the required parts (metadata and file)
* sending unparsable JSON in the metadata part0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** At least one permission in any project: edit work package, add work package, edit messages, edit wiki pages (plugins might extend this list)0never seen
406Occurs when the client did not send a Content-Type header14913ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the client tries to send an invalid attachment.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Sending a file that is too large112ms
400Returned if the client sends a not understandable request. Reasons include:
* Omitting the `metadata` part
* Sending unparsable JSON in the `metadata` part3633ms
403Returned if the client does not have sufficient permissions.
**Required permission:** At least one permission in any project that allows creating
attachments (e.g. edit work package, add work package, edit messages, edit wiki pages;
plugins might extend this list)0never seen
406Occurs when the client did not send a Content-Type header383ms
415Occurs when the client sends an unsupported Content-Type header.13ms
422Returned if the client tries to prepare an invalid attachment upload.1475ms
204Returned if the attachment was deleted successfully.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned along with an appropriate HTTP status.4314ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit permission for the container of the attachment or being the author for attachments without container
*Note that you will only receive this error, if you are at least allowed to see the attachment.*0never seen
404Returned if the attachment does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view permission for the container of the attachment or being the author for attachments without container
*Note: A client without sufficient permissions shall not be able to test for the existence of an attachment.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1233ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized563ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
166151{
266151 "type": "integer"
366151}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK4156ms
404Returned if the attachment does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view permission for the container of the attachment or being the author for attachments without container
*Note: A client without sufficient permissions shall not be able to test for the existence of an attachment.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1494ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1453ms
500Internal Server Error35ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169042{
269042 "type": "integer"
369042}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if any of the following is true:
* No pending, prepared upload with the given id exists (e.g. it was already completed, was
never prepared, or does not belong to the current user)
* the client does not have sufficient permissions to see the attachment
* the file has not actually been uploaded to the storage backend yet (i.e. step 2 of the
flow was skipped or has not finished successfully)
*Note: A client without sufficient permissions shall not be able to test for the existence
of an attachment. That's why a 404 is returned here, even if a 403 might be more
appropriate.*5764ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1562ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
178229{
278229 "type": "integer"
378229}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK2415ms
404Returned if the meeting does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view meetings
*Note: A client without sufficient permissions shall not be able to test for the existence of a meeting.
That's why a 404 is returned here, even if a 403 might be more appropriate.*3984ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1463ms
400Bad Request262ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
172060{
272060 "type": "integer"
372060}
Responses3 of 7 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting one of the required parts (metadata and file)
* sending unparsable JSON in the metadata part582ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings
*Note that you will only receive this error, if you are at least allowed to see the meeting*0never seen
404Returned if the meeting does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view meetings
*Note: A client without sufficient permissions shall not be able to test for the existence of a meeting
That's why a 404 is returned here, even if a 403 might be more appropriate.*15ms
406Occurs when the client did not send a Content-Type header5803ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the client tries to send an invalid attachment.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Sending a file that is too large0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting the `metadata` part
* sending unparsable JSON in the metadata part755ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings
*Note that you will only receive this error, if you are at least allowed to see the meeting*0never seen
404Returned if the meeting does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view meetings
*Note: A client without sufficient permissions shall not be able to test for the existence of a meeting.
That's why a 404 is returned here, even if a 403 might be more appropriate.*4094ms
406Occurs when the client did not send a Content-Type header1423ms
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if the client tries to prepare an invalid attachment upload.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Omitting the file size (`fileSize` property of metadata part)
* The instance is not configured for direct uploads248ms
404Returned if the post does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view messages
*Note: A client without sufficient permissions shall not be able to test for the existence of a post.
That's why a 404 is returned here, even if a 403 might be more appropriate.*5664ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1162ms
400Bad Request442ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168349{
268349 "type": "integer"
368349}
Responses3 of 7 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting one of the required parts (metadata and file)
* sending unparsable JSON in the metadata part452ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit messages
*Note that you will only receive this error, if you are at least allowed to see the wiki page*0never seen
404Returned if the post does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view messages
*Note: A client without sufficient permissions shall not be able to test for the existence of a post.
That's why a 404 is returned here, even if a 403 might be more appropriate.*15ms
406Occurs when the client did not send a Content-Type header5813ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the client tries to send an invalid attachment.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Sending a file that is too large0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting the `metadata` part
* sending unparsable JSON in the metadata part333ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit messages
*Note that you will only receive this error, if you are at least allowed to see the post.*0never seen
404Returned if the post does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view messages
*Note: A client without sufficient permissions shall not be able to test for the existence of a post.
That's why a 404 is returned here, even if a 403 might be more appropriate.*3855ms
406Occurs when the client did not send a Content-Type header2083ms
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if the client tries to prepare an invalid attachment upload.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Omitting the file size (`fileSize` property of metadata part)
* The instance is not configured for direct uploads0never seen
404Returned if the wiki page does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view wiki pages
*Note: A client without sufficient permissions shall not be able to test for the existence of a work package.
That's why a 404 is returned here, even if a 403 might be more appropriate.*5904ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1032ms
400Bad Request352ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
170433{
270433 "type": "integer"
370433}
Responses3 of 7 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting one of the required parts (metadata and file)
* sending unparsable JSON in the metadata part313ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit wiki pages
*Note that you will only receive this error, if you are at least allowed to see the wiki page*0never seen
404Returned if the wiki page does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view wiki pages
*Note: A client without sufficient permissions shall not be able to test for the existence of a wiki page
That's why a 404 is returned here, even if a 403 might be more appropriate.*16ms
406Occurs when the client did not send a Content-Type header5713ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the client tries to send an invalid attachment.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Sending a file that is too large0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting the `metadata` part
* sending unparsable JSON in the metadata part3144ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit wiki pages
*Note that you will only receive this error, if you are at least allowed to see the wiki page*0never seen
404Returned if the wiki page does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view wiki pages
*Note: A client without sufficient permissions shall not be able to test for the existence of a wiki page
That's why a 404 is returned here, even if a 403 might be more appropriate.*655ms
406Occurs when the client did not send a Content-Type header2193ms
415Occurs when the client sends an unsupported Content-Type header.25ms
422Returned if the client tries to prepare an invalid attachment upload.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Omitting the file size (`fileSize` property of metadata part)
* The instance is not configured for direct uploads137ms
404Returned if the work package does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work package
*Note: A client without sufficient permissions shall not be able to test for the existence of a work package.
That's why a 404 is returned here, even if a 403 might be more appropriate.*4724ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized953ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11896230{
21896230 "type": "integer"
31896230}
Responses2 of 7 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting one of the required parts (metadata and file)
* sending unparsable JSON in the metadata part0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work package or add work package
*Note that you will only receive this error, if you are at least allowed to see the work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work package
*Note: A client without sufficient permissions shall not be able to test for the existence of a work package.
That's why a 404 is returned here, even if a 403 might be more appropriate.*13ms
406Occurs when the client did not send a Content-Type header20193ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the client tries to send an invalid attachment.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Sending a file that is too large0never seen
400Returned if the client sends a not understandable request. Reasons include:
* Omitting the `metadata` part
* sending unparsable JSON in the metadata part0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work package or add work package
*Note that you will only receive this error, if you are at least allowed to see the work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work package
*Note: A client without sufficient permissions shall not be able to test for the existence of a work package.
That's why a 404 is returned here, even if a 403 might be more appropriate.*4855ms
406Occurs when the client did not send a Content-Type header1773ms
415Occurs when the client sends an unsupported Content-Type header.42ms
422Returned if the client tries to prepare an invalid attachment upload.
Reasons are:
* Omitting the file name (`fileName` property of metadata part)
* Omitting the file size (`fileSize` property of metadata part)
* The instance is not configured for direct uploads110ms
Budgets2 operations2 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1576156{
2576156 "type": "integer"
3576156}
Responses0 of 2 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** view work packages **or** view budgets (on the budgets project)0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6573ms
401Unauthorized752ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175246{
275246 "type": "integer"
375246}
Responses3 of 3 documented received
codedescriptionhitsavg
200OK16ms
403Returned if the client does not have sufficient permissions to see the budgets of the given
project.
**Required permission:** view work packages **or** view budgets
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*3824ms
404Returned if either:
* the project does not exist
* the client does not have sufficient permissions to see the project
* the costs module is not enabled on the given project
**Required permission:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*2824ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1113ms
500Internal Server Error224ms
Categories3 operations3 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
118415{
218415 "type": "integer"
318415}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK122ms
404Returned if the category does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project (defining the category)
*Note: A client without sufficient permissions shall not be able to test for the existence of
a category. That's why a 404 is returned here, even if a 403 might be more appropriate.*1293ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized692ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
177739{
277739 "type": "integer"
377739}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK5305ms
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1344ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1283ms
500Internal Server Error244ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1588305{
2588305 "type": "integer"
3588305}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK1035ms
404Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view workspace
*Note: A client without sufficient permissions shall not be able to test for the existence of a workspace.
That's why a 404 is returned here, even if a 403 might be more appropriate.*5034ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2273ms
500Internal Server Error604ms
Collections1 operation1 covered0 partial0 uncovered0 not measured100%#
Query Parameters2 of 2 keywords covered
groupBy1 / 1
#validinvalidschema
1255n/a{
2255n/a "type": "string"
3255n/a}
showSums1 / 1
1170121{
2170121 "type": "boolean"
3170121}
Responses0 of 1 documented received
codedescriptionhitsavg
200OK0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6363ms
401Unauthorized1092ms
Examples1 / 1 used
Query
falseshowSums
Configuration2 operations2 covered0 partial0 uncovered0 not measured100%#
Responses1 of 1 documented received
codedescriptionhitsavg
200OK9554ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175843{
275843 "type": "integer"
375843}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK4995ms
404Returned if the project does not exist or the user cannot view it.1664ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1223ms
500Internal Server Error146ms
Custom actions2 operations2 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1608122{
2608122 "type": "integer"
3608122}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work packages in any project0never seen
404Returned if the custom action does not exist.6374ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized933ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
166667{
266667 "type": "integer"
366667}
Body8 of 8 keywords covered
application/json8 / 8
144245{
226631 "properties": {
325826 "_links": {
418021 "properties": {
518021 "workPackage": {
614411 "properties": {
714411 "href": {
814411 "type": "string"
914411 }
1014411 },
1119110 "type": "object"
1218021 }
1318021 },
142795 "type": "object"
1525826 },
1625516 "lockVersion": {
1725516 "type": "string"
1825516 }
1926631 },
2047314 "type": "object"
2144245}
Responses5 of 8 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.793ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work packages - Additional permissions might be required based on the custom action.0never seen
404Returned if the custom action does not exist.2864ms
406Occurs when the client did not send a Content-Type header1963ms
409Returned if the client provided an outdated lockVersion or no lockVersion at all.0never seen
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if the custom action was not executed successfully e.g. when a constraint on a work package property was violated.794ms
Custom Fields4 operations4 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1606122{
2606122 "type": "integer"
3606122}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the user is not logged in.0never seen
404Returned if the custom field item does not exist or the user lacks permission to see it.
The permission required to view the item depends on the custom field it belongs to.6363ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized922ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1615119{
2615119 "type": "integer"
3615119}
Responses1 of 4 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the user is not logged in.0never seen
404Returned if the custom field does not exist or the user lacks permission to view it.5333ms
422Returned if the custom field is not of type hierarchy.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized852ms
400Bad Request1162ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1596138{
2596138 "type": "integer"
3596138}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the user is not logged in.0never seen
404Returned if the custom field does not exist or the user lacks the permission to view it.6643ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized703ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164487{
264487 "type": "integer"
364487}
Query Parameters2 of 2 keywords covered
parent1 / 1
118290{
218290 "type": "integer"
318290}
depth1 / 1
117595{
217595 "type": "integer"
317595}
Responses1 of 4 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the user is not logged in.0never seen
404Returned if the custom field does not exist or the user lacks the permission to view it.6073ms
422Returned if the custom field is not of type hierarchy.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized483ms
400Bad Request762ms
Custom Options1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1588122{
2588122 "type": "integer"
3588122}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the custom option does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package in any project the custom option's custom field is active in.6333ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized773ms
Documents3 operations3 covered0 partial0 uncovered0 not measured100%#
Query Parameters3 of 3 keywords covered
offset1 / 1
#validinvalidschema
122190{
222190 "type": "integer"
322190}
pageSize1 / 1
117878{
217878 "type": "integer"
317878}
sortBy1 / 1
1235n/a{
2235n/a "type": "string"
3235n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK5704ms
400Returned if the client sends invalid request parameters e.g. filters0never seen
403Returned if the client is not logged in and login is required.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized943ms
500Internal Server Error944ms
Examples1 / 1 used
Query
1offset
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
167539{
267539 "type": "integer"
367539}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the document does not exist or if the user does not have permission to view it.
**Required permission** `view documents` in the project the document belongs to5894ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1253ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169521{
269521 "type": "integer"
369521}
Body6 of 6 keywords covered
application/json6 / 6
136755{
221849 "properties": {
319944 "description": {
414317 "properties": {
514317 "raw": {
614317 "type": "string"
714317 }
814317 },
921627 "type": "object"
1019944 },
1120220 "title": {
1220220 "type": "string"
1320220 }
1421849 },
154166 "type": "object"
1636755}
Responses2 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the request body is invalid.202ms
403Returned if the user does not have permission to edit the document.
**Required permission** `manage documents` in the project the document belongs to0never seen
404Returned if the document does not exist or if the user does not have permission to view it.
**Required permission** `view documents` in the project the document belongs to3914ms
422Returned if the request body contains validation errors.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized323ms
41522ms
4062713ms
File Links4 operations4 covered0 partial0 uncovered0 not measured100%#
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
11132n/a{
21132n/a "type": "string"
31132n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK8013ms
400Returned if any given filter is invalid.2704ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5332ms
500Internal Server Error5884ms
Examples1 / 1 used
Query
"[]"filters
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1641124{
2641124 "type": "integer"
3641124}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the project storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links6673ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized983ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1613131{
2613131 "type": "integer"
3613131}
Responses1 of 3 documented received
codedescriptionhitsavg
303Redirect0never seen
403Returned if the authorization token of the current user grants no permission to access the remote storage.0never seen
404Returned if the project storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links5153ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1133ms
400Bad Request1162ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1681124{
2681124 "type": "integer"
3681124}
Responses1 of 2 documented received
codedescriptionhitsavg
303Redirect0never seen
404Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links5873ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1123ms
400Bad Request1062ms
File links13 operations13 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1616116{
2616116 "type": "integer"
3616116}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** manage file links
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package or the file link does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work package, view file links6363ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized962ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1610108{
2610108 "type": "integer"
3610108}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links6313ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized872ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1607120{
2607120 "type": "integer"
3607120}
Responses1 of 2 documented received
codedescriptionhitsavg
303Returned if the request was successful. In the `Location` header is the uri where the client can download the
origin file from the storage.0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links5483ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized692ms
400Bad Request1102ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
165775{
265775 "type": "integer"
365775}
Query Parameters1 of 1 keywords covered
location1 / 1
121185{
221185 "type": "boolean"
321185}
Responses1 of 2 documented received
codedescriptionhitsavg
303Returned if the request was successful. In the `Location` header is the uri where the client can open the origin
file on the storage.0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links6013ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized633ms
400Bad Request683ms
Responses1 of 2 documented received
codedescriptionhitsavg
200OK15174ms
400Returned if the client sends invalid request parameters e.g. filters0never seen
400Returned if the given parent parameter value does not refer to a directory.672ms
404Returned in either of those cases:
- if the storage does not exist or the client does not have sufficient permissions to see it
**Required permission:** view file links
- if the document root file identification does not exist on the storage6753ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized663ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168395{
268395 "type": "integer"
368395}
Body7 of 7 keywords covered
application/json7 / 7
StorageFileUploadPreparationModel
136390{
237666 "properties": {
341226 "fileName": {
441226 "type": "string"
541226 },
641823 "parent": {
741823 "type": "string"
841823 },
940925 "projectId": {
1040920 "minimum": 1,
114286 "type": "integer"
1240925 }
1337666 },
1442917 "required": [
1543412 "projectId",
164388 "fileName",
174415 "parent"
1842917 ],
194467 "type": "object"
2036390}
Responses2 of 5 documented received
codedescriptionhitsavg
201OK0never seen
400Returned if the given parent parameter value does not refer to a directory.1063ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage file links0never seen
404Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links3563ms
500Returned if the outbound request to the storage has failed with any reason.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized403ms
41522ms
4062743ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
171966{
271966 "type": "integer"
371966}
Body5 of 5 keywords covered
application/json5 / 5
StorageFolderWriteModel
141645{
243418 "properties": {
342411 "name": {
442411 "type": "string"
542411 },
643813 "parentId": {
743813 "type": "string"
843813 }
943418 },
1043418 "required": [
1143517 "name",
124511 "parentId"
1343418 ],
144529 "type": "object"
1541645}
Responses2 of 4 documented received
codedescriptionhitsavg
201Created0never seen
400Returned if the request is missing a required parameter.7832ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage file links0never seen
404Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links13ms
Undocumented - not in spec
codedescriptionhitsavg
41513ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
171648{
271648 "type": "integer"
371648}
Body5 of 5 keywords covered
application/json5 / 5
OAuthClientCredentialsWriteModel
140843{
241819 "properties": {
341414 "clientId": {
441414 "type": "string"
541414 },
642214 "clientSecret": {
742214 "type": "string"
842214 }
941819 },
1042717 "required": [
1142816 "clientId",
124368 "clientSecret"
1342717 ],
144447 "type": "object"
1540843}
Responses1 of 3 documented received
codedescriptionhitsavg
201Created0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** admin0never seen
404Returned if the storage does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view file links4064ms
Forms1 operation1 covered0 partial0 uncovered0 not measured100%#
Body5 of 5 keywords covered
application/json5 / 5
#validinvalidschema
1340190{
2191155 "properties": {
3166113 "_type": {
4166113 "type": "string"
5166113 },
6150128 "lockVersion": {
7150128 "type": "number"
8150128 },
920649 "subject": {
1020649 "type": "string"
1120649 }
12191155 },
1349535 "type": "object"
14340190}
Responses3 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body and the request body
was not empty.
Note that this error only occurs when the content is not at all a single JSON object.
It **does not occur** for requests containing undefined properties or invalid property values.1682ms
403Returned if the client does not have sufficient permissions to modify the associated resource.0never seen
406Occurs when the client did not send a Content-Type header253ms
409Returned if underlying resource was changed since the client requested the form. This is determined using the `lockVersion` property.0never seen
415Occurs when the client sends an unsupported Content-Type header.23ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4433ms
401Unauthorized992ms
Examples1 / 1 used
Body: application/json
{
"_type": "Example",
"lockVersion": 5,
"subject": "An example title"
}example
Grids6 operations6 covered0 partial0 uncovered0 not measured100%#
Query Parameters3 of 3 keywords covered
offset1 / 1
#validinvalidschema
12100454{
22100454 "type": "integer"
32100454}
pageSize1 / 1
11207351{
21207351 "type": "integer"
31207351}
filters1 / 1
12789n/a{
22789n/a "type": "string"
32789n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK9989ms
400Returned if the client sends invalid request parameters e.g. filters3074ms
403Returned if the client is not logged in and login is required.0never seen
404Returned if the Grid does not exist or if the user does not have permission to view it.
**Required permission** depends on the page the grid is defined for6394ms
400Occurs when the client did not send a valid JSON object in the request body.1253ms
403Returned if the client does not have sufficient permissions.
**Required permission:** The permission depends on the page the grid is placed in.0never seen
406Occurs when the client did not send a Content-Type header1743ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** depends on the page the grid is defined for.
*Note that you will only receive this error, if you are at least allowed to see the corresponding grid.*0never seen
404Returned if the grid does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package0never seen
406Occurs when the client did not send a Content-Type header6423ms
415Occurs when the client sends an unsupported Content-Type header.13ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1483ms
400Bad Request392ms
Groups5 operations5 covered0 partial0 uncovered0 not measured100%#
Query Parameters2 of 2 keywords covered
sortBy1 / 1
#validinvalidschema
1200n/a{
2200n/a "type": "string"
3200n/a}
select1 / 1
1184n/a{
2184n/a "type": "string"
3184n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK47415ms
403Returned if the client does not have sufficient permissions.
**Required permission:** View members or manage members in any project0never seen
202Returned if the group was marked for deletion.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned, indicating the progress of deletion.348ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrator0never seen
404Returned if the group does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** Administrator
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*5333ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized813ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1615120{
2615120 "type": "integer"
3615120}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK385ms
404Returned if the group does not exist or if the API user does not have permission to view them.
**Required permission** If the user has the *manage members* permission in at least one project the user will be able to query all groups. If not, the user
will be able to query all groups which are members in projects, he has the *view members* permission in.6153ms
400Occurs when the client did not send a valid JSON object in the request body.453ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrator0never seen
404Returned if the group does not exist or the client does not have sufficient permissions
to see it.
**Required permission** If the user has the *manage members* permission in at least one project the user will be able to query all groups. If not, the user
will be able to query all groups which are members in projects, he has the *view members* permission in.
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*3494ms
406Occurs when the client did not send a Content-Type header2453ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)26ms
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** create meetings in any project0never seen
406Occurs when the client did not send a Content-Type header2272ms
415Occurs when the client sends an unsupported Content-Type header.13ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5142ms
Responses1 of 2 documented received
codedescriptionhitsavg
200OK2205ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view meetings in any project0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5172ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
138883{
238883 "type": "integer"
338883}
Responses2 of 5 documented received
codedescriptionhitsavg
204Returned if the meeting was successfully deleted3119ms
403Returned if the client does not have sufficient permissions.
**Required permission:** delete meetings0never seen
404Returned if the meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the meeting's project3753ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized652ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160489{
260489 "type": "integer"
360489}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK21711ms
404Returned if the meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the meeting's project3904ms
400Occurs when the client did not send a valid JSON object in the request body.512ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings in the meeting's project137ms
404Returned if the meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the meeting's project3494ms
406Occurs when the client did not send a Content-Type header1593ms
415Occurs when the client sends an unsupported Content-Type header.21ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)177ms
404Returned if the meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings3654ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1393ms
400Bad Request232ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
174237{
274237 "type": "integer"
374237}
Responses3 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.352ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings in the meeting's project0never seen
406Occurs when the client did not send a Content-Type header5303ms
415Occurs when the client sends an unsupported Content-Type header.14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2132ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
171526{
271526 "type": "integer"
371526}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK1866ms
404Returned if the meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings3924ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1383ms
400Bad Request252ms
Path Parameters2 of 2 keywords covered
meeting_id1 / 1
#validinvalidschema
176541{
276541 "type": "integer"
376541}
agenda_item_id1 / 1
176541{
276541 "type": "integer"
376541}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK110ms
404Returned if the agenda item or meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings6294ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1273ms
400Bad Request492ms
Path Parameters3 of 3 keywords covered
meeting_id1 / 1
#validinvalidschema
173733{
273733 "type": "integer"
373733}
agenda_item_id1 / 1
173733{
273733 "type": "integer"
373733}
id1 / 1
173238{
273238 "type": "integer"
373238}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the outcome, agenda item, or meeting does not exist or the client does not have sufficient permissions.6335ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1263ms
400Bad Request112ms
Path Parameters2 of 2 keywords covered
meeting_id1 / 1
#validinvalidschema
176232{
276232 "type": "integer"
376232}
id1 / 1
176826{
276826 "type": "integer"
376826}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK116ms
404Returned if the agenda item or meeting does not exist or the client does not have sufficient permissions.6534ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1353ms
400Bad Request52ms
Path Parameters2 of 2 keywords covered
meeting_id1 / 1
#validinvalidschema
174142{
274142 "type": "integer"
374142}
id1 / 1
174538{
274538 "type": "integer"
374538}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK110ms
404Returned if the section or meeting does not exist or the client does not have sufficient permissions.6414ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1323ms
400Bad Request92ms
Memberships9 operations5 covered4 partial0 uncovered0 not measured96%#
Query Parameters2 of 2 keywords covered
filters1 / 1
#validinvalidschema
11178n/a{
21178n/a "type": "string"
31178n/a}
sortBy1 / 1
1969n/a{
2969n/a "type": "string"
3969n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK10427ms
400Returned if the client sends invalid request parameters e.g. filters0never seen
403Returned if the client is not logged in and login is required.0never seen
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
trueMembershipWriteModel._meta.sendNotification
Responses1 of 2 documented received
codedescriptionhitsavg
200OK2424ms
403Returned if the client does not have sufficient permissions to see the schema.
**Required permission:** manage members or view memberships on any project0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4802ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1609133{
2609133 "type": "integer"
3609133}
Responses2 of 5 documented received
codedescriptionhitsavg
204Returned if the membership was successfully deleted140ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage members0never seen
404Returned if the membership does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view members
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*6513ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized903ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1620114{
2620114 "type": "integer"
3620114}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK118ms
404Returned if the membership does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view members **or** manage members
*Note: A client without sufficient permissions shall not be able to test for the existence of
a membership. That's why a 404 is returned here, even if a 403 might be more appropriate.*6523ms
400Occurs when the client did not send a valid JSON object in the request body.193ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Manage members in the membership's project.0never seen
404Returned if the membership does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view member
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*6543ms
406Occurs when the client did not send a Content-Type header1983ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)224ms
400Occurs when the client did not send a valid JSON object in the request body.2083ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrator, Manage news permission in the project0never seen
406Occurs when the client did not send a Content-Type header2363ms
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if:
* the client tries to modify a read-only property (`PropertyIsReadOnly`)
* a constraint for a property was violated (`PropertyConstraintViolation`)7234ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized983ms
500Internal Server Error964ms
Examples4 / 6 used
Body: application/json
{
"_links": {
"project": {
"href": "/api/v3/projects/1"
}
},
"description": {
"format": "markdown",
"raw": "**Videlicet deserunt aequitas cognatus**. Concedo quia est quia pariatur vorago vallum. Calco autem atavus accusamus conscendo cornu ulterius. Tam patria ago consectetur ventito sustineo nihil caecus. Supra officiis eos velociter somniculosus tonsor qui. Suffragium aduro arguo angustus cogito quia tolero vulnus. Supplanto sortitus cresco apud vestrum qui."
},
"summary": "Celebrer spiculum colo viscus claustrum atque. Id nulla culpa sumptus. Comparo crapula depopulo demonstro.",
"title": "asperiores possimus nam doloribus ab"
}NewsCreateModel
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
163099{
263099 "type": "integer"
363099}
Responses1 of 3 documented received
codedescriptionhitsavg
202Returned if the news was deleted successfully.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned, indicating the progress of deletion.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrators and Manage news permission0never seen
404Returned if the news does not exist.6444ms
Undocumented - not in spec
codedescriptionhitsavg
204No Content115ms
401Unauthorized843ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1626105{
2626105 "type": "integer"
3626105}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK215ms
404Returned if the news does not exist or if the user does not have permission to view it.
**Required permission** being member of the project the news belongs to6514ms
400Occurs when the client did not send a valid JSON object in the request body.542ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrators, Manage news permission0never seen
404Returned if the news entry does not exist or if the API user does not have the necessary permissions to update it.
**Required permission:** Administrators, Manage news permission3944ms
406Occurs when the client did not send a Content-Type header2993ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* the client tries to modify a read-only property (`PropertyIsReadOnly`)
* a constraint for a property was violated (`PropertyConstraintViolation`)19ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized363ms
Examples4 / 6 used
Body: application/json
{
"_links": {
"project": {
"href": "/api/v3/projects/1"
}
},
"description": {
"format": "markdown",
"raw": "**Videlicet deserunt aequitas cognatus**. Concedo quia est quia pariatur vorago vallum. Calco autem atavus accusamus conscendo cornu ulterius. Tam patria ago consectetur ventito sustineo nihil caecus. Supra officiis eos velociter somniculosus tonsor qui. Suffragium aduro arguo angustus cogito quia tolero vulnus. Supplanto sortitus cresco apud vestrum qui."
},
"summary": "Celebrer spiculum colo viscus claustrum atque. Id nulla culpa sumptus. Comparo crapula depopulo demonstro.",
"title": "asperiores possimus nam doloribus ab"
}NewsCreateModel
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Notifications7 operations7 covered0 partial0 uncovered0 not measured100%#
Query Parameters5 of 5 keywords covered
offset1 / 1
#validinvalidschema
11083129{
21083129 "type": "integer"
31083129}
pageSize1 / 1
1935159{
2935159 "type": "integer"
3935159}
sortBy1 / 1
11103n/a{
21103n/a "type": "string"
31103n/a}
groupBy1 / 1
11188n/a{
21188n/a "type": "string"
31188n/a}
filters1 / 1
11046n/a{
21046n/a "type": "string"
31046n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK10495ms
403Returned if the client is not logged in and login is required.0never seen
422Returned if the client sends invalid request parameters e.g. filters0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3413ms
400Bad Request1624ms
500Internal Server Error8844ms
Examples2 / 2 used
Query
1offset
20pageSize
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
1221n/a{
2221n/a "type": "string"
3221n/a}
Responses2 of 4 documented received
codedescriptionhitsavg
204OK0never seen
400Returned if the request is not properly formatted.0never seen
406Occurs when the client did not send a Content-Type header5803ms
415Occurs when the client sends an unsupported Content-Type header.13ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1493ms
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
1215n/a{
2215n/a "type": "string"
3215n/a}
Responses2 of 4 documented received
codedescriptionhitsavg
204OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
406Occurs when the client did not send a Content-Type header6003ms
415Occurs when the client sends an unsupported Content-Type header.14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1332ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1643123{
2643123 "type": "integer"
3643123}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the notification does not exist or if the user does not have permission to view it.
**Required permission** being recipient of the notification6734ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized932ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1627132{
2627132 "type": "integer"
3627132}
Responses0 of 2 documented received
codedescriptionhitsavg
204OK0never seen
404Returned if the notification does not exist or if the user does not have permission to view it.
**Required permission** being recipient of the notification0never seen
Undocumented - not in spec
codedescriptionhitsavg
4066953ms
401Unauthorized633ms
41513ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1634127{
2634127 "type": "integer"
3634127}
Responses0 of 2 documented received
codedescriptionhitsavg
204OK0never seen
404Returned if the notification does not exist or if the user does not have permission to view it.
**Required permission** being recipient of the notification0never seen
Undocumented - not in spec
codedescriptionhitsavg
4066463ms
401Unauthorized1143ms
41514ms
Path Parameters2 of 2 keywords covered
notification_id1 / 1
#validinvalidschema
1649121{
2649121 "type": "integer"
3649121}
id1 / 1
1659111{
2659111 "type": "integer"
3659111}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the notification or the detail of it does not exist or if the user does not have permission to view it.
**Required permission** being recipient of the notification6654ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1053ms
OAuth 22 operations2 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
167158{
267158 "type": "integer"
367158}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK5194ms
403Returned if the client does not have sufficient permissions.
**Required permission:** admin0never seen
404Returned if the application does not exist.1073ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1033ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1593132{
2593132 "type": "integer"
3593132}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** admin0never seen
404Returned if the object does not exist.6583ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized673ms
Portfolios5 operations4 covered1 partial0 uncovered0 not measured96%#
Query Parameters3 of 3 keywords covered
filters1 / 1
#validinvalidschema
1969n/a{
2969n/a "type": "string"
3969n/a}
sortBy1 / 1
1946n/a{
2946n/a "type": "string"
3946n/a}
select1 / 1
11007n/a{
21007n/a "type": "string"
31007n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK9314ms
400Returned if the client sends invalid request parameters e.g. filters854ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4123ms
500Internal Server Error7314ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1593145{
2593145 "type": "integer"
3593145}
Responses1 of 6 documented received
codedescriptionhitsavg
204Returned if the portfolio was successfully deleted. There is currently no endpoint to query for the actual deletion status.
Such an endpoint _might_ be added in the future.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** admin0never seen
404Returned if the portfolio does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** any permission in the portfolio
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*5594ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the portfolio cannot be deleted. This can happen when there are still references to the portfolio in other workspaces
that need to be severed at first.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1073ms
500Internal Server Error724ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1621118{
2621118 "type": "integer"
3621118}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the portfolio does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** any permission in the portfolio
*Note: A client without sufficient permissions shall not be able to test for the existence of a portfolio.
That's why a 404 is returned here, even if a 403 might be more appropriate.*5944ms
400Occurs when the client did not send a valid JSON object in the request body.532ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit project for the portfolio to be altered0never seen
404Returned if the portfolio does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*11525ms
406Occurs when the client did not send a Content-Type header2283ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164087{
264087 "type": "integer"
364087}
Body1 of 1 keywords covered
application/json1 / 1
145337{
245337 "type": "object"
345337}
Responses3 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.492ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit workspace in the portfolio0never seen
406Occurs when the client did not send a Content-Type header1783ms
415Occurs when the client sends an unsupported Content-Type header.23ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4325ms
401Unauthorized373ms
500Internal Server Error294ms
Posts1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169233{
269233 "type": "integer"
369233}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the post does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view messages in the post's project5984ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1273ms
Previewing2 operations2 covered0 partial0 uncovered0 not measured100%#
Query Parameters1 of 1 keywords covered
context1 / 1
#validinvalidschema
1204n/a{
2204n/a "type": "string"
3204n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the context passed by the client is not valid (e.g. unknown).
Note that this response will also occur when the requesting user
is not allowed to see the context resource (e.g. limited work package visibility).0never seen
415Returned if the Content-Type indicated in the request is not `text/plain`.14ms
Undocumented - not in spec
codedescriptionhitsavg
4065663ms
401Unauthorized1723ms
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
415Returned if the Content-Type indicated in the request is not `text/plain`.14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5292ms
4062182ms
Principals6 operations6 covered0 partial0 uncovered0 not measured100%#
Query Parameters2 of 2 keywords covered
filters1 / 1
#validinvalidschema
1215n/a{
2215n/a "type": "string"
3215n/a}
select1 / 1
1194n/a{
2194n/a "type": "string"
3194n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK5044ms
400Returned if the client sends invalid request parameters e.g. filters204ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1573ms
500Internal Server Error444ms
Body3 of 3 keywords covered
application/json3 / 3
PlaceholderUserCreateModel
#validinvalidschema
1164191{
273735 "properties": {
373735 "name": {
473735 "type": "string"
573735 }
673735 },
7167656 "type": "object"
8164191}
Responses4 of 6 documented received
codedescriptionhitsavg
201Created0never seen
400Occurs when the client did not send a valid JSON object in the request body.1132ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrator0never seen
406Occurs when the client did not send a Content-Type header1933ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)13995ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3143ms
500Internal Server Error404ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
163890{
263890 "type": "integer"
363890}
Responses1 of 3 documented received
codedescriptionhitsavg
202Returned if the group was marked for deletion.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned, indicating the progress of deletion.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_placeholder_users`0never seen
404Returned if the placeholder user does not exist.6273ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1013ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1556125{
2556125 "type": "integer"
3556125}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the user does not exist or if the API user does not have permission to view them.
**Required permission**: `manage_placeholder_users`5783ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1032ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164862{
264862 "type": "integer"
364862}
Body3 of 3 keywords covered
application/json3 / 3
PlaceholderUserCreateModel
145137{
214511 "properties": {
314511 "name": {
414511 "type": "string"
514511 }
614511 },
746226 "type": "object"
845137}
Responses4 of 7 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.372ms
403Returned if the client does not have sufficient permissions.
**Required permission**: `manage_placeholder_users`0never seen
404Returned if the placeholder user does not exist.4383ms
406Occurs when the client did not send a Content-Type header1763ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
- the client tries to modify a read-only property (`PropertyIsReadOnly`)
- a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized573ms
Query Parameters2 of 2 keywords covered
filters1 / 1
#validinvalidschema
1205n/a{
2205n/a "type": "string"
3205n/a}
select1 / 1
1175n/a{
2175n/a "type": "string"
3175n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK45715ms
400Returned if the client sends invalid request parameters e.g. filters284ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1393ms
500Internal Server Error544ms
Priorities2 operations2 covered0 partial0 uncovered0 not measured100%#
Responses1 of 2 documented received
codedescriptionhitsavg
200OK13515ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package (on any project)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized8513ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
182734{
282734 "type": "integer"
382734}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK5664ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package (on any project)0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found624ms
401Unauthorized2333ms
Programs5 operations4 covered1 partial0 uncovered0 not measured96%#
Query Parameters3 of 3 keywords covered
filters1 / 1
#validinvalidschema
1979n/a{
2979n/a "type": "string"
3979n/a}
sortBy1 / 1
1949n/a{
2949n/a "type": "string"
3949n/a}
select1 / 1
1921n/a{
2921n/a "type": "string"
3921n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK9175ms
400Returned if the client sends invalid request parameters e.g. filters934ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3042ms
500Internal Server Error7744ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1633114{
2633114 "type": "integer"
3633114}
Responses1 of 6 documented received
codedescriptionhitsavg
204Returned if the program was successfully deleted. There is currently no endpoint to query for the actual deletion status.
Such an endpoint _might_ be added in the future.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** admin0never seen
404Returned if the program does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** any permission in the program
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*5894ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the program cannot be deleted. This can happen when there are still references to the program in other workspaces
that need to be severed at first.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1132ms
500Internal Server Error454ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1558145{
2558145 "type": "integer"
3558145}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the program does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** any permission in the program
*Note: A client without sufficient permissions shall not be able to test for the existence of a program.
That's why a 404 is returned here, even if a 403 might be more appropriate.*5994ms
400Occurs when the client did not send a valid JSON object in the request body.342ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit project for the program to be altered0never seen
404Returned if the program does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*11744ms
406Occurs when the client did not send a Content-Type header2533ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
167566{
267566 "type": "integer"
367566}
Body1 of 1 keywords covered
application/json1 / 1
137343{
237343 "type": "object"
337343}
Responses3 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.242ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit workspace in the program0never seen
406Occurs when the client did not send a Content-Type header2933ms
415Occurs when the client sends an unsupported Content-Type header.22ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3475ms
401Unauthorized483ms
500Internal Server Error274ms
Project Phase Definitions2 operations2 covered0 partial0 uncovered0 not measured100%#
Responses1 of 2 documented received
codedescriptionhitsavg
200OK14045ms
400Returned if the client sends invalid request parameters e.g. filters0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized8092ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
189528{
289528 "type": "integer"
389528}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK5764ms
404Returned if the user does not have permission to see project phases.
**Required permission:** view project phase OR select project phase994ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2483ms
Project Phases1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1599135{
2599135 "type": "integer"
3599135}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the project phase does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view project phase6633ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized712ms
Projects16 operations14 covered2 partial0 uncovered0 not measured91%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1729n/a{
2729n/a "type": "string"
3729n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK4873ms
404Returned if the project status does not exist.233ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2193ms
Query Parameters3 of 3 keywords covered
filters1 / 1
#validinvalidschema
11013n/a{
21013n/a "type": "string"
31013n/a}
sortBy1 / 1
1974n/a{
2974n/a "type": "string"
3974n/a}
select1 / 1
1989n/a{
2989n/a "type": "string"
3989n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK99113ms
400Returned if the client sends invalid request parameters e.g. filters834ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Query Parameters5 of 5 keywords covered
filters1 / 1
#validinvalidschema
1286n/a{
2286n/a "type": "string"
3286n/a}
of1 / 1
1252n/a{
2252n/a "type": "string"
3252n/a}
workspace_type2 / 2
1124335{
2124335 "enum": [
326n/a "project",
477n/a "program",
521n/a "portfolio"
6124335 ],
7459n/a "type": "string"
8124335}
sortBy1 / 1
1244n/a{
2244n/a "type": "string"
3244n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK2898ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit project in a project or the global add project permission0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found605ms
401Unauthorized1382ms
500Internal Server Error2204ms
Body1 of 1 keywords covered
application/json1 / 1
#validinvalidschema
1496122{
2496122 "type": "object"
3496122}
Responses4 of 5 documented received
codedescriptionhitsavg
200OK43213ms
400Occurs when the client did not send a valid JSON object in the request body.272ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add project which is a global permission0never seen
406Occurs when the client did not send a Content-Type header213ms
415Occurs when the client sends an unsupported Content-Type header.24ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized863ms
500Internal Server Error1074ms
Responses1 of 1 documented received
codedescriptionhitsavg
200OK13256ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized7212ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
116541{
216541 "type": "integer"
316541}
Responses2 of 6 documented received
codedescriptionhitsavg
204Returned if the project was successfully deleted. There is currently no endpoint to query for the actual deletion status.
Such an endpoint _might_ be added in the future.2021ms
403Returned if the client does not have sufficient permissions.
**Required permission:** admin0never seen
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** any permission in the project
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*1104ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if the project cannot be deleted. This can happen when there are still references to the project in other workspaces
that need to be severed at first.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized603ms
500Internal Server Error164ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
165244{
265244 "type": "integer"
365244}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK4436ms
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1154ms
400Occurs when the client did not send a valid JSON object in the request body.553ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit project for the project to be altered2810ms
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*9353ms
406Occurs when the client did not send a Content-Type header903ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)2810ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175844{
275844 "type": "integer"
375844}
Responses2 of 6 documented received
codedescriptionhitsavg
302Returned if the request is successful. It will redirect to the job statuses API with the backend job that got created. You can query that endpoint to check the status of the copy, and eventually get the created project.0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** copy projects in the source project0never seen
406Occurs when the client did not send a Content-Type header6803ms
415Occurs when the client sends an unsupported Content-Type header.14ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1213ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175253{
275253 "type": "integer"
375253}
Responses2 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** copy projects in the source project0never seen
406Occurs when the client did not send a Content-Type header6933ms
415Occurs when the client sends an unsupported Content-Type header.14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1113ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
142043{
242043 "type": "integer"
342043}
Responses2 of 3 documented received
codedescriptionhitsavg
204Returned if the project was successfully removed from favorites.844ms
403Returned if the client does not have sufficient permissions.
**Required permission:** logged in0never seen
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project1273ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2393ms
500Internal Server Error134ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
173143{
273143 "type": "integer"
373143}
Responses0 of 3 documented received
codedescriptionhitsavg
204Returned if the project was successfully added to favorites.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** logged in0never seen
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project0never seen
Undocumented - not in spec
codedescriptionhitsavg
4065883ms
401Unauthorized1853ms
41513ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
173030{
273030 "type": "integer"
373030}
Body1 of 1 keywords covered
application/json1 / 1
162433{
262433 "type": "object"
362433}
Responses5 of 5 documented received
codedescriptionhitsavg
200OK42714ms
400Occurs when the client did not send a valid JSON object in the request body.432ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit projects in the project55ms
406Occurs when the client did not send a Content-Type header403ms
415Occurs when the client sends an unsupported Content-Type header.23ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized823ms
404Not Found1444ms
500Internal Server Error175ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
167042{
267042 "type": "integer"
367042}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK47719ms
404Returned if the version does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (any project where the given version is available)
*Note: A client without sufficient permissions shall not be able to test for the existence of a version.
That's why a 404 is returned here, even if a 403 might be more appropriate.*335ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1633ms
400Bad Request392ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175337{
275337 "type": "integer"
375337}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK50919ms
404Returned if the version does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (any workspace where the given version is available)
*Note: A client without sufficient permissions shall not be able to test for the existence of a version.
That's why a 404 is returned here, even if a 403 might be more appropriate.*325ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2173ms
400Bad Request323ms
Queries16 operations16 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
177741{
277741 "type": "integer"
377741}
Query Parameters9 of 9 keywords covered
filters1 / 1
1221n/a{
2221n/a "type": "string"
3221n/a}
offset1 / 1
123731{
223731 "type": "integer"
323731}
pageSize1 / 1
119530{
219530 "type": "integer"
319530}
sortBy1 / 1
1242n/a{
2242n/a "type": "string"
3242n/a}
groupBy1 / 1
1242n/a{
2242n/a "type": "string"
3242n/a}
showSums1 / 1
120518{
220518 "type": "boolean"
320518}
timestamps1 / 1
1211n/a{
2211n/a "type": "string"
3211n/a}
timelineVisible1 / 1
117934{
217934 "type": "boolean"
317934}
showHierarchies1 / 1
117327{
217327 "type": "boolean"
317327}
Responses3 of 3 documented received
codedescriptionhitsavg
200OK34823ms
403Returned if the client does not have sufficient permissions to see the default query.
**Required permission:** view work packages in the project75ms
404Returned if the client does not have sufficient permissions to see the project.
**Required permission:** any permission in the project1824ms
403**Required permission:** view work package in the project14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1433ms
404Not Found1474ms
500Internal Server Error214ms
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
182n/a{
282n/a "type": "string"
382n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK164172ms
403Returned if the client does not have sufficient permissions to see queries.
**Required permission:** view work packages or manage public queries in any project0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized843ms
500Internal Server Error215ms
Body3 of 3 keywords covered
application/json3 / 3
Query_Create_Form
#validinvalidschema
11531159{
289898 "properties": {
389898 "name": {
489898 "type": "string"
589898 }
689898 },
7162961 "type": "object"
81531159}
Responses5 of 5 documented received
codedescriptionhitsavg
201Created86617ms
400Occurs when the client did not send a valid JSON object in the request body.722ms
406Occurs when the client did not send a Content-Type header1913ms
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if:
* the client tries to modify a read-only property (`PropertyIsReadOnly`)
* a constraint for a property was violated (`PropertyConstraintViolation`)
* the client provides a link to an invalid resource (`ResourceTypeMismatch`),
e.g. a user, project or operator not found62410ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1733ms
500Internal Server Error514ms
Examples1 / 1 used
Body: application/json
{
"name": "New query name"
}Query_Create_Form
Responses1 of 2 documented received
codedescriptionhitsavg
200OK21622ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work packages0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4423ms
Query Parameters10 of 10 keywords covered
filters1 / 1
#validinvalidschema
1294n/a{
2294n/a "type": "string"
3294n/a}
offset1 / 1
1295151{
2295151 "type": "integer"
3295151}
pageSize1 / 1
1168113{
2168113 "type": "integer"
3168113}
sortBy1 / 1
1273n/a{
2273n/a "type": "string"
3273n/a}
groupBy1 / 1
1230n/a{
2230n/a "type": "string"
3230n/a}
showSums1 / 1
118039{
218039 "type": "boolean"
318039}
timestamps1 / 1
1256n/a{
2256n/a "type": "string"
3256n/a}
timelineVisible1 / 1
115496{
215496 "type": "boolean"
315496}
timelineZoomLevel1 / 1
1237n/a{
2237n/a "type": "string"
3237n/a}
showHierarchies1 / 1
126072{
226072 "type": "boolean"
326072}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK20043ms
403Returned if the client does not have sufficient permissions to see the default query.
**Required permission:** view work packages in any project0never seen
403**Required permission:** view work package in any project0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5133ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11718{
21718 "type": "integer"
31718}
Responses2 of 3 documented received
codedescriptionhitsavg
204No Content628ms
403Returned if the client does not have sufficient permissions.
**Required permission:** for own queries none; for public queries: manage public queries
*Note that you will only receive this error, if you are at least allowed to see the corresponding query.*0never seen
404Returned if the query does not exist or the client does not have sufficient permissions to see it.
**Required condition:** query belongs to user or query is public
**Required permission:** view work package in queries project213ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized963ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175526{
275526 "type": "integer"
375526}
Query Parameters15 of 15 keywords covered
filters1 / 1
1184n/a{
2184n/a "type": "string"
3184n/a}
offset1 / 1
120230{
220230 "type": "integer"
320230}
pageSize1 / 1
119733{
219733 "type": "integer"
319733}
columns2 / 2
1190n/a{
2190n/a "items": {
3632n/a "type": "string"
4190n/a },
5190n/a "type": "array"
6190n/a}
sortBy1 / 1
1187n/a{
2187n/a "type": "string"
3187n/a}
groupBy1 / 1
1194n/a{
2194n/a "type": "string"
3194n/a}
showSums1 / 1
119528{
219528 "type": "boolean"
319528}
timestamps1 / 1
1171n/a{
2171n/a "type": "string"
3171n/a}
timelineVisible1 / 1
116726{
216726 "type": "boolean"
316726}
timelineLabels1 / 1
1222n/a{
2222n/a "type": "string"
3222n/a}
highlightingMode1 / 1
1181n/a{
2181n/a "type": "string"
3181n/a}
highlightedAttributes2 / 2
1178n/a{
2178n/a "items": {
3626n/a "type": "string"
4178n/a },
5178n/a "type": "array"
6178n/a}
showHierarchies1 / 1
120822{
220822 "type": "boolean"
320822}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK41780ms
404Returned if the query does not exist or the client does not have sufficient permissions to see it.
**Required condition:** query belongs to user or query is public
**Required permission:** view work package in queries project584ms
400Occurs when the client did not send a valid JSON object in the request body.602ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work package0never seen
404Returned if the query does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages in the query's project (unless global)353ms
406Occurs when the client did not send a Content-Type header333ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* the client tries to modify a read-only property (`PropertyIsReadOnly`)
* a constraint for a property was violated (`PropertyConstraintViolation`)
* the client provides a link to an invalid resource (`ResourceTypeMismatch`)914ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized563ms
500Internal Server Error76ms
Examples1 / 1 used
Body: application/json
{
"name": "Updated query name"
}Query_Update_Form
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160335{
260335 "type": "integer"
360335}
Body3 of 3 keywords covered
application/json3 / 3
Query_Update_Form
151233{
229021 "properties": {
329021 "name": {
429021 "type": "string"
529021 }
629021 },
753312 "type": "object"
851233}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK40764ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized673ms
400Bad Request713ms
404Not Found513ms
500Internal Server Error69ms
41523ms
406344ms
Examples1 / 1 used
Body: application/json
{
"name": "Updated query name"
}Query_Update_Form
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169856{
269856 "type": "integer"
369856}
Responses0 of 4 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** for own queries none; for public queries: manage public queries
*Note that you will only receive this error, if you are at least allowed to see the corresponding query.*0never seen
404Returned if the query does not exist or the client does not have sufficient permissions to see it.
**Required condition:** query belongs to user or query is public
**Required permission:** view work package in queries project0never seen
Undocumented - not in spec
codedescriptionhitsavg
4066413ms
401Unauthorized1122ms
41512ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169932{
269932 "type": "integer"
369932}
Responses2 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** for own queries none; for public queries: manage public queries
*Note that you will only receive this error, if you are at least allowed to see the corresponding query.*0never seen
404Returned if the query does not exist or the client does not have sufficient permissions to see it.
**Required condition:** query belongs to user or query is public
**Required permission:** view work package in queries project0never seen
406Occurs when the client did not send a Content-Type header6203ms
415Occurs when the client sends an unsupported Content-Type header.12ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1102ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1627206{
2627206 "type": "integer"
3627206}
Responses0 of 2 documented received
codedescriptionhitsavg
200OK0never seen
403**Required permission:** view work package in the workspace0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found7413ms
401Unauthorized923ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1680159{
2680159 "type": "integer"
3680159}
Query Parameters9 of 9 keywords covered
filters1 / 1
1284n/a{
2284n/a "type": "string"
3284n/a}
offset1 / 1
122340{
222340 "type": "integer"
322340}
pageSize1 / 1
125057{
225057 "type": "integer"
325057}
sortBy1 / 1
1262n/a{
2262n/a "type": "string"
3262n/a}
groupBy1 / 1
1259n/a{
2259n/a "type": "string"
3259n/a}
showSums1 / 1
124718{
224718 "type": "boolean"
324718}
timestamps1 / 1
1244n/a{
2244n/a "type": "string"
3244n/a}
timelineVisible1 / 1
122136{
222136 "type": "boolean"
322136}
showHierarchies1 / 1
124126{
224126 "type": "boolean"
324126}
Responses3 of 3 documented received
codedescriptionhitsavg
200OK8923ms
403Returned if the client does not have sufficient permissions to see the default query.
**Required permission:** view work packages in the workspace65ms
404Returned if the client does not have sufficient permissions to see the workspace.
**Required permission:** any permission in the workspace6024ms
204Returned if the recurring meeting was successfully deleted.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** delete meetings0never seen
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project6644ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized622ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1601132{
2601132 "type": "integer"
3601132}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK115ms
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project6494ms
400Occurs when the client did not send a valid JSON object in the request body.482ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings in the recurring meeting's project0never seen
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project6024ms
406Occurs when the client did not send a Content-Type header1913ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)112ms
200Returned if the series was ended successfully.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings in the recurring meeting's project0never seen
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project0never seen
422Returned if the series could not be ended, for example because it has not started yet.0never seen
Undocumented - not in spec
codedescriptionhitsavg
40620133ms
401Unauthorized1483ms
41514ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1656126{
2656126 "type": "integer"
3656126}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK18ms
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project5624ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1003ms
400Bad Request1192ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1637148{
2637148 "type": "integer"
3637148}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK19ms
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project5714ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized723ms
400Bad Request1412ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1665124{
2665124 "type": "integer"
3665124}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK19ms
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project5714ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1023ms
400Bad Request1152ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
170274{
270274 "type": "integer"
370274}
Query Parameters1 of 1 keywords covered
limit1 / 1
123670{
223670 "type": "integer"
323670}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK127ms
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project5974ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized813ms
400Bad Request972ms
Examples1 / 1 used
Query
20limit
Path Parameters3 of 3 keywords covered
id1 / 1
#validinvalidschema
1708100{
2708100 "type": "integer"
3708100}
start_time2 / 2
170999{
270999 "format": "date-time",
3808n/a "type": "string"
470999}
Responses2 of 4 documented received
codedescriptionhitsavg
204Returned if the occurrence was successfully cancelled.129ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings in the recurring meeting's project0never seen
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project5774ms
409Returned if the occurrence has already been instantiated as a meeting.
Delete the meeting directly via `DELETE /api/v3/meetings/{id}` instead.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1082ms
400Bad Request1222ms
Path Parameters3 of 3 keywords covered
id1 / 1
#validinvalidschema
11944214{
21944214 "type": "integer"
31944214}
start_time2 / 2
11978180{
21978180 "format": "date-time",
32158n/a "type": "string"
41978180}
Responses0 of 4 documented received
codedescriptionhitsavg
201Created — the occurrence was successfully instantiated as a meeting.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** create meetings in the recurring meeting's project0never seen
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project0never seen
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
Undocumented - not in spec
codedescriptionhitsavg
40618243ms
401Unauthorized1263ms
400Bad Request2072ms
41514ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11916127{
21916127 "type": "integer"
31916127}
Body4 of 4 keywords covered
application/json4 / 4
1150780{
2150727 "properties": {
3150727 "notify": {
4150727 "type": "boolean"
5150727 }
6150727 },
7153444 "required": [
8153444 "notify"
9153444 ],
1015789 "type": "object"
11150780}
Responses3 of 5 documented received
codedescriptionhitsavg
200Returned when the template is completed successfully.0never seen
400Returned if the required `notify` parameter is missing.4762ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit meetings in the recurring meeting's project0never seen
404Returned if the recurring meeting does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view meetings in the recurring meeting's project14724ms
422Returned if the template could not be completed, for example because the series has no
next occurrence to schedule or it has already been completed.136ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized583ms
41512ms
406353ms
Relations5 operations5 covered0 partial0 uncovered0 not measured100%#
Query Parameters2 of 2 keywords covered
filters1 / 1
#validinvalidschema
11073n/a{
21073n/a "type": "string"
31073n/a}
sortBy1 / 1
11013n/a{
21013n/a "type": "string"
31013n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK5336ms
400Returned if the client provides invalid filter parameters.0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error9494ms
401Unauthorized5013ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1585101{
2585101 "type": "integer"
3585101}
Responses2 of 5 documented received
codedescriptionhitsavg
204Returned if the relation was deleted successfully. The response body is empty.49ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage work package relations0never seen
404Returned if the relation does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages5994ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized833ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
162766{
262766 "type": "integer"
362766}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK8641ms
404Returned if the relation does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages for the involved work packages4914ms
400Occurs when the client did not send a valid JSON object in the request body.594ms
404Returned if the relation does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages4244ms
406Occurs when the client did not send a Content-Type header2203ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
- the client tries to modify a read-only property (`PropertyIsReadOnly`)
- a constraint for a property was violated (`PropertyConstraintViolation`)
- the client provides a link to an invalid resource (`ResourceTypeMismatch`) or a
work package that does not exist or for which the client does not have sufficient permissions
to see it (**required permissions**: `view work packages` for the involved work packages).118ms
400Occurs when the client did not send a valid JSON object in the request body.833ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage work package relations0never seen
406Occurs when the client did not send a Content-Type header2114ms
409Returned if there already exists a relation between the given work packages of **any** type
or if the relation is not allowed.0never seen
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
- the client tries to write a read-only property (`PropertyIsReadOnly`)
- a constraint for a property was violated (`PropertyConstraintViolation`)
- the client provides a link to an invalid resource (`ResourceTypeMismatch`)29ms
Reminders3 operations3 covered0 partial0 uncovered0 not measured100%#
Responses1 of 1 documented received
codedescriptionhitsavg
200OK13485ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized7052ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1658133{
2658133 "type": "integer"
3658133}
Responses1 of 2 documented received
codedescriptionhitsavg
204Reminder deleted successfully0never seen
404Returned if the reminder does not exist or the client does not have sufficient permissions to see it.7104ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized812ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
170974{
270974 "type": "integer"
370974}
Body5 of 5 keywords covered
application/json5 / 5
167347{
217532 "properties": {
315317 "note": {
415317 "type": "string"
515317 },
613322 "remindAt": {
713311 "format": "date-time",
814411 "type": "string"
913322 }
1017532 },
1170515 "type": "object"
1267347}
Responses1 of 2 documented received
codedescriptionhitsavg
200Reminder updated successfully0never seen
404Returned if the reminder does not exist or the client does not have sufficient permissions to see it.6754ms
Undocumented - not in spec
codedescriptionhitsavg
40614ms
401Unauthorized453ms
41522ms
400Bad Request602ms
Revisions1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169832{
269832 "type": "integer"
369832}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the revision does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view changesets for the project the repository is created in.
*Note: A client without sufficient permissions shall not be able to test for the existence of a revision.
That's why a 404 is returned here, even if a 403 might be more appropriate.*6113ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1193ms
Roles2 operations2 covered0 partial0 uncovered0 not measured100%#
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
1209n/a{
2209n/a "type": "string"
3209n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK5447ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1253ms
500Internal Server Error464ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1609133{
2609133 "type": "integer"
3609133}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK4094ms
403Returned if the client does not have sufficient permissions to see roles.
**Required permission:** view members **or** manage members0never seen
404Returned if the role does not exist.2293ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1043ms
Root1 operation1 covered0 partial0 uncovered0 not measured—#
Responses1 of 1 documented received
codedescriptionhitsavg
200OK2473ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4972ms
Schemas1 operation1 covered0 partial0 uncovered0 not measured—#
Responses0 of 1 documented received
codedescriptionhitsavg
200OK0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5232ms
404Not Found2173ms
Sprints3 operations3 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
172245{
272245 "type": "integer"
372245}
Query Parameters3 of 3 keywords covered
filters1 / 1
1257n/a{
2257n/a "type": "string"
3257n/a}
offset1 / 1
120550{
220550 "type": "integer"
320550}
pageSize1 / 1
122962{
222962 "type": "integer"
322962}
Responses3 of 3 documented received
codedescriptionhitsavg
200OK40010ms
403Returned if the user lacks permission to list sprints in the queried for project.
**Required permission:** view sprints in the project.55ms
404Returned if the project does not exist.
**Required permission:** view sprints in the queried for project.1894ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized733ms
500Internal Server Error1005ms
Examples1 / 1 used
Query
1offset
Query Parameters3 of 3 keywords covered
filters1 / 1
#validinvalidschema
1983n/a{
2983n/a "type": "string"
3983n/a}
offset1 / 1
1810158{
2810158 "type": "integer"
3810158}
pageSize1 / 1
1827161{
2827161 "type": "integer"
3827161}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK10787ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2273ms
500Internal Server Error6124ms
Examples1 / 1 used
Query
1offset
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1633137{
2633137 "type": "integer"
3633137}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the sprint does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view master backlogs (this will change to view sprints)6985ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized723ms
Statuses2 operations2 covered0 partial0 uncovered0 not measured100%#
Responses1 of 2 documented received
codedescriptionhitsavg
200OK13376ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package (on any project)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized6753ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
184437{
284437 "type": "integer"
384437}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK5825ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package (on any project)0never seen
404Returned if the status does not exist.723ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2273ms
Time Entries5 operations5 covered0 partial0 uncovered0 not measured100%#
Responses2 of 2 documented received
codedescriptionhitsavg
200OK16324ms
403Returned if the client does not have sufficient permissions.
**Required permission:** *log time*, *edit time entries* or *edit own time entries* in any project354ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4783ms
Responses2 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** *log time* in any project0never seen
406Occurs when the client did not send a Content-Type header2483ms
415Occurs when the client sends an unsupported Content-Type header.14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4942ms
Responses2 of 2 documented received
codedescriptionhitsavg
200OK2176ms
403Returned if the client does not have sufficient permissions to see the schema.
**Required permission:** *log time* or *view time entries* or *edit time entries* or *edit own time entries* on any project354ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4772ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1594133{
2594133 "type": "integer"
3594133}
Responses2 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** Edit (own) time entries, depending on what time entry is being modified.0never seen
406Occurs when the client did not send a Content-Type header6673ms
415Occurs when the client sends an unsupported Content-Type header.13ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized593ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1640102{
2640102 "type": "integer"
3640102}
Body1 of 1 keywords covered
application/json1 / 1
162056{
262056 "type": "integer"
362056}
Responses4 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.1352ms
403Returned if the client does not have sufficient permissions to edit the time entry.
**Required permission:** *edit time entries* for every time entry of a project, or *edit own time entries* for time entries belonging to the user.0never seen
404Returned if the time entry does not exist or if the client does not have sufficient permissions to view it.
**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 user5536ms
406Occurs when the client did not send a Content-Type header128ms
415Occurs when the client sends an unsupported Content-Type header.23ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized513ms
Time entries4 operations3 covered1 partial0 uncovered0 not measured96%#
Query Parameters4 of 4 keywords covered
offset1 / 1
#validinvalidschema
1918172{
2918172 "type": "integer"
3918172}
pageSize1 / 1
1861194{
2861194 "type": "integer"
3861194}
sortBy1 / 1
1945n/a{
2945n/a "type": "string"
3945n/a}
filters1 / 1
1922n/a{
2922n/a "type": "string"
3922n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK9876ms
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client is not logged in and login is required.0never seen
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1576146{
2576146 "type": "integer"
3576146}
Responses1 of 5 documented received
codedescriptionhitsavg
204Returned if the time entry was deleted successfully.0never seen
403Returned if the client does not have sufficient permissions0never seen
404Returned 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 user6694ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized532ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1602127{
2602127 "type": "integer"
3602127}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned 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 user6365ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized933ms
Time entry activities1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
170523{
270523 "type": "integer"
370523}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned 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 project5533ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1753ms
Types4 operations4 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175833{
275833 "type": "integer"
375833}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK4895ms
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage types (on given project)
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1544ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1253ms
500Internal Server Error164ms
403Forbidden75ms
Responses1 of 2 documented received
codedescriptionhitsavg
200OK2345ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package or manage types (on any project)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4762ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168741{
268741 "type": "integer"
368741}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK5434ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package or manage types (on any project)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1243ms
404Not Found614ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1604233{
2604233 "type": "integer"
3604233}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK1075ms
404Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage types (on given workspace)
*Note: A client without sufficient permissions shall not be able to test for the existence of a workspace.
That's why a 404 is returned here, even if a 403 might be more appropriate.*5424ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1202ms
500Internal Server Error484ms
403Forbidden204ms
User Working Times10 operations10 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1724n/a{
2724n/a "type": "string"
3724n/a}
Query Parameters1 of 1 keywords covered
year1 / 1
119883{
219883 "type": "integer"
319883}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK0never seen
401Returned if the client is not authenticated.923ms
404Returned if the user does not exist or is not visible to the requesting user.5503ms
400Occurs when the client did not send a valid JSON object in the request body.233ms
401Returned if the client is not authenticated.853ms
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_working_times` globally (for other users) or
`manage_own_working_times` globally (for own records).0never seen
404Returned if the user does not exist or is not visible to the requesting user.5074ms
406Occurs when the client did not send a Content-Type header2003ms
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if the request body contains invalid parameters, or if the date range
overlaps with an existing non-working time record for the user.27ms
204No Content.
The record was deleted successfully.0never seen
401Returned if the client is not authenticated.732ms
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_working_times` globally (for other users) or
`manage_own_working_times` globally (for own records).0never seen
404Returned if the user or non-working time record does not exist,
or if the requesting user does not have permission to view it.6473ms
Path Parameters2 of 2 keywords covered
id1 / 1
#validinvalidschema
1738n/a{
2738n/a "type": "string"
3738n/a}
non_working_time_id1 / 1
165187{
265187 "type": "integer"
365187}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK0never seen
401Returned if the client is not authenticated.1013ms
404Returned if the user or non-working time record does not exist,
or if the requesting user does not have permission to view it.6373ms
400Occurs when the client did not send a valid JSON object in the request body.212ms
401Returned if the client is not authenticated.993ms
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_working_times` globally (for other users) or
`manage_own_working_times` globally (for own records).0never seen
404Returned if the user or non-working time record does not exist,
or if the requesting user does not have permission to view it.4884ms
406Occurs when the client did not send a Content-Type header2243ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if the request body contains invalid parameters, or if the date range
overlaps with an existing non-working time record for the user.0never seen
400Occurs when the client did not send a valid JSON object in the request body.522ms
401Returned if the client is not authenticated.583ms
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_working_times` globally (for other users) or
`manage_own_working_times` globally (for own records).0never seen
404Returned if the user does not exist or is not visible to the requesting user.5444ms
406Occurs when the client did not send a Content-Type header2173ms
415Occurs when the client sends an unsupported Content-Type header.23ms
422Returned if the request body contains invalid parameters.18ms
204No Content.
The record was deleted successfully.0never seen
401Returned if the client is not authenticated.1142ms
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_working_times` globally (for other users) or
`manage_own_working_times` globally (for own records).0never seen
404Returned if the user or working hours record does not exist,
or if the requesting user does not have permission to view it.6293ms
Path Parameters2 of 2 keywords covered
id1 / 1
#validinvalidschema
165888{
265888 "type": "integer"
365888}
working_hours_id1 / 1
1646100{
2646100 "type": "integer"
3646100}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK0never seen
401Returned if the client is not authenticated.862ms
404Returned if the user or working hours record does not exist,
or if the requesting user does not have permission to view it.6603ms
400Occurs when the client did not send a valid JSON object in the request body.852ms
401Returned if the client is not authenticated.233ms
403Returned if the client does not have sufficient permissions.
**Required permission:** `manage_working_times` globally (for other users) or
`manage_own_working_times` globally (for own records).0never seen
404Returned if the user or working hours record does not exist,
or if the requesting user does not have permission to view it.5954ms
406Occurs when the client did not send a Content-Type header1693ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if the request body contains invalid parameters, or if the record has
already taken effect and cannot be modified.0never seen
Users9 operations9 covered0 partial0 uncovered0 not measured100%#
Query Parameters5 of 5 keywords covered
offset1 / 1
#validinvalidschema
1943329{
2943329 "type": "integer"
3943329}
pageSize1 / 1
1830345{
2830345 "type": "integer"
3830345}
filters1 / 1
11096n/a{
21096n/a "type": "string"
31096n/a}
sortBy1 / 1
11033n/a{
21033n/a "type": "string"
31033n/a}
select1 / 1
1987n/a{
2987n/a "type": "string"
3987n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK4216ms
400Occurs when the client did not send a valid JSON object in the request body.2655ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrator or any of: 'manage_members', 'manage_user', 'share_work_packages'.0never seen
Undocumented - not in spec
codedescriptionhitsavg
422Unprocessable Entity797ms
401Unauthorized1993ms
500Internal Server Error10364ms
41411ms
Examples1 / 1 used
Query
1offset
Body16 of 16 keywords covered
application/json16 / 16
UserCreateModel
#validinvalidschema
11517260{
21553196 "properties": {
3171429 "admin": {
4171429 "type": "boolean"
5171429 },
6100246 "currentPassword": {
7100246 "type": "string"
8100246 },
9166166 "email": {
10166136 "maxLength": 60,
11169730 "type": "string"
12166166 },
13171333 "firstName": {
14171318 "maxLength": 30,
15173115 "type": "string"
16171333 },
17172223 "language": {
18172223 "type": "string"
19172223 },
20170342 "lastName": {
21170317 "maxLength": 30,
22172025 "type": "string"
23170342 },
24170144 "login": {
25170119 "maxLength": 256,
26172025 "type": "string"
27170144 },
2899031 "password": {
2999031 "type": "string"
3099031 },
31103232 "status": {
32103232 "type": "string"
33103232 }
341553196 },
35171343 "required": [
36174313 "admin",
37172729 "email",
38174511 "login",
39174610 "firstName",
40174511 "lastName",
41174511 "language"
42171343 ],
43175621 "type": "object"
441517260}
Responses4 of 6 documented received
codedescriptionhitsavg
201Created0never seen
400Occurs when the client did not send a valid JSON object in the request body.1072ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrator0never seen
406Occurs when the client did not send a Content-Type header2163ms
415Occurs when the client sends an unsupported Content-Type header.24ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)15287ms
202Returned if the account was deleted successfully.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned, indicating the progress of deletion.0never seen
403Returned if the client does not have sufficient permissions or if deletion of users was disabled in the instance wide settings.
**Required permission:** Administrators only (exception: users might be able to delete their own accounts)4134ms
404Returned if the user does not exist.963ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2082ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1726n/a{
2726n/a "type": "string"
3726n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK5184ms
404Returned if the user does not exist or if the API user does not have permission to view them.
**Required permission** The user needs to be locked in if the installation is configured to prevent anonymous access253ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1832ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1726n/a{
2726n/a "type": "string"
3726n/a}
Body16 of 16 keywords covered
application/json16 / 16
UserCreateModel
158679{
259466 "properties": {
36525 "admin": {
46525 "type": "boolean"
56525 },
63295 "currentPassword": {
73295 "type": "string"
83295 },
964514 "email": {
106456 "maxLength": 60,
116518 "type": "string"
1264514 },
136527 "firstName": {
146522 "maxLength": 30,
156545 "type": "string"
166527 },
176509 "language": {
186509 "type": "string"
196509 },
206509 "lastName": {
216503 "maxLength": 30,
226536 "type": "string"
236509 },
2464910 "login": {
256495 "maxLength": 256,
266545 "type": "string"
2764910 },
283225 "password": {
293225 "type": "string"
303225 },
313185 "status": {
323185 "type": "string"
333185 }
3459466 },
356528 "required": [
366573 "admin",
376591 "email",
386591 "login",
396591 "firstName",
406591 "lastName",
416591 "language"
426528 ],
436605 "type": "object"
4458679}
Responses6 of 7 documented received
codedescriptionhitsavg
200OK44271ms
400Occurs when the client did not send a valid JSON object in the request body.263ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Administrators, manage_user global permission0never seen
404Returned if the user does not exist or if the API user does not have the necessary permissions to update it.
**Required permission:** Administrators only (exception: users may update their own accounts)205ms
406Occurs when the client did not send a Content-Type header203ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* the client tries to modify a read-only property (`PropertyIsReadOnly`)
* a constraint for a property was violated (`PropertyConstraintViolation`)457ms
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** manage_user global permission0never seen
404Returned if the request user can not be found.
*Note: A client without sufficient permissions shall not be able to test for the existence of
a membership. That's why a 404 is returned here, even if a 403 might be more appropriate.*0never seen
406Occurs when the client did not send a Content-Type header5323ms
415Occurs when the client sends an unsupported Content-Type header.14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2033ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1544101{
2544101 "type": "integer"
3544101}
Responses2 of 6 documented received
codedescriptionhitsavg
200OK3704ms
400Returned if the client tries to unlock a user account whose current status does not allow this transition.
**Required permission:** Administrators only0never seen
403Returned if the client does not have sufficient permissions for unlocking a user.
**Required permission:** Administrators only0never seen
404Returned if the user does not exist.2183ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized573ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11811182{
21811182 "type": "integer"
31811182}
Responses2 of 6 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the client tries to lock a user account whose current status does not allow this transition.
**Required permission:** Administrators only0never seen
403Returned if the client does not have sufficient permissions for locking a user.
**Required permission:** Administrators only0never seen
404Returned if the user does not exist.0never seen
406Occurs when the client did not send a Content-Type header18383ms
415Occurs when the client sends an unsupported Content-Type header.13ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1543ms
Values::Property1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1726n/a{
2726n/a "type": "string"
3726n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200OK0never seen
400Returned if the requested property id is not in a lower camel case format.0never seen
404Returned if the schema does not exist.5283ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1983ms
Versions11 operations9 covered2 partial0 uncovered0 not measured93%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
172054{
272054 "type": "integer"
372054}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK4957ms
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (on given project)
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*1384ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Responses1 of 2 documented received
codedescriptionhitsavg
200OK19317ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage versions0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4822ms
Responses2 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** manage versions in any project0never seen
406Occurs when the client did not send a Content-Type header2122ms
415Occurs when the client sends an unsupported Content-Type header.15ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5302ms
Responses1 of 2 documented received
codedescriptionhitsavg
200OK2035ms
403Returned if the client does not have sufficient permissions to see the schema.
**Required permission:** view work packages or manage versions on any project0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized5233ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
142743{
242743 "type": "integer"
342743}
Responses2 of 5 documented received
codedescriptionhitsavg
204Returned if the version was successfully deleted209ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage versions0never seen
404Returned if the version does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (any project where the version is available)
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*533ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
422Unprocessable Entity3286ms
401Unauthorized692ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
167138{
267138 "type": "integer"
367138}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK5238ms
404Returned if the version does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (any project where the version is available)
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*644ms
400Occurs when the client did not send a valid JSON object in the request body.603ms
403Returned if the client does not have sufficient permissions.
**Required permission:** Manage versions in the version's project.0never seen
404Returned if the version does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (any project where the version is available)
*Note: A client without sufficient permissions shall not be able to test for the existence of
a version. That's why a 404 is returned here, even if a 403 might be more appropriate.*305ms
406Occurs when the client did not send a Content-Type header413ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* a constraint for a property was violated (`PropertyConstraintViolation`)2156ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
172923{
272923 "type": "integer"
372923}
Responses3 of 5 documented received
codedescriptionhitsavg
200OK0never seen
400Occurs when the client did not send a valid JSON object in the request body.222ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage versions in the version's project0never seen
406Occurs when the client did not send a Content-Type header5973ms
415Occurs when the client sends an unsupported Content-Type header.13ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1323ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1573208{
2573208 "type": "integer"
3573208}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK1687ms
404Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages **or** manage versions (on given workspace)
*Note: A client without sufficient permissions shall not be able to test for the existence of a workspace.
That's why a 404 is returned here, even if a 403 might be more appropriate.*4234ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1163ms
500Internal Server Error574ms
403Forbidden175ms
Views3 operations3 covered0 partial0 uncovered0 not measured100%#
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
1197n/a{
2197n/a "type": "string"
3197n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
200OK5198ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1583ms
500Internal Server Error323ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1597131{
2597131 "type": "integer"
3597131}
Responses1 of 4 documented received
codedescriptionhitsavg
200Returns the result of a single view, dependent of the view type.0never seen
400Occurs when the client did not send a valid JSON object in the request body.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** The required permission depends on the type of the view.0never seen
404Returned if the resource can not be found.
*Note: A client without sufficient permissions shall not be able to test for the existence of
a view. That's why a 404 is returned here, even if a 403 might be more appropriate.*6394ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized893ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
12091n/a{
22091n/a "type": "string"
32091n/a}
Body8 of 8 keywords covered
application/json8 / 8
11474297{
2728154 "properties": {
3728154 "_links": {
4355108 "properties": {
5355108 "query": {
619564 "properties": {
719564 "href": {
819545 "format": "uri",
924019 "type": "string"
1019564 }
1119564 },
1241944 "type": "object"
13355108 }
14355108 },
1583646 "type": "object"
16728154 }
17728154 },
181628143 "type": "object"
191474297}
Responses3 of 5 documented received
codedescriptionhitsavg
201Created0never seen
400Occurs when the client did not send a valid JSON object in the request body.732ms
406Occurs when the client did not send a Content-Type header2253ms
415Occurs when the client sends an unsupported Content-Type header.24ms
422Returned if:
* the client tries to modify a read-only property (`PropertyIsReadOnly`)
* a constraint for a property was violated (`PropertyConstraintViolation`)
* the client provides a link to an invalid resource (`ResourceTypeMismatch`),
e.g. a query not found0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1553ms
404Not Found16363ms
Wiki Pages1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
165152{
265152 "type": "integer"
365152}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK139ms
404Returned if the wiki page does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view wiki page in the page's project5964ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1063ms
Work Packages31 operations23 covered8 partial0 uncovered0 not measured79%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175138{
275138 "type": "integer"
375138}
Responses3 of 3 documented received
codedescriptionhitsavg
200OK5107ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*34ms
404Returned if the project does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view project1434ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1213ms
500Internal Server Error124ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
176629{
276629 "type": "integer"
376629}
Query Parameters7 of 7 keywords covered
offset1 / 1
122946{
222946 "type": "integer"
322946}
pageSize1 / 1
116449{
216449 "type": "integer"
316449}
filters1 / 1
1218n/a{
2218n/a "type": "string"
3218n/a}
sortBy1 / 1
1184n/a{
2184n/a "type": "string"
3184n/a}
groupBy1 / 1
1213n/a{
2213n/a "type": "string"
3213n/a}
showSums1 / 1
117922{
217922 "type": "boolean"
317922}
select1 / 1
1265n/a{
2265n/a "type": "string"
3265n/a}
Responses4 of 4 documented received
codedescriptionhitsavg
200OK37217ms
400Occurs when the client did not send a valid JSON object in the request body.988ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*104ms
404Returned if the project does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view project1654ms
400Occurs when the client did not send a valid JSON object in the request body.1895ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*0never seen
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permissions:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*375ms
406Occurs when the client did not send a Content-Type header3183ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if:
* the client tries to write a read-only property
* a constraint for a property was violated
* a property was provided in an unreadable format7737ms
400Occurs when the client did not send a valid JSON object in the request body.1654ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*0never seen
404Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permissions:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*0never seen
406Occurs when the client did not send a Content-Type header2263ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if:
* the client tries to write a read-only property
* a constraint for a property was violated
* a property was provided in an unreadable format5466ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Query Parameters1 of 1 keywords covered
filters1 / 1
#validinvalidschema
1716n/a{
2716n/a "type": "string"
3716n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK5413ms
400Occurs when the client did not send a valid JSON object in the request body.17ms
403Returned if the client does not have sufficient permissions.
**Required permission:** View work packages in any project.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4093ms
500Internal Server Error2535ms
Path Parameters1 of 1 keywords covered
identifier1 / 1
#validinvalidschema
1726n/a{
2726n/a "type": "string"
3726n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK18615ms
404Returned if the schema does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages (on the project where this schema is used)
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That's why a 404 is returned here, even if a 403 might be more appropriate.*3443ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1943ms
500Internal Server Error212ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
125898{
225898 "type": "integer"
325898}
Responses2 of 5 documented received
codedescriptionhitsavg
204Returned if the work package was deleted successfully.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned along with an appropriate HTTP status.1176ms
403Returned if the client does not have sufficient permissions.
**Required permission:** delete work package0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package2834ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized622ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164481{
264481 "type": "integer"
364481}
Query Parameters1 of 1 keywords covered
timestamps1 / 1
1197n/a{
2197n/a "type": "string"
3197n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200OK0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package6424ms
400Occurs when the client did not send a valid JSON object in the request body.303ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work package, assign version, change work package status, manage subtasks or move work package0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package9314ms
406Occurs when the client did not send a Content-Type header1973ms
409Returned if the resource was changed since the client requested it. This is determined using the `lockVersion` property.9920ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
- the client tries to modify a read-only property (`PropertyIsReadOnly`)
- a constraint for a property was violated (`PropertyConstraintViolation`)
- the client provides a link to an invalid resource (`ResourceTypeMismatch`)57ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Query
truenotify
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1557155{
2557155 "type": "integer"
3557155}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK5312ms
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package5994ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized603ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
163968{
263968 "type": "integer"
363968}
Query Parameters1 of 1 keywords covered
notify1 / 1
126145{
226145 "type": "boolean"
326145}
Body6 of 6 keywords covered
application/json6 / 6
ActivityCommentWriteModel
134839{
223133 "properties": {
321928 "comment": {
41587 "properties": {
51587 "raw": {
61587 "type": "string"
71587 }
81587 },
922621 "type": "object"
1021928 },
1111818 "internal": {
1211818 "type": "boolean"
1311818 }
1423133 },
153816 "type": "object"
1634839}
Responses3 of 4 documented received
codedescriptionhitsavg
201Created159ms
400Occurs when the client did not send a valid JSON object in the request body.4742ms
403Returned 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.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package2224ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized73ms
41511ms
40624ms
Examples3 / 3 used
Body: application/json
{
"comment": {
"raw": "I think this is awesome!"
}
}ActivityCommentWriteModel
falseActivityCommentWriteModel.internal
Query
truenotify
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160579{
260579 "type": "integer"
360579}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK10412ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages4794ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1012ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
157096{
257096 "type": "integer"
357096}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK9414ms
403Returned if the client does not have sufficient permissions.
**Required permission:** edit work package
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package4974ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized753ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160165{
260165 "type": "integer"
360165}
Query Parameters5 of 5 keywords covered
pageSize1 / 1
117277{
217277 "type": "integer"
317277}
filters1 / 1
1182n/a{
2182n/a "type": "string"
3182n/a}
query1 / 1
1230n/a{
2230n/a "type": "string"
3230n/a}
type1 / 1
1176n/a{
2176n/a "type": "string"
3176n/a}
sortBy1 / 1
1186n/a{
2186n/a "type": "string"
3186n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK7244ms
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package4454ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request744ms
401Unauthorized663ms
500Internal Server Error96ms
Examples1 / 1 used
Query
"[[\"id\", \"asc\"]]"sortBy
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160884{
260884 "type": "integer"
360884}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK11110ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add work package watchers
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package4744ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1073ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160863{
260863 "type": "integer"
360863}
Query Parameters1 of 1 keywords covered
filters1 / 1
1172n/a{
2172n/a "type": "string"
3172n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK1925ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view file links
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package3594ms
400Occurs when the client did not send a valid JSON object in the request body.423ms
403Returned if the client does not have sufficient permissions.
**Required permission:** manage file links
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links5234ms
406Occurs when the client did not send a Content-Type header2063ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Occurs if the request body was correctly formatted, but some properties lead to errors in the validation
process. This happens e.g. if the provided storage url is not available on the server.414ms
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package10834ms
415Occurs when the client sends an unsupported Content-Type header.23ms
{
"format": "markdown",
"html": "I am formatted!",
"raw": "I am formatted!"
}Formattable
"I **am** formatted!"Formattable.raw
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
163382{
263382 "type": "integer"
363382}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK2317ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work packages for the project the work package is contained in.
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package3824ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1022ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164574{
264574 "type": "integer"
364574}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK2986ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work package watchers
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
*Note that you will effectively not be able to see the watchers of a work package without being able to see the work package.*3204ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1013ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
166058{
266058 "type": "integer"
366058}
Body5 of 5 keywords covered
application/json5 / 5
146047{
224820 "properties": {
324820 "user": {
420311 "properties": {
520311 "href": {
620311 "type": "string"
720311 }
820311 },
92599 "type": "object"
1024820 }
1124820 },
1248027 "type": "object"
1346047}
Responses5 of 8 documented received
codedescriptionhitsavg
200OK0never seen
201Created125ms
400Occurs when the client did not send a valid JSON object in the request body.
For example:
* The request did not contain a single JSON object
* The JSON object did not contain the key `user`
* The value of `users` was not a link object393ms
403Returned if the client does not have sufficient permissions.
**Required permissions:**
* view work package (for self)
* add work package watchers (for other users)
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
*Note that you will effectively not be able to change the watchers of a work package without being able to see the work package.*4614ms
406Occurs when the client did not send a Content-Type header1633ms
415Occurs when the client sends an unsupported Content-Type header.22ms
422Returned if:
* the client tries to specify a link to a resource that is not a user (`ResourceTypeMismatch`)
* the user specified is not allowed to watch that work package (`PropertyConstraintViolation`)
* the user specified does not exist (`PropertyConstraintViolation`)0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized523ms
Examples1 / 1 used
Body: application/json
{
"user": {
"href": "/api/v3/users/1"
}
}example
Path Parameters2 of 2 keywords covered
id1 / 1
#validinvalidschema
1475103{
2475103 "type": "integer"
3475103}
user_id1 / 1
1467111{
2467111 "type": "integer"
3467111}
Responses2 of 5 documented received
codedescriptionhitsavg
204No Content64ms
403Returned if the client does not have sufficient permissions.
**Required permission:** delete work package watchers
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*0never seen
404Returned in one of the following cases:
Either the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
Or the specified user does not exist at all.
*Note that you will effectively not be able to change the watchers of a work package without being able to see the work package.*5064ms
406Occurs when the client did not send a Content-Type header0never seen
415Occurs when the client sends an unsupported Content-Type header.0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized663ms
Path Parameters1 of 1 keywords covered
work_package_id1 / 1
#validinvalidschema
164868{
264868 "type": "integer"
364868}
Responses2 of 3 documented received
codedescriptionhitsavg
200OK2886ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work packages for the project the work package is contained in.0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package3114ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1172ms
Path Parameters1 of 1 keywords covered
work_package_id1 / 1
#validinvalidschema
11858188{
21858188 "type": "integer"
31858188}
Body6 of 6 keywords covered
application/json6 / 6
1157373{
2158040 "properties": {
380716 "note": {
480716 "type": "string"
580716 },
6158033 "remindAt": {
7158025 "format": "date-time",
816058 "type": "string"
9158033 }
10158040 },
11161320 "required": [
12161320 "remindAt"
13161320 ],
14163313 "type": "object"
15157373}
Responses1 of 3 documented received
codedescriptionhitsavg
201Reminder created successfully0never seen
404Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package15714ms
409Returned if the user already has an active reminder for this work package.
**Error message**: You can only set one reminder at a time for a work package. Please delete or update the existing reminder.0never seen
Undocumented - not in spec
codedescriptionhitsavg
422Unprocessable Entity59ms
40613ms
401Unauthorized753ms
41522ms
400Bad Request3922ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1615208{
2615208 "type": "integer"
3615208}
Responses3 of 3 documented received
codedescriptionhitsavg
200OK926ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding workspace.*44ms
404Returned if the workspace does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view workspace5704ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized903ms
500Internal Server Error674ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1653147{
2653147 "type": "integer"
3653147}
Query Parameters7 of 7 keywords covered
offset1 / 1
123856{
223856 "type": "integer"
323856}
pageSize1 / 1
121791{
221791 "type": "integer"
321791}
filters1 / 1
1250n/a{
2250n/a "type": "string"
3250n/a}
sortBy1 / 1
1217n/a{
2217n/a "type": "string"
3217n/a}
groupBy1 / 1
1242n/a{
2242n/a "type": "string"
3242n/a}
showSums1 / 1
122463{
222463 "type": "boolean"
322463}
select1 / 1
1245n/a{
2245n/a "type": "string"
3245n/a}
Responses4 of 4 documented received
codedescriptionhitsavg
200OK16216ms
400Occurs when the client did not send a valid JSON object in the request body.638ms
403Returned if the client does not have sufficient permissions.
**Required permission:** view work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding workspace.*164ms
404Returned if the workspace does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view workspace4944ms
400Occurs when the client did not send a valid JSON object in the request body.753ms
403Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding workspace.*0never seen
404Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permissions:** view workspace
*Note: A client without sufficient permissions shall not be able to test for the existence of a workspace.
That's why a 404 is returned here, even if a 403 might be more appropriate.*14245ms
406Occurs when the client did not send a Content-Type header3434ms
415Occurs when the client sends an unsupported Content-Type header.0never seen
422Returned if:
* the client tries to write a read-only property
* a constraint for a property was violated
* a property was provided in an unreadable format156ms
400Occurs when the client did not send a valid JSON object in the request body.0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6553ms
401Unauthorized832ms
WorkPackages1 operation1 covered0 partial0 uncovered0 not measured100%#
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
162386{
262386 "type": "integer"
362386}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK1356ms
404Returned if the work package does not exist or the client does not have sufficient permissions
to see it.
**Required permission:**
- `view_work_packages`
- for internal comments: `view_internal_comments`
*Note: A client without sufficient permissions shall not be able to test for the existence of a work package.
That's why a 404 is returned here, even if a 403 might be more appropriate.*4694ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1052ms
Workspace1 operation1 covered0 partial0 uncovered0 not measured100%#
Query Parameters3 of 3 keywords covered
filters1 / 1
#validinvalidschema
1210n/a{
2210n/a "type": "string"
3210n/a}
sortBy1 / 1
1168n/a{
2168n/a "type": "string"
3168n/a}
select1 / 1
1189n/a{
2189n/a "type": "string"
3189n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200OK46813ms
400Returned if the client sends invalid request parameters e.g. filters64ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1203ms
500Internal Server Error814ms
Workspaces3 operations3 covered0 partial0 uncovered0 not measured100%#
Responses1 of 1 documented received
codedescriptionhitsavg
200OK14206ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized6702ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1339302{
2339302 "type": "integer"
3339302}
Responses2 of 3 documented received
codedescriptionhitsavg
204Returned if the workspace was successfully removed from favorites.194ms
403Returned if the client does not have sufficient permissions.
**Required permission:** logged in0never seen
404Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view workspace3844ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2253ms
500Internal Server Error134ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1704128{
2704128 "type": "integer"
3704128}
Responses0 of 3 documented received
codedescriptionhitsavg
204Returned if the workspace was successfully added to favorites.0never seen
403Returned if the client does not have sufficient permissions.
**Required permission:** logged in0never seen
404Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view workspace0never seen
Undocumented - not in spec
codedescriptionhitsavg
4067333ms
401Unauthorized982ms
41514ms
1000 unmatched requestsNot counted in coverage above
Method
Host
Path
Reason
Count
DELETE
0.0.0.0:34919
/api/v3
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/actions
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/actions/{id}
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/activities/{id}
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/activities/{id}/attachments
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/activities/{id}/attachments/prepare
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/activities/{id}/emoji_reactions
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/attachments
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/attachments/prepare
method not documented
1
DELETE
0.0.0.0:34919
/api/v3/attachments/{id}/uploaded
method not documented
1
... and 990 more groups
82 further requests not tracked (1000 distinct groups max).