TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
57811 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 858b66b787
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '858b66b787'
${ noResults }
openproject/docs/api
History
ulferts 9d639ea48a
rephrasing 		4 years ago
..
api_documentation_layouts
…
apiv3 rephrasing 4 years ago
bcf
…
README.md
…
apiv3-doc-dev.apib
…
apiv3-doc-stable.apib
…

README.md

OpenProject API

OpenProject offers two APIs. The general purpose HATEOAS API v3 and the BCF API v2.1 api targeted towards BIM use cases.

Please note that we intend to keep this specification as accurate and stable as possible, however work on the API is still ongoing and not all resources and actions in OpenProject are yet accessible through the API.

This document will be subject to changes as we add more endpoints and functionality to the API. The development version of this document may have breaking changes while we work on new endpoints for the application.

We try to keep stable releases of OpenProject with changes to this API backwards compatible whenever possible.

API v3

The API v3 is a general purpose API supporting multiple use cases.

While by no means complete, a whole lot of different scenarios can be automatised which otherwise would have to be caried out by hand via the UI. Examples for this include managing work packages, projects and users.

BCF v2.1

This API supports BCF management in the context of BIM projects.

While this API supports way less use cases than the more generic API v3 it is compatible with the generic specification of a BCF API as defined by the standard. This, clients implementing the specification can manage topics and viewpoints.