OpenProject Relations API
Work packages may be related to each other in different ways.```+--------------+ +--------------+| | 1 1 | || Work package +-------------+--------------+ Work package || | from | to | |+--------------+ | +--------------+ +------+-------+ | Relation | +--------------+ | type | | reverseType | | description | | lag | +--------------+```## Actions| Link | Description | Condition ||:-------------------:| -------------------------------------------------------------------- | --------------------------------------------- || update | Updates the relation between two work packages via a form | **Permission**: manage work package relations || updateImmediately | Updates the relation between two work packages | **Permission**: manage work package relations || delete | Destroys the relation between the two work packages | **Permission**: manage work package relations |## Linked Properties| Link | Description | Type | Constraints | Supported operations | Condition ||:-------------:|-------------------------------------- | ------------- | ----------- | -------------------- | --------------------------------------------- || self | This relation | Relation | not null | READ | **Permission**: view work packages || schema | The schema of this relation | Schema | not null | READ | || from | The emanating work package | WorkPackage | not null | READ | **Permission**: view work packages || to | The work package the relation ends in | WorkPackage | not null | READ | **Permission**: view work packages |## Local Properties| Property | Description | Type | Constraints | Supported operations || :---------------:| ------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------- | -------------------- || id | Relation ID | Integer | x > 0 | READ || name | The internationalized name of this kind of relation | String | | READ| type | Which kind of relation (blocks, precedes, etc.) | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ / WRITE || reverseType | The kind of relation from the other WP's perspective | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ || description | Short text further describing the relation | String | | READ / WRITE || lag* | The number of days between closing of `from` and start of `to`| Integer | x >= 0 | READ / WRITE |\* Only applicable for some relation types such as "follows". You can check using the relation by schemaendpoint at `/api/v3/relations/schema/{type}`.
OpenProject Relations API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Relations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 3 paths, and defines 10 schemas. 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 Relations API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Work packages may be related to each other in different ways. +--------------+ +--------------+ | | 1 1 | | | Work package +-------------+--------------+ Work package | | | from |…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are RelationReadModel (9 properties), Link (7 properties), RelationWriteModel (4 properties), 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 Relations 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.