OpenProject is the leading open source project management software.
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.
openproject/docs/api/apiv3/paths/statuses.yml

105 lines
3.2 KiB

# /api/v3/statuses
---
get:
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
self:
href: "/api/v3/statuses/1"
_type: Status
defaultDoneRatio: 0
id: 1
isClosed: false
isDefault: true
name: New
position: 1
- _links:
self:
href: "/api/v3/statuses/3"
_type: Status
defaultDoneRatio: 75
id: 3
isClosed: false
isDefault: false
isReadonly: false
name: Resolved
position: 3
- _links:
self:
href: "/api/v3/statuses/4"
_type: Status
defaultDoneRatio: 25
id: 4
isClosed: false
isDefault: false
name: Feedback
position: 4
- _links:
self:
href: "/api/v3/statuses/5"
_type: Status
defaultDoneRatio: 100
id: 5
isClosed: true
isDefault: false
name: Closed
position: 5
- _links:
self:
href: "/api/v3/statuses/6"
_type: Status
defaultDoneRatio: 100
id: 6
isClosed: true
isDefault: false
name: Rejected
position: 6
- _links:
self:
href: "/api/v3/statuses/2"
_type: Status
defaultDoneRatio: 50
id: 2
isClosed: false
isDefault: false
name: In Progress
position: 3
_links:
self:
href: "/api/v3/statuses"
_type: Collection
count: 6
total: 6
schema:
"$ref": "../components/schemas/statuses_model.yml"
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: "../components/schemas/error_response.yml"
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the statuses.
description: |-
Returned if the client does not have sufficient permissions.
**Required permission:** view work package (on any project)
headers: {}
tags:
- Statuses
description: ''
operationId: List_all_Statuses
summary: List all Statuses