OpenProject Views API
A View is a representation of some information. That information might be a query (currently it always is).The view will store the configuration on how to display the information but not the information itself.A View might then be a graph, a table, a gantt chart or something completely different.The client will have to choose how to represenent in the view. A View instance will always be of a subtype of `Views`, e.g. `Views::WorkPackageslist`. The properties between each `Views` type might differ a lot.**The View is a new concept so it is prone to change.**Currently a lot of restrictions still apply: * There will always be a query associated to the view when in the complete concept, this limitation should not be necessary. * A query can only have one view associated. * There is neither an update nor a delete endpoint and the schema and form endpoints are also missing. To delete a view, simply delete the query. * Most of the properties are deduced from the associated query and can thus only be updated via updating the query. * The properties are not different between `Views` subtypes.## Linked Properties| Link | Description | Type | Constraints | Supported operations || :-------------------: | ---------------------------------------- | ------------- | -------- | -------------------- || self | This view | View (a subtype of it) | not null | READ || query | This query from which to fetch the data | Query | not null | READ/WRITE || project | This project the view is defined in (deduces from the query). If no project is specified, the View is considered global. | Project | Deduced from the query | READ |## Local Properties| Property | Description | Type | Constraints | Supported operations|| :--------------: | ------------------------------------------------------| ----------- | ------------------------------------ | --------------------|| _type | The subtype chosen | String | | READ || id | View id | Integer | x > 0 | READ || name | View name | String | Deduced from the query | READ || public | Can users besides the owner see the view? | Boolean | Deduced from the query | READ || starred | Should the view be highlighted to the user? | Boolean | Deduced from the query | READ || createdAt | Time of creation | DateTime | not null | READ || updatedAt | Time of the most recent change to the view | DateTime | not null | READ |
OpenProject Views API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Views. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.2, at version 3.
Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
OpenProject Views API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
A View is a representation of some information. That information might be a query (currently it always is). The view will store the configuration on how to display the information…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenProject 12
Other APIs OpenProject publishes across the network.
This is an independent, third-party profile of OpenProject Views API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.