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.
95 lines
3.1 KiB
95 lines
3.1 KiB
# /api/v3/views/{identifier}
|
|
---
|
|
|
|
post:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
'Views::WorkPackagesTable':
|
|
value:
|
|
_links:
|
|
query:
|
|
href: /api/v3/queries/5
|
|
'Views::TeamPlanner':
|
|
value:
|
|
_links:
|
|
query:
|
|
href: /api/v3/queries/5
|
|
schema:
|
|
type: object
|
|
properties:
|
|
_links:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: object
|
|
properties:
|
|
href:
|
|
type: href
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
'Views::WorkPackagesTable':
|
|
"$ref": "../components/examples/view_work_packages_table.yml"
|
|
'Views::TeamPlanner':
|
|
"$ref": "../components/examples/view_team_planner.yml"
|
|
description: Created
|
|
headers: {}
|
|
'400':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
|
|
message: The request body was not a single JSON object.
|
|
description: Occurs when the client did not send a valid JSON object in the
|
|
request body.
|
|
headers: {}
|
|
'422':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
response:
|
|
value:
|
|
_embedded:
|
|
details:
|
|
attribute: query
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
|
|
message: "Query does not exist."
|
|
description: |-
|
|
Returned 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 found
|
|
headers: {}
|
|
tags:
|
|
- Views
|
|
description: |-
|
|
When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.
|
|
The required fields of a View can be found in its schema, which is embedded in the respective form.
|
|
Note that it is only allowed to provide properties or links supporting the write operation.
|
|
|
|
There are different subtypes of `Views` (e.g. `Views::WorkPackagesTable`) with each having its own
|
|
endpoint for creating that subtype e.g.
|
|
|
|
* `/api/v3/views/work_packages_table` for `Views::WorkPackagesTable`
|
|
* `/api/v3/views/team_planner` for `Views::TeamPlanner`
|
|
* `/api/v3/views/work_packages_calendar` for `Views::WorkPackagesCalendar`
|
|
|
|
**Not yet implemented** To get the list of available subtypes and by that the endpoints for creating a subtype, use the
|
|
```
|
|
/api/v3/views/schemas
|
|
```
|
|
endpoint.
|
|
operationId: Create_views
|
|
summary: Create view
|
|
|