Root
The root resource contains links to available resources in the API. By following these links a client should be able to discover further resources in the API.
Note: Currently there is no list action for projects available. A client will therefore have to know links to projects and can’t (yet) discover them.
Link | Description | Type | Nullable | Supported operations | Condition |
---|---|---|---|---|---|
configuration | The configuration of this OpenProject instance | Configuration | READ | ||
user | The user currently logged-in | User | READ | logged in | |
userPreferences | The preferences of the logged-in user | UserPreference | READ | logged in | |
priorities | List of available priorities | Collection | READ | Permission View work packages in any project | |
statuses | List of available work package statuses | Collection | READ | Permission View work packages in any project | |
types | List of available work package types | Collection | READ | Permission View work packages in any project | |
workPackages | List of all work packages | Collection | READ | Permission View work packages in any project | |
users | List of all users | Collection | READ | Permission Administrator |
Local Properties
Property | Description | Type | Condition | Supported operations |
---|---|---|---|---|
instanceName | The name of the OpenProject instance | String | READ | |
coreVersion | The OpenProject core version number for the instance | String | Permission requires admin privileges | READ |
Root
View root
- Response
200
Toggle details Headers
Content-Type: application/hal+json
Body
{ "_links" : { "configuration" : { "href" : "/api/v3/configuration" }, "user": { "href": "/api/v3/users/1", "title": "John Sheppard" }; "userPreferences" : { "href" : "/api/v3/my_preferences" }, "priorities" : { "href" : "/api/v3/priorities" }, "relations" : { "href" : "/api/v3/relations" }, "statuses" : { "href" : "/api/v3/statuses" }, "types" : { "href" : "/api/v3/types" }, "workPackages" : { "href" : "/api/v3/work_packages" }, "users": { "href" : "/api/v3/users" } }, "instanceName" : "My own OpenProject", "coreVersion" : "10.3.0" }
Help and feedback
If you did not find what you were looking for
If you need help from the community or want to support others
If you are eligible for professional support and have more questions
REQUEST SUPPORT
If you find an easily fixable error or need for improvement in the documentation for the stable release
If you would like to suggest bigger updates or improvements to this documentation
If you want to contribute to translate this documentation to another language
If there's something you don't like or understand about this feature
If you want to propose a new feature that OpenProject does not offer yet
To further help OpenProject to shape and test new features
To view OpenProject premium features and pricing
If you want to try all premium features in the OpenProject Cloud Edition 14 days for free
If you want to try all premium features in your on premise Community installation 14 days for free