kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
2.7 KiB
90 lines
2.7 KiB
3 years ago
|
# /api/v3/projects/{id}/budgets
|
||
|
|
---
|
||
|
|
get:
|
||
|
|
parameters:
|
||
|
|
- description: Project id
|
||
|
|
example: '1'
|
||
|
|
in: path
|
||
|
|
name: id
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: integer
|
||
|
|
responses:
|
||
|
|
'200':
|
||
|
|
content:
|
||
|
|
application/hal+json:
|
||
|
|
examples:
|
||
|
|
response:
|
||
|
|
value:
|
||
|
|
_embedded:
|
||
|
|
elements:
|
||
|
|
- _links:
|
||
|
|
self:
|
||
|
|
href: "/api/v3/budgets/1"
|
||
|
|
title: Q3 2015
|
||
|
|
_type: Budget
|
||
|
|
id: 1
|
||
|
|
subject: Q3 2015
|
||
|
|
- _links:
|
||
|
|
self:
|
||
|
|
href: "/api/v3/budgets/2"
|
||
|
|
title: Q4 2015
|
||
|
|
_type: Budget
|
||
|
|
id: 2
|
||
|
|
subject: Q4 2015
|
||
|
|
_links:
|
||
|
|
self:
|
||
|
|
href: "/api/v3/projects/1/budgets"
|
||
|
|
_type: Collection
|
||
|
|
count: 2
|
||
|
|
total: 2
|
||
|
|
schema:
|
||
|
|
"$ref": "../components/schemas/budgets_by_project_model.yml"
|
||
|
|
description: OK
|
||
|
|
headers: {}
|
||
|
|
'403':
|
||
|
|
content:
|
||
|
|
application/hal+json:
|
||
|
|
examples:
|
||
|
|
response:
|
||
|
|
value:
|
||
|
|
_type: Error
|
||
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
|
||
|
|
message: You are not allowed to see the budgets of this project.
|
||
|
|
description: |-
|
||
|
|
Returned 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.*
|
||
|
|
headers: {}
|
||
|
|
'404':
|
||
|
|
content:
|
||
|
|
application/hal+json:
|
||
|
|
examples:
|
||
|
|
response:
|
||
|
|
value:
|
||
|
|
_type: Error
|
||
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
|
||
|
|
message: The specified project does not exist.
|
||
|
|
description: |-
|
||
|
|
Returned 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.*
|
||
|
|
headers: {}
|
||
|
|
tags:
|
||
|
|
- Budgets
|
||
|
|
description: ''
|
||
|
|
operationId: view_Budgets_of_a_Project
|
||
|
|
summary: view Budgets of a Project
|