openapi: 3.1.2
info:
description: "You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current\ndevelopment version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3).\n\n## Introduction\n\nThe documentation for the APIv3 is written according to the [OpenAPI 3.1 Specification](https://swagger.io/specification/).\nYou can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/)\nor the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md),\nin your OpenProject installation under `/api/docs`.\nIn the latter you can try out the various API endpoints directly interacting with our OpenProject data.\nMoreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml`\n(e.g. [here](https://community.openproject.org/api/v3/spec.yml)).\n\nThe APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS).\nThis means that each endpoint of this API will have links to other resources or actions defined in the resulting body.\n\nThese related resources and actions for any given resource will be context sensitive. For example, only actions that the\nauthenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any\ngiven response.\n\nAs an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only\nbe present when the user you authenticated has been granted a permission to update the work package in the assigned project.\n\n## HAL+JSON\n\nHAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.\nRead more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08)\n\n**OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties:\n\n- `_type` - specifies the type of the resource (e.g.: WorkPackage, Project)\n- `_links` - contains all related resource and action links available for the resource\n- `_embedded` - contains all embedded objects\n\nHAL does not guarantee that embedded resources are embedded in their full representation, they might as well be\npartially represented (e.g. some properties can be left out).\nHowever in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**.\n\n## API response structure\n\nAll API responses contain a single HAL+JSON object, even collections of objects are technically represented by\na single HAL+JSON object that itself contains its members. More details on collections can be found\nin the [Collections Section](https://www.openproject.org/docs/api/collections/).\n\n## Authentication\n\nThe API supports the following authentication schemes:\n\n* Session-based authentication\n* API tokens\n * passed as Bearer token\n * passed via Basic auth\n* OAuth 2.0\n * using built-in authorization server\n * using an external authorization server (RFC 9068)\n\nDepending on the settings of the OpenProject instance many resources can be accessed without being authenticated.\nIn case the instance requires authentication on all requests the client will receive an **HTTP 401** status code\nin response to any request.\n\nOtherwise unauthenticated clients have all the permissions of the anonymous user.\n\n### Session-based authentication\n\nThis means you have to login to OpenProject via the Web-Interface to be authenticated in the API.\nThis method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.\n\nIn this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication.\n\n### API token as bearer token\n\nUsers can authenticate towards the API v3 using an API token as a bearer token.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -H \"Authorization: Bearer $API_KEY\" https://community.openproject.org/api/v3/users/42\n```\n\nUsers can generate API tokens on their account page.\n\n### API token through Basic Auth\n\nAPI tokens can also be used with basic auth, using the user name `apikey` (NOT your login) and the API token as the password.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42\n```\n\n### OAuth 2.0 authentication\n\nOpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes.\n\nTo get started, you first need to register an application in the OpenProject OAuth administration section of your installation.\nThis will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`).\n\nYou can then use one the following guides to perform the supported OAuth 2.0 flows:\n\n- [Authorization code flow](https://oauth.net/2/grant-types/authorization-code)\n\n- [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential\n\n- [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access\n\n### OAuth 2.0 using an external authorization server\n\nThere is a possibility to use JSON Web Tokens (JWT) generated by an OIDC provider configured in OpenProject as a bearer token to do authenticated requests against the API.\nThe following requirements must be met:\n\n- OIDC provider must be configured in OpenProject with **jwks_uri**\n- JWT must be signed using RSA algorithm\n- JWT **iss** claim must be equal to OIDC provider **issuer**\n- JWT **aud** claim must contain the OpenProject **client ID** used at the OIDC provider\n- JWT **scope** claim must include a valid scope to access the desired API (e.g. `api_v3` for APIv3)\n- JWT must be actual (neither expired or too early to be used)\n- JWT must be passed in Authorization header like: `Authorization: Bearer {jwt}`\n- User from **sub** claim must be linked to OpenProject before (e.g. by logging in), otherwise it will be not authenticated\n\nIn more general terms, OpenProject should be compliant to [RFC 9068](https://www.rfc-editor.org/rfc/rfc9068) when validating access tokens.\n\n### Why not username and password?\n\nThe simplest way to do basic auth would be to use a user's username and password naturally.\nHowever, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.\n\nUsing **username and password** directly would have some advantages:\n\n* It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.\n\n* No extra logic for token management necessary.\n\nOn the other hand using **API keys** has some advantages too, which is why we went for that:\n\n* If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.\n\n* They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.\n\nMost importantly users may not actually have a password to begin with. Specifically when they have registered\nthrough an OpenID Connect provider.\n\n## Cross-Origin Resource Sharing (CORS)\n\nBy default, the OpenProject API is _not_ responding with any CORS headers.\nIf you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.\n\nPlease see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on\nhow to selectively enable CORS.\n\n## Allowed HTTP methods\n\n- `GET` - Get a single resource or collection of resources\n\n- `POST` - Create a new resource or perform\n\n- `PATCH` - Update a resource\n\n- `DELETE` - Delete a resource\n\n## Compression\n\nResponses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951)\nare supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).\nIf no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed."
title: OpenProject API V3 (Stable) Actions & Capabilities Work Packages API
version: '3'
servers:
- url: https://qa.openproject-edge.com
description: Edge QA instance
- url: https://qa.openproject-stage.com
description: Staging instance
- url: https://community.openproject.org
description: Community instance
security:
- BasicAuth: []
tags:
- description: 'The work packages endpoints return collections or single entities of type `WorkPackage`. The following tables list the different properties
of `WorkPackage` entities.
## Actions
| Link | Description | Condition |
|:-------------------:|--------------------------------------------------------------------------| ---------------------------------------|
| addAttachment | Attach a file to the WP | **Permission**: edit work package |
| addComment | Post comment to WP | **Permission**: add work package notes |
| addRelation | Adds a relation to this work package. | **Permission**: manage wp relations |
| addWatcher | Add any user to WP watchers | **Permission**: add watcher |
| customActions | Collection of predefined changes that can be applied to the work package | |
| logTime | Log time on the work package | **Permission**: Log time, Log own time |
| previewMarkup | Post markup (in markdown) here to receive an HTML-rendered response | |
| removeWatcher | Remove any user from WP watchers | **Permission**: delete watcher |
| unwatch | Remove current user from WP watchers | logged in; watching |
| update | Form endpoint that aids in preparing and performing edits on a WP | **Permission**: edit work package |
| updateImmediately | Directly perform edits on a work package | **Permission**: edit work package |
| watch | Add current user to WP watchers | logged in; not watching |
| delete | Delete this work package | **Permission**: delete work package |
## Linked Properties
| Link | Description | Type | Constraints | Supported operations | Condition |
| :--------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------- | --------------------- | ----------------------------------------- |
| self | This work package | WorkPackage | not null | READ | |
| schema | The schema of this work package | Schema | not null | READ | |
| ancestors | Array of all visible ancestors of the work package, with the root node being the first element | Collection | not null | READ | **Permission** view work packages |
| attachments | The files attached to this work package | Collection | not null | READ / WRITE | |
| author | The person that created the work package | User | not null | READ | |
| assignee | The person that is intended to work on the work package | User | | READ / WRITE | |
| availableWatchers | All users that can be added to the work package as watchers. | User | | READ | **Permission** add work package watchers |
| budget | The budget this work package is associated to | Budget | | READ / WRITE | **Permission** view cost objects |
| category | The category of the work package | Category | | READ / WRITE | |
| children | Array of all visible children of the work package | Collection | not null | READ | **Permission** view work packages |
| parent | Parent work package | WorkPackage | Needs to be visible (to the current user) | READ / WRITE | |
| priority | The priority of the work package | Priority | not null | READ / WRITE | |
| project | The project to which the work package belongs | Project | not null | READ / WRITE | |
| projectPhase | The project phase this work package is assigned to | ProjectPhase | | READ / WRITE | **Permission** view project phases. There has to be a project phase active in the project. |
| projectPhaseDefinition | The project phase definition for the project phase of this work package. | ProjectPhaseDefinition | | READ | **Permission** view project phases. The associated project phase has to be active. |
| responsible | The person that is responsible for the overall outcome | User | | READ / WRITE | |
| relations | Relations this work package is involved in | Relation | | READ | **Permission** view work packages |
| revisions | Revisions that are referencing the work package | Revision | | READ | **Permission** view changesets |
| status | The current status of the work package | Status | not null | READ / WRITE | |
| sprint | The sprint the work package is planned in | Sprint | | READ / WRITE | **Permission** view sprints |
| subject | The subject of the work package | String | not null; 1 <= length <= 255 | READ / WRITE | |
| timeEntries | All time entries logged on the work package. Please note that this is a link to an HTML resource for now and as such, the link is subject to change. | N/A | | READ | **Permission** view time entries |
| type | The type of the work package | Type | not null | READ / WRITE | |
| version | The version associated to the work package | Version | | READ / WRITE | |
| watchers | All users that are currently watching this work package | Collection | | READ | **Permission** view work package watchers |
## Local Properties
| Property | Description | Type | Constraints | Supported operations | Condition |
| :--------------: | ------------------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------ | -------------------- | -------------------------------- |
| id | Work package id | Integer | x > 0 | READ | |
| lockVersion | The version of the item as used for optimistic locking | Integer | | READ | |
| subject | Work package subject | String | not null; 1 <= length <= 255 | READ / WRITE | Is write protected if the type has automatic subject generation configured. |
| status | Name of the work package''s status | String | not null | READ | |
| type | Name of the work package''s type | String | not null | READ | |
| description | The work package description | Formattable | | READ / WRITE | |
| scheduleManually | Uses manual scheduling mode when true (default). Uses automatic scheduling mode when false. Can be automatic only when predecessors or children are present. | Boolean | | READ / WRITE | |
| startDate | Scheduled beginning of a work package | Date | Cannot be set for parent work packages unless it is scheduled manually; must be equal or greater than the earliest possible start date; Exists only on work packages of a non milestone type | READ / WRITE | |
| dueDate | Scheduled end of a work package | Date | Cannot be set for parent work packages unless it is scheduled manually; must be greater than or equal to the start date; Exists only on work packages of a non milestone type | READ / WRITE | |
| date | Date on which a milestone is achieved | Date | Exists only on work packages of a milestone type | READ / WRITE | |
| derivedStartDate | Similar to start date but is not set by a client but rather deduced by the work packages'' descendants. If manual scheduleManually is active, the two dates can deviate. | Date | | READ | |
| derivedDueDate | Similar to due date but is not set by a client but rather deduced by the work packages'' descendants. If manual scheduleManually is active, the two dates can deviate. | Date | | READ | |
| duration | The amount of time in hours the work package needs to be completed. | Duration | Not available for milestone type of work packages. | READ / WRITE | |
| estimatedTime | Corresponds to work. Time a work package likely needs to be completed. | Duration | | READ / WRITE | |
| derivedEstimatedTime | Corresponds to total work. Time a work package likely needs to be completed including itself and its descendants. | Duration | | READ | |
| remainingTime | Corresponds to remaining work. Remaining time a work package likely needs to be completed. | Duration | | READ / WRITE | |
| derivedRemainingTime | Corresponds to total remaining work. Remaining time a work package likely needs to be completed including itself and its descendants. | Duration | | READ | |
| ignoreNonWorkingDays | When scheduling, whether or not to ignore the non working days being defined. A work package with the flag set to true will be allowed to be scheduled to a non working day. | Boolean | Cannot be set for parent work packages unless it is scheduled manually | READ | |
| position | The rank this work package has in a sprint or product backlog | Integer | | READ | The Backlogs module needs to be active in the project and the work package''s type configured to be used with backlogs. |
| spentTime | The time booked for this work package by users working on it | Duration | | READ | **Permission** view time entries |
| storyPoints | The story points the work package is estimated to take to complete | Integer | | READ / WRITE | The Backlogs module needs to be active in the project and the work package''s type configured to be used with backlogs. |
| percentageDone | Corresponds to % complete. Amount of total completion for a work package. | Integer | 0 <= x <= 100; can be null | READ | |
| derivedPercentageDone | Corresponds to total % complete. Amount of total completion for a work package and its descendants. | Integer | 0 <= x <= 100; can be null | READ | |
| readonly | If true, the work package is in a readonly status so with the exception of the status, no other property can be altered. | Boolean | | READ | Enterprise edition only |
| createdAt | Time of creation | DateTime | | READ | |
| updatedAt | Time of the most recent change to the work package | DateTime | | READ | |
Note that the properties listed here only cover the built-in properties of the OpenProject Core.
Using plug-ins and custom fields a work package might contain various additional properties.
A client can consult the schema information to which the work package links. The schema will contain information about
all properties of the linking work package, including properties added by plug-ins and custom fields.
Custom fields are identified by a key in the form of `customFieldN`, where `N` is an integer. Depending on their type,
they can occur as properties or as linked properties. A client has to consult the schema to resolve
the human readable name of custom fields.
Properties that cannot be set directly on parent work packages are inferred from their children instead:
* `startDate` is the earliest start date from its children if automatic scheduling is activated.
* `dueDate` is the latest finish date from its children if automatic scheduling is activated.
* `derivedEstimatedTime` is the sum of estimated times from its children and the work package''s own estimated time.
* `derivedRemainingTime` is the sum of remaining times from its children and the work package''s own remaining time
* `derivedPercentageDone` is computed by the work package''s derivedEstimatedTime and derivedRemainingTime.
`startDate` can also not be earlier than a finish date of any predecessor.
While attachments are returned as a link whose content is to be fetched separately, clients can choose to
replace the work package''s attachments by providing an array of already uploaded [Attachment resources](https://www.openproject.org/docs/api/endpoints/attachments/)
on [create](https://www.openproject.org/docs/api/endpoints/work-packages/#create-work-package)
and [update](https://www.openproject.org/docs/api/endpoints/work-packages/#update-a-work-package). The attachments the work package has had prior to the request will be removed.'
name: Work Packages
paths:
/api/v3/projects/{id}/work_packages:
get:
summary: Get work packages of project
operationId: Get_Project_Work_Package_Collection
tags:
- Work Packages
description: 'Returns the collection of work packages that are related to the given project.
This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages`](https://www.openproject.org/docs/api/endpoints/work-packages/#get-work-packages-of-workspace)'
parameters:
- description: Project id
example: 1
in: path
name: id
required: true
schema:
type: integer
- description: Page number inside the requested collection.
example: 25
in: query
name: offset
required: false
schema:
default: 1
type: integer
- description: Number of elements to display per page.
example: 25
in: query
name: pageSize
required: false
schema:
type: integer
- description: 'JSON specifying filter conditions.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. If no filter is to be applied, the client should send an empty array (`[]`).'
example: '[{ "type_id": { "operator": "=", "values": [''1'', ''2''] }}]'
in: query
name: filters
required: false
schema:
default: '[{ "status_id": { "operator": "o", "values": null }}]'
type: string
- description: 'JSON specifying sort criteria.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.'
example: '[["status", "asc"]]'
in: query
name: sortBy
required: false
schema:
default: '[["id", "asc"]]'
type: string
- description: The column to group by.
example: status
in: query
name: groupBy
required: false
schema:
type: string
- description: Indicates whether properties should be summed up if they support it.
example: true
in: query
name: showSums
required: false
schema:
default: false
type: boolean
- description: Comma separated list of properties to include.
example: total,elements/subject,elements/id,self
in: query
name: select
required: false
schema:
type: string
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Work_PackagesModel'
description: OK
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the work packages of this project.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: 'Returned if the project does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view project'
post:
summary: Create work package in project
operationId: Create_Project_Work_Package
tags:
- Work Packages
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 WorkPackage 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.
This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages`](https://www.openproject.org/docs/api/endpoints/work-packages/#create-work-package-in-workspace)'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
parameters:
- description: Project id
example: 1
in: path
name: id
required: true
schema:
type: integer
- description: 'Indicates whether change notifications (e.g. via E-Mail) should be sent.
Note that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),
not just the current user.'
example: false
in: query
name: notify
required: false
schema:
default: true
type: boolean
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
description: OK
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to add work packages to this project.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: 'Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permissions:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_embedded:
details:
attribute: Subject
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: The subject might not be blank.
description: 'Returned if:
* the client tries to write a read-only property
* a constraint for a property was violated
* a property was provided in an unreadable format'
/api/v3/projects/{id}/work_packages/form:
post:
summary: Form for creating Work Packages in a Project
operationId: form_create_work_package_in_project
tags:
- Work Packages
description: 'This endpoint allows you to validation a new work package creation body in a specific project. It works similarly
to the `/api/v3/work_packages/form` endpoint, but already specifies the work package''s project in the path, so that
it does not have to be defined in the request body.
This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages/form`](https://www.openproject.org/docs/api/endpoints/work-packages/#form-for-creating-work-packages-in-a-workspace)'
parameters:
- name: id
description: ID of the project in which the work package will be created
in: path
required: true
schema:
type: integer
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageWriteModel'
examples:
Minimal example:
$ref: '#/components/examples/WorkPackageCreateOnlySubject'
Valid example:
$ref: '#/components/examples/WorkPackageCreateValid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageFormModel'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
/api/v3/projects/{id}/available_assignees:
get:
parameters:
- description: Project id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
delete:
href: /api/v3/users/1
method: DELETE
title: Delete j.sheppard
lock:
href: /api/v3/users/1/lock
method: POST
title: Set lock on j.sheppard
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.com
firstName: John
id: 1
lastName: Sheppard
login: j.sheppard
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
- _links:
delete:
href: /api/v3/users/2
method: DELETE
title: Delete j.sheppard2
lock:
href: /api/v3/users/2/lock
method: POST
title: Set lock on j.sheppard2
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.net
firstName: Jim
id: 2
lastName: Sheppard
login: j.sheppard2
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
_links:
self:
href: /api/v3/projects/42/available_assignees
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Available_AssigneesModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the assignable users for this project.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: 'Returned if the project does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view project'
headers: {}
tags:
- Work Packages
description: 'Gets a list of users that can be assigned to work packages in the given project.
This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/available_assignees`](https://www.openproject.org/docs/api/endpoints/work-packages/#workspace-available-assignees)'
operationId: Project_Available_assignees
summary: Project Available assignees
/api/v3/work_packages:
get:
summary: List work packages
operationId: list_work_packages
tags:
- Work Packages
description: Returns a collection of work packages.
parameters:
- description: Page number inside the requested collection.
example: '25'
in: query
name: offset
required: false
schema:
default: 1
type: integer
- description: Number of elements to display per page.
example: '25'
in: query
name: pageSize
required: false
schema:
type: integer
- description: 'JSON specifying filter conditions.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)
endpoint. If no filter is to be applied, the client should send an empty array (`[]`), otherwise a default
filter is applied. A Currently supported filters are (there are additional filters added by modules):
- assigned_to
- assignee_or_group
- attachment_base
- attachment_content
- attachment_file_name
- author
- blocked
- blocks
- category
- comment
- created_at
- custom_field
- dates_interval
- description
- done_ratio
- due_date
- duplicated
- duplicates
- duration
- estimated_hours
- file_link_origin_id
- follows
- group
- id
- includes
- linkable_to_storage_id
- linkable_to_storage_url
- manual_sort
- milestone
- only_subproject
- parent
- partof
- precedes
- principal_base
- priority
- project
- relatable
- relates
- required
- requires
- responsible
- role
- search
- start_date
- status
- storage_id
- storage_url
- subject
- subject_or_id
- subproject
- type
- typeahead
- updated_at
- version
- watcher
- work_package'
example: '[{ "type_id": { "operator": "=", "values": ["1", "2"] }}]'
in: query
name: filters
required: false
schema:
default: '[{ "status_id": { "operator": "o", "values": null }}]'
type: string
- description: 'JSON specifying sort criteria.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.'
example: '[["status", "asc"]]'
in: query
name: sortBy
required: false
schema:
default: '[["id", "asc"]]'
type: string
- description: The column to group by.
example: status
in: query
name: groupBy
required: false
schema:
type: string
- description: Indicates whether properties should be summed up if they support it.
example: true
in: query
name: showSums
required: false
schema:
default: false
type: boolean
- description: Comma separated list of properties to include.
example: total,elements/subject,elements/id,self
in: query
name: select
required: false
schema:
type: string
- description: 'In order to perform a [baseline comparison](/docs/api/baseline-comparisons), you may provide one or several timestamps
in ISO-8601 format as comma-separated list. The timestamps may be absolute or relative,
such as ISO8601 dates, ISO8601 durations and the following relative date keywords: "oneDayAgo@HH:MM+HH:MM",
"lastWorkingDay@HH:MM+HH:MM", "oneWeekAgo@HH:MM+HH:MM", "oneMonthAgo@HH:MM+HH:MM".
The first "HH:MM" part represents the zero paded hours and minutes.
The last "+HH:MM" part represents the timezone offset from UTC associated with the time,
the offset can be positive or negative e.g."oneDayAgo@01:00+01:00", "oneDayAgo@01:00-01:00".
Usually, the first timestamp is the baseline date, the last timestamp is the current date.
Values older than 1 day are accepted only with valid Enterprise Token available.'
example: 2022-01-01T00:00:00Z,PT0S
in: query
name: timestamps
required: false
schema:
default: PT0S
type: string
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Work_PackagesModel'
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see work packages.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view work packages (globally or in any project)'
post:
summary: Create Work Package
operationId: create_work_package
tags:
- Work Packages
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 WorkPackage 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.
A project link must be set when creating work packages through this route.
When setting start date, finish date, and duration together, their correctness will be checked and a 422 error will be returned if one value does not match with the two others. You can make the server compute a value: set only two values in the request and the third one will be computed and returned in the response. For instance, when sending `{ "startDate": "2022-08-23", duration: "P2D" }`, the response will include `{ "dueDate": "2022-08-24" }`.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
parameters:
- description: 'Indicates whether change notifications (e.g. via E-Mail) should be sent.
Note that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),
not just the current user.'
example: false
in: query
name: notify
required: false
schema:
default: true
type: boolean
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to add work packages to this project.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: 'Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permissions:** view project
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: The subject might not be blank.
_embedded:
details:
attribute: Subject
description: 'Returned if:
* the client tries to write a read-only property
* a constraint for a property was violated
* a property was provided in an unreadable format'
/api/v3/work_packages/form:
post:
summary: Form for creating a Work Package
operationId: form_create_work_package
tags:
- Work Packages
description: 'When calling this endpoint, the client provides a single object containing the properties and links to be
created, in the body. The input is validated and a schema response is returned. If the validation errors of the
response is empty, the same payload can be used to create a work package.
Only the properties of the work package write model are allowed to set on a work package on creation.
When setting start date, finish date, and duration together, their correctness will be checked and a validation
error will be returned if one value does not match with the two others. You can make the server compute a value:
set only two values in the request and the third one will be computed and returned in the response. For instance,
when sending `{ "startDate": "2022-08-23", duration: "P2D" }`, the response will
include `{ "dueDate": "2022-08-24" }`.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageWriteModel'
examples:
Valid creation:
$ref: '#/components/examples/WorkPackageCreateValid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageFormModel'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
/api/v3/work_packages/schemas:
get:
summary: List Work Package Schemas
operationId: list_work_package_schemas
tags:
- Work Packages
description: 'List all work package schemas that match the given filters. This endpoint does not return a successful response,
if no filter is given.'
parameters:
- name: filters
description: 'JSON specifying filter conditions.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)
endpoint. Currently supported filters are:
+ id: The schema''s id
Schema id has the form `project_id-work_package_type_id`.'
in: query
required: true
schema:
type: string
example: '[{ "id": { "operator": "=", "values": ["12-1", "14-2"] } }]'
responses:
'200':
description: OK
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
self:
href: /api/v3/work_packages/schemas/13-1
_type: Schema...
- _links:
self:
href: /api/v3/work_packages/schemas/7-6
_type: Schema...
_links:
self:
href: /api/v3/work_packages/schemas
_type: Collection
count: 2
total: 5
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to list schemas.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** View work packages in any project.'
headers: {}
/api/v3/work_packages/schemas/{identifier}:
get:
parameters:
- description: Identifier of the schema
example: 12-13
in: path
name: identifier
required: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified schema does not exist.
description: 'Returned if the schema does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view work packages (on the project where this schema is used)
*Note: A client without sufficient permissions shall not be able to test for the existence of a project.
That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
headers: {}
tags:
- Work Packages
description: ''
operationId: View_Work_Package_Schema
summary: View Work Package Schema
/api/v3/work_packages/{id}:
delete:
summary: Delete Work Package
operationId: delete_work_package
tags:
- Work Packages
description: 'Deletes the work package, as well as:
- all associated time entries
- its hierarchy of child work packages'
parameters:
- description: Work package id
in: path
name: id
required: true
schema:
type: integer
example: 1
responses:
'204':
description: 'Returned if the work package was deleted successfully.
Note that the response body is empty as of now. In future versions of the API a body
*might* be returned along with an appropriate HTTP status.'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to delete this work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** delete work package'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
get:
summary: View Work Package
operationId: view_work_package
tags:
- Work Packages
description: Returns the specified work package.
parameters:
- description: Work package id
in: path
name: id
required: true
schema:
type: integer
example: 1
- description: 'In order to perform a [baseline comparison](/docs/api/baseline-comparisons) of the work-package attributes, you may
provide one or several timestamps in ISO-8601 format as comma-separated list. The timestamps may be absolute or relative,
such as ISO8601 dates, ISO8601 durations and the following relative date keywords: "oneDayAgo@HH:MM+HH:MM",
"lastWorkingDay@HH:MM+HH:MM", "oneWeekAgo@HH:MM+HH:MM", "oneMonthAgo@HH:MM+HH:MM".
The first "HH:MM" part represents the zero paded hours and minutes.
The last "+HH:MM" part represents the timezone offset from UTC associated with the time,
the offset can be positive or negative e.g."oneDayAgo@01:00+01:00", "oneDayAgo@01:00-01:00".
Usually, the first timestamp is the baseline date, the last timestamp is the current date.
Values older than 1 day are accepted only with valid Enterprise Token available.'
in: query
name: timestamps
required: false
schema:
default: PT0S
type: string
example: 2022-01-01T00:00:00Z,PT0S
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
description: OK
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
patch:
summary: Update a Work Package
operationId: update_work_package
tags:
- Work Packages
description: "When calling this endpoint the client provides a single object, containing the properties and links that it wants\nto change, in the body. Note that it is only allowed to provide properties or links supporting the **write**\noperation.\n\nAdditionally to the fields the client wants to change, it is mandatory to provide the value of `lockVersion` which\nwas received by the `GET` request this change originates from.\n\nThe value of `lockVersion` is used to implement\n[optimistic locking](https://en.wikipedia.org/wiki/Optimistic_concurrency_control).\n\n**Custom Field Validation** \n\nRequired custom fields are only validated when they are explicitly provided in the request body. If a custom field\nis not included in the update request, it will not be validated. This enables clients to update\nspecific attributes independently without having to provide values for all required custom fields.\n\nTo override this behavior and validate all required custom fields regardless of whether they are included in the\nrequest, set `validateCustomFields` to `true` in the `_meta` object of the request body."
parameters:
- name: id
description: Work package id
in: path
required: true
schema:
type: integer
example: 42
- name: notify
description: 'Indicates whether change notifications should be sent. Note that this controls notifications for all users
interested in changes to the work package (e.g. watchers, author and assignee), not just the current user.'
in: query
required: false
schema:
type: boolean
default: true
example: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackagePatchModel'
examples:
With custom field validation:
$ref: '#/components/examples/WorkPackageWithMetaValidation'
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
description: OK
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to edit the content of the work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** edit work package, assign version, change work package status, manage subtasks or move work package'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
'406':
$ref: '#/components/responses/MissingContentType'
'409':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:UpdateConflict
message: Your changes could not be saved, because the work package was changed since you've seen it the last time.
description: Returned if the resource was changed since the client requested it. This is determined using the `lockVersion` property.
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_embedded:
details:
attribute: Subject
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: The subject might not be blank.
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`)'
/api/v3/work_packages/{id}/activities:
get:
parameters:
- description: Work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
self:
href: /api/v3/activity/1
user:
href: /api/v3/users/1
workPackage:
href: /api/v3/work_packages/1
_type: Activity
comment:
format: markdown
html: Lorem ipsum dolor sit amet.
raw: Lorem ipsum dolor sit amet.
createdAt: '2014-05-21T08:51:20.396Z'
updatedAt: '2014-05-21T09:14:02.726Z'
details: []
id: 1
version: 1
- _links:
self:
href: /api/v3/activity/2
user:
href: /api/v3/users/1
workPackage:
href: /api/v3/work_packages/1
_type: Activity
comment:
format: markdown
html: Lorem ipsum dolor sit amet.
raw: Lorem ipsum dolor sit amet.
createdAt: '2014-05-21T09:51:22.077Z'
updatedAt: '2014-05-21T10:14:02.957Z'
details: []
id: 2
version: 2
_links:
self:
href: /api/v3/work_packages/1/revisions
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Work_Package_activitiesModel'
description: OK
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
headers: {}
tags:
- Work Packages
description: ''
operationId: List_work_package_activities
summary: List work package activities
post:
parameters:
- description: Work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
- description: 'Indicates whether change notifications (e.g. via E-Mail) should be sent.
Note that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),
not just the current user.'
example: false
in: query
name: notify
required: false
schema:
default: true
type: boolean
responses:
'201':
description: Created
headers: {}
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to create a comment here.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** create journals
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
headers: {}
tags:
- Work Packages
description: 'Creates an activity for the selected work package and, on success, returns the
updated activity.'
operationId: Comment_work_package
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ActivityCommentWriteModel'
summary: Comment work package
/api/v3/work_packages/{id}/available_assignees:
get:
parameters:
- description: Work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
delete:
href: /api/v3/users/1
method: DELETE
title: Delete j.sheppard
lock:
href: /api/v3/users/1/lock
method: POST
title: Set lock on j.sheppard
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.com
firstName: John
id: 1
lastName: Sheppard
login: j.sheppard
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
- _links:
delete:
href: /api/v3/users/2
method: DELETE
title: Delete j.sheppard2
lock:
href: /api/v3/users/2/lock
method: POST
title: Set lock on j.sheppard2
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.net
firstName: Jim
id: 2
lastName: Sheppard
login: j.sheppard2
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
_links:
self:
href: /api/v3/work_packages/42/available_assignees
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Available_AssigneesModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the assignable users for this work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** edit work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The work package you are looking for cannot be found or has been deleted.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages'
headers: {}
tags:
- Work Packages
description: Gets a list of users that can be assigned to the given work package.
operationId: Work_Package_Available_assignees
summary: Work Package Available assignees
/api/v3/work_packages/{id}/available_projects:
get:
parameters:
- description: work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
categories:
href: /api/v3/projects/6/categories
createWorkPackage:
href: /api/v3/projects/6/work_packages/form
method: post
createWorkPackageImmediate:
href: /api/v3/projects/6/work_packages
method: post
editWorkPackage:
href: /api/v3//work_packages/{id}/form
method: post
templated: true
self:
href: /api/v3/projects/6
title: A project
versions:
href: /api/v3/projects/6/versions
_type: Project
createdAt: '2015-07-06T13:28:14+00:00'
description: Eveniet molestias omnis quis aut qui eum adipisci. Atque aut aut in exercitationem adipisci amet. Nisi asperiores quia ratione veritatis enim exercitationem magnam. Aut fuga architecto adipisci nihil. Et repellat pariatur. Aliquam et sed perferendis nostrum quaerat. Fugit doloremque voluptatem.
id: 6
identifier: a_project
name: A project
type: Customer Project
updatedAt: '2015-10-01T09:55:02+00:00'
- _links:
categories:
href: /api/v3/projects/14/categories
createWorkPackage:
href: /api/v3/projects/14/work_packages/form
method: post
createWorkPackageImmediate:
href: /api/v3/projects/14/work_packages
method: post
self:
href: /api/v3/projects/14
title: Another project
versions:
href: /api/v3/projects/14/versions
_type: Project
createdAt: '2016-02-29T12:50:20+00:00'
description: ''
id: 14
identifier: another_project
name: Another project
type: null
updatedAt: '2016-02-29T12:50:20+00:00'
_links:
self:
href: /api/v3/work_packages/5/available_projects
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Available_projects_for_work_packageModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** edit work package
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
headers: {}
tags:
- Work Packages
description: Gets a list of projects that are available as projects to which the work package can be moved.
operationId: Available_projects_for_work_package
summary: Available projects for work package
/api/v3/work_packages/{id}/available_relation_candidates:
get:
summary: Available relation candidates
operationId: list_available_relation_candidates
tags:
- Work Packages
description: ''
parameters:
- description: Project id
example: 1
in: path
name: id
required: true
schema:
type: integer
- description: Maximum number of candidates to list (default 10)
example: 25
in: query
name: pageSize
required: false
schema:
type: integer
- description: 'JSON specifying filter conditions.
Accepts the same filters as the [work packages](https://www.openproject.org/docs/api/endpoints/work-packages/) endpoint.'
example: '[{ "status_id": { "operator": "o", "values": null } }]'
in: query
name: filters
required: false
schema:
type: string
- description: Shortcut for filtering by ID or subject
example: '"rollout"'
in: query
name: query
required: false
schema:
type: string
- description: Type of relation to find candidates for (default "relates")
example: '"follows"'
in: query
name: type
required: false
schema:
type: string
- description: 'JSON specifying sort criteria.
Accepts the same sort criteria as the [work packages](https://www.openproject.org/docs/api/endpoints/work-packages/) endpoint.'
example: '[["status", "asc"]]'
in: query
name: sortBy
required: false
schema:
default: '[["id", "asc"]]'
type: string
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
self:
href: /api/v3/work_packages/1
_type: WorkPackage
id: 1
subject: Skipped other properties for brevity
- _links:
self:
href: /api/v3/work_packages/2
_type: WorkPackage
id: 2
subject: Skipped other properties for brevity
_links:
self:
href: /api/v3/projects/14/work_packages
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Available_relation_candidatesModel'
description: OK
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
/api/v3/work_packages/{id}/available_watchers:
get:
parameters:
- description: work package id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
delete:
href: /api/v3/users/1
method: DELETE
title: Delete j.sheppard
lock:
href: /api/v3/users/1/lock
method: POST
title: Set lock on j.sheppard
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.com
firstName: John
id: 1
lastName: Sheppard
login: j.sheppard
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
- _links:
delete:
href: /api/v3/users/2
method: DELETE
title: Delete j.sheppard2
lock:
href: /api/v3/users/2/lock
method: POST
title: Set lock on j.sheppard2
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.net
firstName: Jim
id: 2
lastName: Sheppard
login: j.sheppard2
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
_links:
self:
href: /api/v3/work_packages/1/available_watchers
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Available_WatchersModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** add work package watchers
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
headers: {}
tags:
- Work Packages
description: Gets a list of users that are able to be watchers of the specified work package.
operationId: Available_watchers
summary: Available watchers
/api/v3/work_packages/{id}/file_links:
post:
summary: Creates file links.
operationId: create_work_package_file_link
tags:
- Work Packages
description: 'Creates file links on a work package.
The request is interpreted as a bulk insert, where every element of the collection is validated separately. Each
element contains the origin meta data and a link to the storage, the file link is about to point to. The storage
link can be provided as a resource link with id or as the host url.
The file''s id and name are considered mandatory information. The rest of the origin meta data SHOULD be provided
by the client. The _mimeType_ SHOULD be a standard mime type. An empty mime type will be handled as unknown. To link
a folder, the custom mime type `application/x-op-directory` MUST be used.
Up to 20 file links can be submitted at once.
If any element data is invalid, no file links will be created.
If a file link with matching origin id, work package, and storage already exists, then it will not create an
additional file link or update the meta data. Instead the information from the existing file link will be returned.'
parameters:
- name: id
description: Work package id
in: path
required: true
schema:
type: integer
example: 1337
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileLinkCollectionWriteModel'
example:
_type: Collection
_embedded:
elements:
- originData:
id: 5503
name: logo.png
mimeType: image/png
size: 433765
createdAt: '2021-12-19T09:42:10.170Z'
lastModifiedAt: '2021-12-20T14:00:13.987Z'
createdByName: Luke Skywalker
lastModifiedByName: Anakin Skywalker
_links:
storageUrl:
href: https://nextcloud.deathstar.rocks/
responses:
'201':
description: Created
content:
application/hal+json:
schema:
$ref: '#/components/schemas/FileLinkCollectionReadModel'
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** manage file links
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package, view file links'
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: The request was invalid. File Link logo.png - Storage was invalid.
description: 'Occurs if the request body was correctly formatted, but some properties lead to errors in the validation
process. This happens e.g. if the provided storage url is not available on the server.'
get:
summary: Gets all file links of a work package
operationId: list_work_package_file_links
tags:
- Work Packages
description: 'Gets all file links of a work package.
As a side effect, for every file link a request is sent to the storage''s origin to fetch live data and patch
the file link''s data before returning, as well as retrieving permissions of the user on this origin file. '
parameters:
- name: id
description: Work package id
in: path
required: true
schema:
type: integer
example: 1337
- name: filters
in: query
description: 'JSON specifying filter conditions.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)
endpoint. The following filters are supported:
- storage'
required: false
example: '[{"storage":{"operator":"=","values":["42"]}}]'
schema:
type: string
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/FileLinkCollectionReadModel'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view file links
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
/api/v3/work_packages/{id}/form:
post:
summary: Form for editing a Work Package
operationId: form_edit_work_package
tags:
- Work Packages
description: "When calling this endpoint, the client provides a single object containing the properties and links to be\nedited, in the body. The input is validated and a schema response is returned. If the validation errors of the\nresponse is empty, the same payload can be used to edit the work package.\n\nOnly the properties of the work package write model are allowed to set on a work package on editing.\n\nWhen setting start date, finish date, and duration together, their correctness will be checked and a validation\nerror will be returned if one value does not match with the two others. You can make the server compute a value:\nset only two values in the request and the third one will be computed and returned in the response. For instance,\nwhen sending `{ \"startDate\": \"2022-08-23\", duration: \"P2D\" }`, the response will\ninclude `{ \"dueDate\": \"2022-08-24\" }`.\n\n**Custom Field Validation** \n\nRequired custom fields are only validated when they are explicitly provided in the request body. If a custom field\nis not included in the form request, it will not be validated, allowing clients to validate partial updates\nwithout triggering validation errors for unrelated required custom fields.\n\nTo override this behavior and validate all required custom fields regardless of whether they are included in the\nrequest, set `validateCustomFields` to `true` in the `_meta` object of the request body."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageWriteModel'
examples:
Changing subject:
$ref: '#/components/examples/WorkPackageEditSubject'
With custom field validation:
$ref: '#/components/examples/WorkPackageWithMetaValidation'
parameters:
- name: id
description: ID of the work package being modified
in: path
required: true
schema:
type: integer
example: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageFormModel'
'404':
description: "Returned if the work package does not exist or the client does not have sufficient permissions to see it.\t\n\n**Required permission:** view work package"
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
'415':
$ref: '#/components/responses/UnsupportedMediaType'
/api/v3/work_packages/{id}/revisions:
get:
parameters:
- description: Work package id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
author:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
project:
href: /api/v3/projects/1
title: A Test Project
self:
href: /api/v3/revisions/13
showRevision:
href: /projects/identifier/repository/revision/11f4b07
_type: Revision
authorName: John Sheppard
createdAt: '2015-07-21T13:36:59.220Z'
formattedIdentifier: 11f4b07
id: 13
identifier: 11f4b07dff4f4ce9548a52b7d002daca7cd63ec6
message:
format: plain
html: This revision provides new features
An elaborate description
raw: 'This revision provides new features
An elaborate description'
- _links:
author:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard
project:
href: /api/v3/projects/1
title: A Test Project
self:
href: /api/v3/revisions/14
showRevision:
href: /projects/identifier/repository/revision/029ed72a
_type: Revision
authorName: j1msheppard
createdAt: '2015-06-30T08:47:00.818Z'
formattedIdentifier: 029ed72a
id: 13
identifier: 029ed72a3b7b7c4ab332b1f6eaa6576e7c946059
message:
format: plain
html: This revision fixes some stuff
More information here
raw: 'This revision fixes some stuff
More information here'
_links:
self:
href: /api/v3/work_packages/42/revisions
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/RevisionsModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see linked revisions for this work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view work packages for the project the work package is contained in.
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work project does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
headers: {}
tags:
- Work Packages
description: 'Gets a list of revisions that are linked to this work package, e.g., because it is referenced in the commit message of the revision.
Only linked revisions from repositories are shown if the user has the view changesets permission in the defining project.'
operationId: Revisions
summary: Revisions
/api/v3/work_packages/{work_package_id}/reminders:
get:
summary: List work package reminders
operationId: list_work_package_reminders
tags:
- Work Packages
description: 'Gets a list of your upcoming reminders for this work package.
Only active reminders that belong to the current user are returned.'
parameters:
- name: work_package_id
in: path
description: Work package id
example: '1'
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/hal+json:
schema:
type: object
required:
- _type
- total
- count
- _embedded
properties:
_type:
type: string
enum:
- Collection
total:
type: integer
description: The total amount of elements available in the collection.
minimum: 0
count:
type: integer
description: Actual amount of elements in this response.
minimum: 0
_embedded:
type: object
required:
- elements
properties:
elements:
type: array
items:
$ref: '#/components/schemas/ReminderModel'
'403':
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view work packages for the project the work package is contained in.'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
summary: Create a work package reminder
operationId: create_work_package_reminder
tags:
- Work Packages
description: 'Creates a new reminder for the specified work package.
**Note:** A user can only have one **active** reminder at a time for a given work package.'
parameters:
- name: work_package_id
in: path
description: Work package id
example: '1'
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- remindAt
properties:
remindAt:
type: string
format: date-time
description: The date and time when the reminder is due
note:
type: string
description: The note of the reminder
responses:
'201':
description: Reminder created successfully
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ReminderModel'
'404':
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
description: 'Returned if the user already has an active reminder for this work package.
**Error message**: You can only set one reminder at a time for a work package. Please delete or update the existing reminder.'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v3/work_packages/{id}/watchers:
get:
parameters:
- description: Work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
example:
_embedded:
elements:
- _links:
delete:
href: /api/v3/users/1
method: DELETE
title: Delete j.sheppard
lock:
href: /api/v3/users/1/lock
method: POST
title: Set lock on j.sheppard
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
showUser:
href: /users/1
type: text/html
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
firstName: John
id: 1
lastName: Sheppard
login: j.sheppard
mail: shep@mail.com
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
- _links:
delete:
href: /api/v3/users/2
method: DELETE
title: Delete j.sheppard2
lock:
href: /api/v3/users/2/lock
method: POST
title: Set lock on j.sheppard2
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
firstName: Jim
id: 2
lastName: Sheppard
login: j.sheppard2
mail: shep@mail.net
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
_links:
self:
href: /api/v3/work_packages/14/watchers
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/WatchersModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the watchers of this work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view work package watchers
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
*Note that you will effectively not be able to see the watchers of a work package without being able to see the work package.*'
headers: {}
tags:
- Work Packages
description: ''
operationId: List_watchers
summary: List watchers
post:
parameters:
- description: Work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
description: OK
headers: {}
'201':
description: Created
headers: {}
'400':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_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.
For example:
* The request did not contain a single JSON object
* The JSON object did not contain the key `user`
* The value of `users` was not a link object'
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to add watchers to this work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permissions:**
* view work package (for self)
* add work package watchers (for other users)
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
*Note that you will effectively not be able to change the watchers of a work package without being able to see the work package.*'
headers: {}
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
description: 'Returned if:
* the client tries to specify a link to a resource that is not a user (`ResourceTypeMismatch`)
* the user specified is not allowed to watch that work package (`PropertyConstraintViolation`)
* the user specified does not exist (`PropertyConstraintViolation`)'
headers: {}
tags:
- Work Packages
description: 'Adds a watcher to the specified work package.
The request is expected to contain a single JSON object, that contains a link object under the `user` key.
The response will be user added as watcher.
In case the user was already watching the work package an `HTTP 200` is returned, an
`HTTP 201` if the user was added as a new watcher.'
operationId: Add_watcher
requestBody:
content:
application/json:
schema:
example:
user:
href: /api/v3/users/1
properties:
user:
properties:
href:
type: string
type: object
type: object
summary: Add watcher
/api/v3/work_packages/{id}/watchers/{user_id}:
delete:
parameters:
- description: Work package id
example: 1
in: path
name: id
required: true
schema:
type: integer
- description: User id
example: 1
in: path
name: user_id
required: true
schema:
type: integer
responses:
'204':
description: No Content
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to remove watchers from this work package.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** delete work package watchers
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: 'Returned in one of the following cases:
Either the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
Or the specified user does not exist at all.
*Note that you will effectively not be able to change the watchers of a work package without being able to see the work package.*'
headers: {}
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
tags:
- Work Packages
description: 'Removes the specified user from the list of watchers for the given work package.
If the request succeeds, the specified user is not watching the work package anymore.
*Note: This might also be the case, if the specified user did not watch the work package prior to the request.*'
operationId: Remove_watcher
summary: Remove watcher
/api/v3/workspaces/{id}/available_assignees:
get:
parameters:
- description: Workspace id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
delete:
href: /api/v3/users/1
method: DELETE
title: Delete j.sheppard
lock:
href: /api/v3/users/1/lock
method: POST
title: Set lock on j.sheppard
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.com
firstName: John
id: 1
lastName: Sheppard
login: j.sheppard
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
- _links:
delete:
href: /api/v3/users/2
method: DELETE
title: Delete j.sheppard2
lock:
href: /api/v3/users/2/lock
method: POST
title: Set lock on j.sheppard2
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20.396Z'
email: shep@mail.net
firstName: Jim
id: 2
lastName: Sheppard
login: j.sheppard2
status: active
updatedAt: '2014-05-21T08:51:20.396Z'
_links:
self:
href: /api/v3/workspaces/42/available_assignees
_type: Collection
count: 2
total: 2
schema:
$ref: '#/components/schemas/Available_AssigneesModel'
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the assignable users for this workspace.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding workspace.*'
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified workspace does not exist.
description: 'Returned if the workspace does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view workspace'
headers: {}
tags:
- Work Packages
description: Gets a list of users that can be assigned to work packages in the given workspace.
operationId: Workspace_Available_assignees
summary: Workspace Available assignees
/api/v3/workspaces/{id}/work_packages:
get:
summary: Get work packages of workspace
operationId: Get_Workspace_Work_Package_Collection
tags:
- Work Packages
description: Returns the collection of work packages that are related to the given workspace.
parameters:
- description: Workspace id
example: 1
in: path
name: id
required: true
schema:
type: integer
- description: Page number inside the requested collection.
example: 25
in: query
name: offset
required: false
schema:
default: 1
type: integer
- description: Number of elements to display per page.
example: 25
in: query
name: pageSize
required: false
schema:
type: integer
- description: 'JSON specifying filter conditions.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. If no filter is to be applied, the client should send an empty array (`[]`).'
example: '[{ "type_id": { "operator": "=", "values": [''1'', ''2''] }}]'
in: query
name: filters
required: false
schema:
default: '[{ "status_id": { "operator": "o", "values": null }}]'
type: string
- description: 'JSON specifying sort criteria.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.'
example: '[["status", "asc"]]'
in: query
name: sortBy
required: false
schema:
default: '[["id", "asc"]]'
type: string
- description: The column to group by.
example: status
in: query
name: groupBy
required: false
schema:
type: string
- description: Indicates whether properties should be summed up if they support it.
example: true
in: query
name: showSums
required: false
schema:
default: false
type: boolean
- description: Comma separated list of properties to include.
example: total,elements/subject,elements/id,self
in: query
name: select
required: false
schema:
type: string
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Work_PackagesModel'
description: OK
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the work packages of this project.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** view work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding workspace.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: 'Returned if the workspace does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view workspace'
post:
summary: Create work package in workspace
operationId: Create_Workspace_Work_Package
tags:
- Work Packages
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 WorkPackage 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.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
parameters:
- description: Project id
example: '1'
in: path
name: id
required: true
schema:
type: integer
- description: 'Indicates whether change notifications (e.g. via E-Mail) should be sent.
Note that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),
not just the current user.'
example: false
in: query
name: notify
required: false
schema:
default: true
type: boolean
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/WorkPackageModel'
description: OK
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to add work packages to this workspace.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** add work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding workspace.*'
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: 'Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permissions:** view workspace
*Note: A client without sufficient permissions shall not be able to test for the existence of a workspace.
That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_embedded:
details:
attribute: Subject
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: The subject might not be blank.
description: 'Returned if:
* the client tries to write a read-only property
* a constraint for a property was violated
* a property was provided in an unreadable format'
/api/v3/workspaces/{id}/work_packages/form:
post:
summary: Form for creating Work Packages in a Workspace
operationId: form_create_work_package_in_workspace
tags:
- Work Packages
description: 'This endpoint allows you to validation a new work package creation body in a specific workspace. It works similarly
to the `/api/v3/work_packages/form` endpoint, but already specifies the work package''s workspace in the path, so that
it does not have to be defined in the request body.'
parameters:
- name: id
description: ID of the workspace in which the work package will be created
in: path
required: true
schema:
type: integer
example: '1'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageWriteModel'
examples:
Minimal example:
$ref: '#/components/examples/WorkPackageCreateOnlySubject'
Valid example:
$ref: '#/components/examples/WorkPackageCreateValid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WorkPackageFormModel'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
components:
schemas:
CollectionModel:
type: object
required:
- _type
- total
- count
- _links
properties:
_type:
type: string
enum:
- Collection
total:
type: integer
description: The total amount of elements available in the collection.
minimum: 0
count:
type: integer
description: Actual amount of elements in this response.
minimum: 0
_links:
$ref: '#/components/schemas/CollectionLinks'
Link:
type: object
required:
- href
properties:
href:
type:
- string
- 'null'
description: URL to the referenced resource (might be relative)
title:
type: string
description: Representative label for the resource
templated:
type: boolean
default: false
description: If true the href contains parts that need to be replaced by the client
method:
type: string
default: GET
description: The HTTP verb to use when requesting the resource
payload:
type: object
description: The payload to send in the request to achieve the desired result
identifier:
type: string
description: An optional unique identifier to the link object
type:
type: string
description: The MIME-Type of the returned resource.
example:
href: /api/v3/work_packages
method: POST
FileLinkCollectionWriteModel:
type: object
required:
- _embedded
properties:
_embedded:
type: object
required:
- elements
properties:
elements:
type: array
items:
$ref: '#/components/schemas/FileLinkWriteModel'
example:
_embedded:
elements:
- originData:
id: '5503'
name: logo.png
mimeType: image/png
size: 16042
createdAt: '2021-12-19T09:42:10.170Z'
lastModifiedAt: '2021-12-20T14:00:13.987Z'
createdByName: Luke Skywalker
lastModifiedByName: Anakin Skywalker
_links:
storage:
href: /api/v3/storage/42
WorkPackageModel:
allOf:
- $ref: '#/components/schemas/CustomFieldProperties'
- type: object
required:
- subject
- _links
properties:
id:
type: integer
description: Work package id
readOnly: true
minimum: 1
lockVersion:
type: integer
description: The version of the item as used for optimistic locking
readOnly: true
subject:
type: string
description: Work package subject
_type:
type: string
enum:
- WorkPackage
readOnly: true
description:
allOf:
- $ref: '#/components/schemas/Formattable'
- description: The work package description
scheduleManually:
type: boolean
description: 'Uses manual scheduling mode when true (default). Uses automatic scheduling
mode when false. Can be automatic only when predecessors or children are
present.'
readonly:
type: boolean
description: If true, the work package is in a readonly status so with the exception of the status, no other property can be altered.
startDate:
type:
- string
- 'null'
format: date
description: Scheduled beginning of a work package
dueDate:
type:
- string
- 'null'
format: date
description: Scheduled end of a work package
date:
type:
- string
- 'null'
format: date
description: Date on which a milestone is achieved
derivedStartDate:
type:
- string
- 'null'
format: date
description: Similar to start date but is not set by a client but rather deduced by the work packages' descendants. If manual scheduleManually is active, the two dates can deviate.
readOnly: true
derivedDueDate:
type:
- string
- 'null'
format: date
description: Similar to due date but is not set by a client but rather deduced by the work packages' descendants. If manual scheduleManually is active, the two dates can deviate.
readOnly: true
duration:
type:
- string
- 'null'
format: duration
description: '**(NOT IMPLEMENTED)** The amount of time in hours the work package needs to be completed.
Not available for milestone type of work packages.'
readOnly: true
estimatedTime:
type:
- string
- 'null'
format: duration
description: Time a work package likely needs to be completed excluding its descendants
derivedEstimatedTime:
type:
- string
- 'null'
format: duration
description: Time a work package likely needs to be completed including its descendants
readOnly: true
ignoreNonWorkingDays:
type: boolean
description: '**(NOT IMPLEMENTED)** When scheduling, whether or not to ignore the non working days being defined.
A work package with the flag set to true will be allowed to be scheduled to a non working day.'
readOnly: true
position:
type:
- integer
- 'null'
description: 'The position this work package has in a version configured to be backlog (sprint or product).
# Conditions
**Permission** Backlogs needs to be enabled in the work package''s project and the work package''s type is configured to be a backlog type.'
readOnly: true
spentTime:
type: string
format: duration
description: 'The time booked for this work package by users working on it
# Conditions
**Permission** view time entries'
readOnly: true
storyPoints:
type:
- integer
- 'null'
description: 'The estimation in story points on how long this work package will take to complete
# Conditions
**Permission** Backlogs needs to be enabled in the work package''s project and the work package''s type is configured to be a backlog type.'
readOnly: false
percentageDone:
type:
- integer
- 'null'
description: Amount of total completion for a work package
minimum: 0
maximum: 100
derivedPercentageDone:
type:
- integer
- 'null'
description: Amount of total completion for a work package derived from itself and its descendant work packages
readOnly: true
minimum: 0
maximum: 100
createdAt:
type: string
format: date-time
description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
readOnly: true
updatedAt:
type: string
format: date-time
description: Time of the most recent change to the work package.
readOnly: true
_links:
type: object
required:
- self
- schema
- ancestors
- author
- priority
- project
- status
- type
properties:
addComment:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Post comment to WP
# Conditions
**Permission**: add work package notes'
readOnly: true
addRelation:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Adds a relation to this work package.
# Conditions
**Permission**: manage wp relations'
readOnly: true
addWatcher:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Add any user to WP watchers
# Conditions
**Permission**: add watcher'
readOnly: true
customActions:
type: array
readOnly: true
items:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A predefined action that can be applied to the work package.
**Resource**: CustomAction'
readOnly: true
previewMarkup:
allOf:
- $ref: '#/components/schemas/Link'
- description: Post markup (in markdown) here to receive an HTML-rendered response
readOnly: true
removeWatcher:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Remove any user from WP watchers
# Conditions
**Permission**: delete watcher'
readOnly: true
delete:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Delete this work package
# Conditions
**Permission**: delete_work_packages'
readOnly: true
logTime:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Create time entries on the work package
# Conditions
**Permission**: log_time or log_own_time'
readOnly: true
move:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Link to page for moving this work package
# Conditions
**Permission**: move_work_packages'
readOnly: true
copy:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Link to page for copying this work package
# Conditions
**Permission**: add_work_packages'
readOnly: true
unwatch:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Remove current user from WP watchers
# Conditions
logged in; watching'
readOnly: true
update:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Form endpoint that aids in preparing and performing edits on a work package
# Conditions
**Permission**: edit work package'
readOnly: true
updateImmediately:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Directly perform edits on a work package
# Conditions
**Permission**: edit work package'
readOnly: true
watch:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Add current user to WP watchers
# Conditions
logged in; not watching'
readOnly: true
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This work package
**Resource**: WorkPackage'
readOnly: true
schema:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The schema of this work package
**Resource**: Schema'
readOnly: true
ancestors:
type: array
readOnly: true
items:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A visible ancestor work package of the current work package.
**Resource**: WorkPackage
# Conditions
**Permission** view work packages'
readOnly: true
attachments:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The files attached to this work package
**Resource**: Collection
# Conditions
- **Setting**: deactivate_work_package_attachments set to false in related workspace'
addAttachment:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Attach a file to the work package
# Conditions
- **Permission**: edit work package'
readOnly: true
prepareAttachment:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Attach a file to the work package
# Conditions
- **Setting**: direct uploads enabled'
readOnly: true
author:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The person that created the work package
**Resource**: User'
readOnly: true
assignee:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The person that is intended to work on the work package
**Resource**: User'
availableWatchers:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'All users that can be added to the work package as watchers.
**Resource**: User
# Conditions
**Permission** add work package watchers'
readOnly: true
budget:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The budget this work package is associated to
**Resource**: Budget
# Conditions
**Permission** view cost objects'
category:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The category of the work package
**Resource**: Category'
children:
type: array
readOnly: true
items:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A visible child work package of the current work package.
**Resource**: WorkPackage
# Conditions
**Permission** view work packages'
readOnly: true
addFileLink:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Add a file link to the work package
# Conditions
**Permission**: manage_file_links'
fileLinks:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Gets the file link collection of this work package
# Conditions
**Permission**: view_file_links'
parent:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Parent work package
**Resource**: WorkPackage'
priority:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The priority of the work package
**Resource**: Priority'
project:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The workspace to which the work package belongs
**Resource**: Workspace'
projectPhase:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The project phase to which the work package belongs
**Resource**: ProjectPhase'
projectPhaseDefinition:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The definition of the project phase the work package belongs to
**Resource**: ProjectPhaseDefinition'
responsible:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The person that is responsible for the overall outcome
**Resource**: User'
relations:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Relations this work package is involved in
**Resource**: Relation
# Conditions
**Permission** view work packages'
readOnly: true
revisions:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Revisions that are referencing the work package
**Resource**: Revision
# Conditions
**Permission** view changesets'
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The current status of the work package
**Resource**: Status'
sprint:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The sprint the work package is assigned to
**Resource**: Sprint
# Conditions
**Permission** view sprints'
timeEntries:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'All time entries logged on the work package. Please note that this is a link to an HTML resource for now and as such, the link is subject to change.
**Resource**: N/A
# Conditions
**Permission** view time entries'
readOnly: true
type:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The type of the work package
**Resource**: Type'
version:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The version associated to the work package
**Resource**: Version'
watchers:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'All users that are currently watching this work package
**Resource**: Collection
# Conditions
**Permission** view work package watchers'
readOnly: true
example:
_type: WorkPackage
_links:
self:
href: /api/v3/work_packages/1528
title: Develop API
schema:
href: /api/v3/work_packages/schemas/11-2
update:
href: /api/v3/work_packages/1528
method: patch
title: Update Develop API
delete:
href: /work_packages/bulk?ids=1528
method: delete
title: Delete Develop API
logTime:
href: /work_packages/1528/time_entries/new
type: text/html
title: Log time on Develop API
move:
href: /work_packages/1528/move/new
type: text/html
title: Move Develop API
attachments:
href: /api/v3/work_packages/1528/attachments
addAttachment:
href: /api/v3/work_packages/1528/attachments
method: post
author:
href: /api/v3/users/1
title: OpenProject Admin - admin
customActions:
- href: /api/v3/work_packages/1528/custom_actions/153/execute
method: post
title: Reset
- href: /api/v3/work_packages/1528/custom_actions/94/execute
method: post
title: Forward to accounting
responsible:
href: /api/v3/users/23
title: Laron Leuschke - Alaina5788
relations:
href: /api/v3/work_packages/1528/relations
title: Show relations
revisions:
href: /api/v3/work_packages/1528/revisions
assignee:
href: /api/v3/users/11
title: Emmie Okuneva - Adele5450
priority:
href: /api/v3/priorities/2
title: Normal
project:
href: /api/v3/portfolio/1
title: A Test Portfolio
status:
href: /api/v3/statuses/1
title: New
type:
href: /api/v3/types/1
title: A Type
version:
href: /api/v3/versions/1
title: Version 1
availableWatchers:
href: /api/v3/work_packages/1528/available_watchers
watch:
href: /api/v3/work_packages/1528/watchers
method: post
payload:
user:
href: /api/v3/users/1
addWatcher:
href: /api/v3/work_packages/1528/watchers
method: post
payload:
user:
href: /api/v3/users/{user_id}
templated: true
removeWatcher:
href: /api/v3/work_packages/1528/watchers/{user_id}
method: delete
templated: true
addRelation:
href: /api/v3/relations
method: post
title: Add relation
changeParent:
href: /api/v3/work_packages/694
method: patch
title: Change parent of Bug in OpenProject
addComment:
href: /api/v3/work_packages/1528/activities
method: post
title: Add comment
parent:
href: /api/v3/work_packages/1298
title: nisi eligendi officiis eos delectus quis voluptas dolores
category:
href: /api/v3/categories/1298
title: eligend isi
children:
- href: /api/v3/work_packages/1529
title: Write API documentation
ancestors:
- href: /api/v3/work_packages/1290
title: Root node of hierarchy
- href: /api/v3/work_packages/1291
title: Intermediate node of hierarchy
- href: /api/v3/work_packages/1298
title: nisi eligendi officiis eos delectus quis voluptas dolores
timeEntries:
href: /work_packages/1528/time_entries
type: text/html
title: Time entries
watchers:
href: /api/v3/work_packages/1528/watchers
customField3:
href: api/v3/users/14
id: 1528
subject: Develop API
description:
format: markdown
raw: Develop super cool OpenProject API.
html: Develop super cool OpenProject API.
scheduleManually: false
readonly: false
startDate: null
dueDate: null
derivedStartDate: null
derivedDueDate: null
estimatedTime: PT2H
derivedEstimatedTime: PT10H
percentageDone: 0
customField1: Foo
customField2: 42
createdAt: '2014-08-29T12:40:53.373Z'
updatedAt: '2014-08-29T12:44:41.981Z'
FileLinkReadModel:
type: object
properties:
id:
type: integer
description: File link id
_type:
type: string
enum:
- FileLink
createdAt:
type: string
format: date-time
description: Time of creation
updatedAt:
type: string
format: date-time
description: Time of the most recent change to the file link
originData:
$ref: '#/components/schemas/FileLinkOriginDataModel'
_embedded:
type: object
required:
- storage
- container
properties:
storage:
$ref: '#/components/schemas/StorageReadModel'
_links:
type: object
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This file link.
**Resource**: FileLink'
storage:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The storage resource of the linked file.
**Resource**: Storage'
container:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The container the origin file is linked to.
Can be one of the following **Resources**:
- WorkPackage'
creator:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The creator of the file link.
**Resource**: User'
delete:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The uri to delete the file link.
**Resource**: N/A'
status:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The urn of the user specific file link status on its storage. Can be one of:
- urn:openproject-org:api:v3:file-links:permission:ViewAllowed
- urn:openproject-org:api:v3:file-links:permission:ViewNotAllowed
- urn:openproject-org:api:v3:file-links:NotFound
- urn:openproject-org:api:v3:file-links:Error
**Resource**: N/A'
originOpen:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The uri to open the origin file on the origin itself.
**Resource**: N/A'
staticOriginOpen:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A static uri to open the origin file on the storage. Responds with a redirect.
**Resource**: N/A'
originOpenLocation:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The uri to open the location of origin file on the origin itself.
**Resource**: N/A'
staticOriginOpenLocation:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A static uri to open the location of the origin file on the storage. Responds with a redirect.
**Resource**: N/A'
staticOriginDownload:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A static uri to generate a new download URL from the storage. Responds with a redirect.
**Resource**: N/A'
example:
id: 1337
_type: FileLink
createdAt: '2021-12-20T13:37:00.211Z'
updatedAt: '2021-12-20T13:37:00.211Z'
originData:
id: '5503'
name: logo.png
mimeType: image/png
size: 16042
createdAt: '2021-12-19T09:42:10.170Z'
lastModifiedAt: '2021-12-20T14:00:13.987Z'
createdByName: Luke Skywalker
lastModifiedByName: Anakin Skywalker
_embedded:
storage:
id: 1337
_type: Storage
name: It's no moon
createdAt: '2021-12-20T13:37:00.211Z'
updatedAt: '2021-12-20T13:37:00.211Z'
_links:
self:
href: /api/v3/storages/1337
title: It's no moon
type:
href: urn:openproject-org:api:v3:storages:nextcloud
title: Nextcloud
origin:
href: https://nextcloud.deathstar.rocks/
open:
href: https://example.com/a-link-to-open-the-file
authorizationState:
href: urn:openproject-org:api:v3:storages:authorization:Connected
container:
_hint: Work package resource shortened for brevity
_type: WorkPackage
id: 1528
subject: Develop API
_links:
self:
href: /api/v3/work_package/17/file_links/1337
storage:
href: /api/v3/storage/42
title: It's no moon
container:
href: /api/v3/work_package/17
title: Develop API
creator:
href: /api/v3/users/33
title: Obi-Wan Kenobi
delete:
href: /api/v3/work_package/17/file_links/1337
status:
href: urn:openproject-org:api:v3:file-links:permission:ViewAllowed
title: View allowed
originOpen:
href: https://nextcloud.deathstar.rocks/index.php/f/5503?openfile=1
staticOriginOpen:
href: /api/v3/file_links/1337/open
originOpenLocation:
href: https://nextcloud.deathstar.rocks/index.php/f/5503?openfile=0
staticOriginOpenLocation:
href: /api/v3/file_links/1337/open?location=true
staticOriginDownload:
href: /api/v3/file_links/1337/download
PrincipalModel:
type: object
required:
- _type
- id
- name
- _links
properties:
_type:
type: string
enum:
- User
- Group
- PlaceholderUser
id:
type: integer
description: The principal's unique identifier.
minimum: 1
name:
type: string
description: The principal's display name, layout depends on instance settings.
createdAt:
type: string
format: date-time
description: Time of creation
updatedAt:
type: string
format: date-time
description: Time of the most recent change to the principal
_links:
type: object
required:
- self
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This principal resource.
**Resource**: User|Group|PlaceholderUser'
memberships:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'An href to the collection of the principal''s memberships.
# Conditions:
- user has permission `view_members` or `manage_members` in any project
**Resource**: Collection'
WorkPackageWriteModel:
type: object
description: 'This model is used for creating and updating work packages. It can also be used for validation against the work
package form endpoints.'
properties:
subject:
type: string
description: Work package subject
description:
allOf:
- $ref: '#/components/schemas/Formattable'
- description: The work package description
scheduleManually:
type: boolean
description: 'Uses manual scheduling mode when true (default). Uses automatic scheduling
mode when false. Can be automatic only when predecessors or children are
present.'
startDate:
type:
- string
- 'null'
format: date
description: Scheduled beginning of a work package
dueDate:
type:
- string
- 'null'
format: date
description: Scheduled end of a work package
estimatedTime:
type:
- string
- 'null'
format: duration
description: Time a work package likely needs to be completed excluding its descendants
duration:
type:
- string
- 'null'
format: duration
description: 'The amount of time in hours the work package needs to be completed. This value must be bigger or equal to `P1D`,
and any the value will get floored to the nearest day.
The duration has no effect, unless either a start date or a due date is set.
Not available for milestone type of work packages.'
ignoreNonWorkingDays:
type: boolean
description: 'When scheduling, whether or not to ignore the non working days being defined.
A work package with the flag set to true will be allowed to be scheduled to a non working day.'
_links:
type: object
properties:
category:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The category of the work package
**Resource**: Category'
type:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The type of the work package
**Resource**: Type'
priority:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The priority of the work package
**Resource**: Priority'
project:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The project to which the work package belongs
**Resource**: Project'
status:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The current status of the work package
**Resource**: Status'
responsible:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The person that is responsible for the overall outcome
**Resource**: User'
assignee:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The person that is intended to work on the work package
**Resource**: User'
version:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The version associated to the work package
**Resource**: Version'
parent:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Parent work package
**Resource**: WorkPackage'
_meta:
type: object
description: Meta information for the work package request
properties:
validateCustomFields:
type: boolean
description: 'When set to true, explicitly validates all required custom fields on the work package, regardless of whether
they are provided in the request body. This overrides the default behavior where only custom fields included
in the request are validated. Use this parameter when you need to ensure all required custom fields have
valid values before allowing the update to proceed.'
default: false
SchemaPropertyModel:
type: object
required:
- type
- name
- required
- hasDefault
- writable
properties:
type:
type: string
description: The resource type for this property.
name:
type: string
description: The name of the property.
required:
type: boolean
description: Indicates, if the property is required for submitting a request of this schema.
hasDefault:
type: boolean
description: Indicates, if the property has a default.
writable:
type: boolean
description: Indicates, if the property is writable when sending a request of this schema.
options:
type: object
description: Additional options for the property.
location:
type: string
description: Defines the json path where the property is located in the payload.
default: ''
placeholder:
type: string
description: A placeholder for the property to display if the property has no value.
_links:
type: object
description: Useful links for this property (e.g. an endpoint to fetch allowed values)
CollectionLinks:
type: object
required:
- self
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This collection resource.
**Resource**: Collection'
Work_PackagesModel:
allOf:
- $ref: '#/components/schemas/CollectionModel'
- type: object
required:
- _links
- _embedded
properties:
_links:
type: object
required:
- self
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The work package collection
**Resource**: WorkPackageCollection'
readOnly: true
_embedded:
type: object
required:
- elements
properties:
elements:
type: array
items:
$ref: '#/components/schemas/WorkPackageModel'
example:
_links:
self:
href: /api/v3/work_packages
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _abbreviated: Work package resource shortened for brevity
_type: WorkPackage
_links:
self:
href: /api/v3/work_packages/1
id: 1
- _abbreviated: Work package resource shortened for brevity
_type: WorkPackage
_links:
self:
href: /api/v3/work_packages/2
id: 2
StorageReadModel:
type: object
required:
- id
- _type
- name
- _links
properties:
id:
type: integer
description: Storage id
_type:
type: string
enum:
- Storage
name:
type: string
description: Storage name
storageAudience:
type: string
description: 'The audience that the storage expects in tokens for requests to it,
usually the storage''s client ID at the identity provider.
This is only required for authentication through single-sign-on and so far
only supported for provider type Nextcloud.'
tokenExchangeScope:
type: string
description: 'The scope that will be requested when requesting a token for the storage through token exchange. Has no effect if no
token exchange is performed.
This is only required for authentication through single-sign-on and so far only supported for provider type Nextcloud.'
tenantId:
type:
- string
- 'null'
description: 'The tenant id of a file storage of type OneDrive.
Ignored if the provider type is not OneDrive. May be null if the storage is not configured completely.'
driveId:
type:
- string
- 'null'
description: 'The drive id of a file storage of type OneDrive.
Ignored if the provider type is not OneDrive. May be null if the storage is not configured completely.'
hasApplicationPassword:
type: boolean
description: 'Whether the storage has the application password to use for the Nextcloud storage.
Ignored if the provider type is not Nextcloud.'
forbiddenFileNameCharacters:
type: string
description: 'A string with all the characters forbidden to be used for file and folder names in the storage. Used by OpenProject to avoid
creating files with unsupported names (e.g. when creating project folders).
Only supported for provider type Nextcloud so far.'
createdAt:
type: string
format: date-time
description: Time of creation
updatedAt:
type: string
format: date-time
description: Time of the most recent change to the storage
configured:
type: boolean
description: Indication, if the storage is fully configured
_embedded:
type: object
properties:
oauthApplication:
$ref: '#/components/schemas/OAuthApplicationReadModel'
oauthClientCredentials:
$ref: '#/components/schemas/OAuthClientCredentialsReadModel'
_links:
type: object
required:
- self
- type
- open
- authorizationState
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This storage resource. Contains the user defined storage name as title.
**Resource**: Storage'
type:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The urn of the storage type. Currently Nextcloud and OneDrive storages are supported.
- urn:openproject-org:api:v3:storages:Nextcloud
- urn:openproject-org:api:v3:storages:OneDrive
**Resource**: N/A'
authenticationMethod:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The urn of the authentication method. Currently only Nextcloud storages support this setting.
- urn:openproject-org:api:v3:storages:authenticationMethod:TwoWayOAuth2 (default)
- urn:openproject-org:api:v3:storages:authenticationMethod:OAuth2SSO
**Resource**: N/A'
origin:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Web URI of the storage instance. This link is ignored, if the storage is hosted in a cloud and has no own
URL, like file storages of type OneDrive.
**Resource**: N/A'
open:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'URI of the file storage location, from where the user usually starts browsing files.
**Resource**: N/A'
authorizationState:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The urn of the storage connection state. Can be one of:
- urn:openproject-org:api:v3:storages:authorization:Connected
- urn:openproject-org:api:v3:storages:authorization:FailedAuthorization
- urn:openproject-org:api:v3:storages:authorization:Error
**Resource**: N/A'
authorize:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The link to the starting point of the authorization cycle for a configured storage provider.
# Conditions
`authorizationState` is:
- urn:openproject-org:api:v3:storages:authorization:FailedAuthorization
**Resource**: N/A'
oauthApplication:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The OAuth 2 provider application linked to the storage.
# Conditions
- User has role `admin`
**Resource**: OAuthApplication'
oauthClientCredentials:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The OAuth 2 credentials resource linked to the storage.
# Conditions
- User has role `admin`
**Resource**: OAuthClientCredentials'
Work_Package_activitiesModel:
type: object
example:
_links:
self:
href: /api/v3/work_packages/1/revisions
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _type: Activity
_links:
self:
href: /api/v3/activity/1
workPackage:
href: /api/v3/work_packages/1
user:
href: /api/v3/users/1
id: 1
details: []
comment:
format: markdown
raw: Lorem ipsum dolor sit amet.
html: Lorem ipsum dolor sit amet.
createdAt: '2014-05-21T08:51:20.396Z'
updatedAt: '2014-05-21T09:14:02.324Z'
version: 1
- _type: Activity
_links:
self:
href: /api/v3/activity/2
workPackage:
href: /api/v3/work_packages/1
user:
href: /api/v3/users/1
id: 2
details: []
comment:
format: markdown
raw: Lorem ipsum dolor sit amet.
html: Lorem ipsum dolor sit amet.
createdAt: '2014-05-21T09:51:22.769Z'
updatedAt: '2014-05-21T10:14:02.927Z'
version: 2
Available_projects_for_work_packageModel:
type: object
example:
_links:
self:
href: /api/v3/work_packages/5/available_projects
_type: Collection
total: 2
count: 2
_embedded:
elements:
- _type: Project
_links:
self:
href: /api/v3/projects/6
title: A project
editWorkPackage:
href: /api/v3/work_packages/{id}/form
templated: true
method: post
createWorkPackage:
href: /api/v3/projects/6/work_packages/form
method: post
createWorkPackageImmediate:
href: /api/v3/projects/6/work_packages
method: post
categories:
href: /api/v3/projects/6/categories
versions:
href: /api/v3/projects/6/versions
id: 6
identifier: a_project
name: A project
description: Eveniet molestias omnis quis aut qui eum adipisci. Atque aut aut in exercitationem adipisci amet. Nisi asperiores quia ratione veritatis enim exercitationem magnam. Aut fuga architecto adipisci nihil. Et repellat pariatur. Aliquam et sed perferendis nostrum quaerat. Fugit doloremque voluptatem.
createdAt: '2015-07-06T13:28:14+00:00'
updatedAt: '2015-10-01T09:55:02+00:00'
type: Customer Project
- _type: Project
_links:
self:
href: /api/v3/projects/14
title: Another project
createWorkPackage:
href: /api/v3/projects/14/work_packages/form
method: post
createWorkPackageImmediate:
href: /api/v3/projects/14/work_packages
method: post
categories:
href: /api/v3/projects/14/categories
versions:
href: /api/v3/projects/14/versions
id: 14
identifier: another_project
name: Another project
description: ''
createdAt: '2016-02-29T12:50:20+00:00'
updatedAt: '2016-02-29T12:50:20+00:00'
type: null
Available_AssigneesModel:
allOf:
- $ref: '#/components/schemas/CollectionModel'
- type: object
required:
- _links
- _embedded
properties:
_links:
type: object
required:
- self
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The available assignees collection
**Resource**: AvailableAssigneesCollection'
readOnly: true
_embedded:
type: object
properties:
elements:
type: array
readOnly: true
items:
allOf:
- $ref: '#/components/schemas/UserModel'
- description: Collection of Users
PaginatedCollectionModel:
allOf:
- $ref: '#/components/schemas/CollectionModel'
- type: object
required:
- pageSize
- offset
properties:
pageSize:
type: integer
description: Amount of elements that a response will hold.
minimum: 0
offset:
type: integer
description: The page number that is requested from paginated collection.
minimum: 1
_links:
type: object
required:
- jumpTo
- changeSize
properties:
jumpTo:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Templated link to another page offset.
**Resource**: Collection'
changeSize:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Templated link for another page size.
**Resource**: Collection'
WorkPackageSchemaModel:
type: object
description: 'A schema for a work package. This schema defines the attributes of a work package.
TODO: Incomplete, needs to be updated with the real behaviour of schemas (when does which attribute appear?).'
properties:
_type:
type: string
enum:
- Schema
_dependencies:
type: array
items:
type: string
description: TBD
_attributeGroups:
type: array
items:
type: object
description: TBD (WorkPackageFormAttributeGroup)
lockVersion:
$ref: '#/components/schemas/SchemaPropertyModel'
id:
$ref: '#/components/schemas/SchemaPropertyModel'
subject:
$ref: '#/components/schemas/SchemaPropertyModel'
description:
$ref: '#/components/schemas/SchemaPropertyModel'
duration:
$ref: '#/components/schemas/SchemaPropertyModel'
scheduleManually:
$ref: '#/components/schemas/SchemaPropertyModel'
ignoreNonWorkingDays:
$ref: '#/components/schemas/SchemaPropertyModel'
startDate:
$ref: '#/components/schemas/SchemaPropertyModel'
dueDate:
$ref: '#/components/schemas/SchemaPropertyModel'
derivedStartDate:
$ref: '#/components/schemas/SchemaPropertyModel'
derivedDueDate:
$ref: '#/components/schemas/SchemaPropertyModel'
estimatedTime:
$ref: '#/components/schemas/SchemaPropertyModel'
derivedEstimatedTime:
$ref: '#/components/schemas/SchemaPropertyModel'
remainingTime:
$ref: '#/components/schemas/SchemaPropertyModel'
derivedRemainingTime:
$ref: '#/components/schemas/SchemaPropertyModel'
percentageDone:
$ref: '#/components/schemas/SchemaPropertyModel'
derivedPercentageDone:
$ref: '#/components/schemas/SchemaPropertyModel'
readonly:
$ref: '#/components/schemas/SchemaPropertyModel'
createdAt:
$ref: '#/components/schemas/SchemaPropertyModel'
updatedAt:
$ref: '#/components/schemas/SchemaPropertyModel'
author:
$ref: '#/components/schemas/SchemaPropertyModel'
position:
$ref: '#/components/schemas/SchemaPropertyModel'
project:
$ref: '#/components/schemas/SchemaPropertyModel'
projectPhase:
$ref: '#/components/schemas/SchemaPropertyModel'
projectPhaseDefinition:
$ref: '#/components/schemas/SchemaPropertyModel'
parent:
$ref: '#/components/schemas/SchemaPropertyModel'
sprint:
$ref: '#/components/schemas/SchemaPropertyModel'
storyPoints:
$ref: '#/components/schemas/SchemaPropertyModel'
assignee:
$ref: '#/components/schemas/SchemaPropertyModel'
responsible:
$ref: '#/components/schemas/SchemaPropertyModel'
type:
$ref: '#/components/schemas/SchemaPropertyModel'
status:
$ref: '#/components/schemas/SchemaPropertyModel'
category:
$ref: '#/components/schemas/SchemaPropertyModel'
version:
$ref: '#/components/schemas/SchemaPropertyModel'
priority:
$ref: '#/components/schemas/SchemaPropertyModel'
_links:
type: object
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This work package schema
**Resource**: Schema'
WorkPackagePatchModel:
allOf:
- $ref: '#/components/schemas/WorkPackageWriteModel'
- type: object
required:
- lockVersion
properties:
lockVersion:
type: integer
description: The version of the item as used for optimistic locking
Formattable:
type: object
required:
- format
properties:
format:
type: string
enum:
- plain
- markdown
- custom
readOnly: true
description: Indicates the formatting language of the raw text
example: markdown
raw:
type: string
description: The raw text, as entered by the user
example: I **am** formatted!
html:
type: string
readOnly: true
description: The text converted to HTML according to the format
example: I am formatted!
example:
format: markdown
raw: I am formatted!
html: I am formatted!
ReminderModel:
type: object
properties:
id:
type: integer
description: Reminder id
readOnly: true
minimum: 1
note:
type: string
description: The note of the reminder
remindAt:
type: string
format: date-time
description: The date and time when the reminder is due
_links:
required:
- creator
- remindable
type: object
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This reminder
**Resource**: Reminder'
creator:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The person that created the reminder
**Resource**: User'
remindable:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The resource that the reminder is associated with
**Resource**: WorkPackage'
OAuthApplicationReadModel:
type: object
required:
- id
- _type
- name
- clientId
- confidential
- _links
properties:
id:
type: integer
minimum: 1
_type:
type: string
enum:
- OAuthApplication
name:
type: string
description: The name of the OAuth 2 application
clientId:
type: string
description: OAuth 2 client id
clientSecret:
type: string
description: OAuth 2 client secret. This is only returned when creating a new OAuth application.
confidential:
type: boolean
description: true, if OAuth 2 credentials are confidential, false, if no secret is stored
createdAt:
type: string
format: date-time
description: The time the OAuth 2 Application was created at
updatedAt:
type: string
format: date-time
description: The time the OAuth 2 Application was last updated
scopes:
type: array
description: An array of the scopes of the OAuth 2 Application
items:
type: string
_links:
type: object
required:
- self
- owner
- redirectUri
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This OAuth application
**Resource**: OAuthApplication'
owner:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The user that created the OAuth application.
**Resource**: User'
integration:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The resource that integrates this OAuth application into itself. Currently, only `Storage` resources are
able to create and maintain own OAuth application.
**Resource**: Storage'
redirectUri:
type: array
items:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A redirect URI of the OAuth application
**Resource**: N/A'
example:
id: 1337
_type: OAuthApplication
name: Vader's secure OAuth app
clientId: O5h6WObhMg1Z8IcLHRE3_LMh4jJYmmca2V6OTFSv8DA
confidential: true
createdAt: '2022-12-07T12:56:42.626Z'
updatedAt: '2022-12-07T12:56:42.626Z'
scopes:
- api_v3
_links:
self:
href: /api/v3/oauth_applications/1337
owner:
href: /api/v3/users/13
title: Darth Vader
integration:
href: /api/v3/storages/42
title: Death Star Cloud
redirectUri:
- href: https://death-star.cloud.tools/index.php/apps/integration_openproject/oauth-redirect
FileLinkOriginDataModel:
type: object
required:
- id
- name
properties:
id:
type: string
description: Linked file's id on the origin
name:
type: string
description: Linked file's name on the origin
mimeType:
type: string
minLength: 0
description: 'MIME type of the linked file.
To link a folder entity, the custom MIME type `application/x-op-directory` MUST be provided. Otherwise it defaults back to
an unknown MIME type.'
size:
type: integer
minimum: 0
description: file size on origin in bytes
createdAt:
type: string
format: date-time
description: Timestamp of the creation datetime of the file on the origin
lastModifiedAt:
type: string
format: date-time
description: Timestamp of the datetime of the last modification of the file on the origin
createdByName:
type: string
description: Display name of the author that created the file on the origin
lastModifiedByName:
type: string
description: Display name of the author that modified the file on the origin last
OAuthClientCredentialsReadModel:
type: object
required:
- id
- _type
- clientId
- confidential
- _links
properties:
id:
type: integer
minimum: 1
_type:
type: string
enum:
- OAuthClientCredentials
clientId:
type: string
description: OAuth 2 client id
confidential:
type: boolean
description: true, if OAuth 2 credentials are confidential, false, if no secret is stored
createdAt:
type: string
format: date-time
description: The time the OAuth client credentials were created at
updatedAt:
type: string
format: date-time
description: The time the OAuth client credentials were last updated
_links:
type: object
required:
- self
- integration
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This OAuth Client Credentials object
**Resource**: OAuthClientCredentials'
integration:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The resource that integrates this OAuth client credentials. Currently, only `Storage` resources are
able to contain OAuth client credentials.
**Resource**: Storage'
example:
id: 1337
_type: OAuthClientCredentials
clientId: O5h6WObhMg1Z8IcLHRE3_LMh4jJYmmca2V6OTFSv8DA
confidential: true
createdAt: '2022-12-07T12:56:42.836Z'
updatedAt: '2022-12-07T12:56:42.836Z'
_links:
self:
href: /api/v3/oauth_client_credentials/1337
integration:
href: /api/v3/storages/42
title: Death Star Cloud
WatchersModel:
allOf:
- $ref: '#/components/schemas/CollectionModel'
- type: object
required:
- _links
- _embedded
properties:
_links:
type: object
required:
- self
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The watcher list
**Resource**: WatchersModel'
readOnly: true
_embedded:
type: object
properties:
elements:
type: array
readOnly: true
items:
allOf:
- $ref: '#/components/schemas/UserModel'
- description: Collection of Users
example:
_links:
self:
href: /api/v3/work_packages/14/watchers
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _type: User
_links:
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
showUser:
href: /users/1
type: text/html
lock:
href: /api/v3/users/1/lock
title: Set lock on j.sheppard
method: POST
delete:
href: /api/v3/users/1
title: Delete j.sheppard
method: DELETE
id: 1
login: j.sheppard
firstName: John
lastName: Sheppard
name: John Sheppard
mail: shep@mail.com
avatar: https://example.org/users/1/avatar
status: active
createdAt: '2014-05-21T08:51:20.396Z'
updatedAt: '2014-05-21T08:51:20.396Z'
- _type: User
_links:
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
lock:
href: /api/v3/users/2/lock
title: Set lock on j.sheppard2
method: POST
delete:
href: /api/v3/users/2
title: Delete j.sheppard2
method: DELETE
id: 2
login: j.sheppard2
firstName: Jim
lastName: Sheppard
name: Jim Sheppard
mail: shep@mail.net
avatar: https://example.org/users/1/avatar
status: active
createdAt: '2014-05-21T08:51:20.396Z'
updatedAt: '2014-05-21T08:51:20.396Z'
FileLinkCollectionReadModel:
allOf:
- $ref: '#/components/schemas/PaginatedCollectionModel'
- type: object
properties:
_links:
type: object
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This file links collection
**Resource**: FileLinkCollectionReadModel'
_embedded:
type: object
properties:
elements:
type: array
items:
$ref: '#/components/schemas/FileLinkReadModel'
example:
_type: Collection
total: 2
count: 2
pageSize: 30
offset: 1
_links:
self:
href: /api/v3/work_packages/42/file_links
jumpTo:
href: /api/v3/work_packages/42/file_links?offset=%7Boffset%7D&pageSize=30
templated: true
changeSize:
href: /api/v3/work_packages/42/file_links?offset=1&pageSize=%7Bsize%7D
templated: true
_embedded:
elements:
- id: 1337
_type: FileLink
createdAt: '2021-12-20T13:37:00.211Z'
updatedAt: '2021-12-20T13:37:00.211Z'
originData:
id: '5503'
name: logo.png
mimeType: image/png
size: 16042
createdAt: '2021-12-19T09:42:10.170Z'
lastModifiedAt: '2021-12-20T14:00:13.987Z'
createdByName: Luke Skywalker
lastModifiedByName: Anakin Skywalker
_links:
self:
href: /api/v3/work_package/17/file_links/1337
title: file link
storage:
href: /api/v3/storage/42
title: storage
container:
href: /api/v3/work_package/17
title: work package
creator:
href: /api/v3/users/33
title: Obi-Wan Kenobi
delete:
href: /api/v3/work_package/17/file_links/1337
method: delete
originOpen:
href: https://nextcloud.deathstar.rocks/index.php/f?fileid=5503
staticOriginOpen:
href: /api/v3/work_package/17/file_links/1337/open
- _hint: File Link resource shortened for brevity
id: 1338
ErrorResponse:
type: object
required:
- _type
- errorIdentifier
- message
properties:
_embedded:
type: object
properties:
details:
type: object
properties:
attribute:
type: string
example: project
_type:
type: string
enum:
- Error
errorIdentifier:
type: string
example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message:
type: string
example: Project can't be blank.
ActivityCommentWriteModel:
type: object
properties:
comment:
type: object
properties:
raw:
type: string
description: The raw content of the comment
internal:
type: boolean
description: 'Determines whether this comment is internal. This is only available to users
with `add_internal_comments` permission. It defaults to `false`, if unset.'
default: false
example:
comment:
raw: I think this is awesome!
Available_WatchersModel:
type: object
example:
_links:
self:
href: /api/v3/work_packages/1/available_watchers
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _type: User
_links:
self:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
lock:
href: /api/v3/users/1/lock
title: Set lock on j.sheppard
method: POST
delete:
href: /api/v3/users/1
title: Delete j.sheppard
method: DELETE
id: 1
login: j.sheppard
firstName: John
lastName: Sheppard
email: shep@mail.com
avatar: https://example.org/users/1/avatar
status: active
createdAt: '2014-05-21T08:51:20.286Z'
updatedAt: '2014-05-21T08:51:20.286Z'
- _type: User
_links:
self:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard2
lock:
href: /api/v3/users/2/lock
title: Set lock on j.sheppard2
method: POST
delete:
href: /api/v3/users/2
title: Delete j.sheppard2
method: DELETE
id: 2
login: j.sheppard2
firstName: Jim
lastName: Sheppard
email: shep@mail.net
avatar: https://example.org/users/1/avatar
status: active
createdAt: '2014-05-21T08:51:20.286Z'
updatedAt: '2014-05-21T08:51:20.286Z'
FileLinkWriteModel:
type: object
required:
- originData
- _links
properties:
originData:
$ref: '#/components/schemas/FileLinkOriginDataModel'
_links:
oneOf:
- type: object
required:
- storage
properties:
storage:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The storage resource of the linked file.
**Resource**: Storage'
- type: object
required:
- storageUrl
properties:
storageUrl:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'The storage url the file link references to.
**Resource**: N/A'
example:
originData:
id: '5503'
name: logo.png
mimeType: image/png
size: 16042
createdAt: '2021-12-19T09:42:10.170Z'
lastModifiedAt: '2021-12-20T14:00:13.987Z'
createdByName: Luke Skywalker
lastModifiedByName: Anakin Skywalker
_links:
storageUrl:
href: https://nextcloud.my-deathstar.org
Available_relation_candidatesModel:
type: object
example:
_links:
self:
href: /api/v3/projects/14/work_packages
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _type: WorkPackage
_links:
self:
href: /api/v3/work_packages/1
id: 1
subject: Skipped other properties for brevity
- _type: WorkPackage
_links:
self:
href: /api/v3/work_packages/2
id: 2
subject: Skipped other properties for brevity
WorkPackageFormModel:
type: object
description: 'The work package creation form. This object is returned, whenever a work package form endpoint is called. It contains
an allowed payload definition, the full schema and any validation errors on the current request body.'
properties:
_type:
type: string
enum:
- Form
_embedded:
type: object
properties:
payload:
$ref: '#/components/schemas/WorkPackageWriteModel'
schema:
$ref: '#/components/schemas/WorkPackageSchemaModel'
validationErrors:
type: object
description: 'All validation errors, where the key is the faulty property. The object is empty, if the request body is
valid.'
_links:
type: object
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This form endpoint
**Resource** : Form'
validate:
allOf:
- $ref: '#/components/schemas/Link'
- description: The endpoint for validating the request bodies. Often referring to this very form endpoint.
previewMarkup:
allOf:
- $ref: '#/components/schemas/Link'
- description: Renders a markup preview for the work package form.
customFields:
allOf:
- $ref: '#/components/schemas/Link'
- description: Link to the HTML page for the custom field definitions.
configureForm:
allOf:
- $ref: '#/components/schemas/Link'
- description: Link to the HTML page for the form configuration.
UserModel:
allOf:
- $ref: '#/components/schemas/PrincipalModel'
- $ref: '#/components/schemas/CustomFieldProperties'
- type: object
required:
- _type
- avatar
properties:
_type:
type: string
enum:
- User
avatar:
type:
- string
- 'null'
format: uri
description: URL to user's avatar
login:
type: string
description: 'The user''s login name
# Conditions
- User is self, or `create_user` or `manage_user` permission globally'
maxLength: 256
firstName:
type: string
description: 'The user''s first name
# Conditions
- User is self, or `create_user` or `manage_user` permission globally'
maxLength: 30
lastName:
type: string
description: 'The user''s last name
# Conditions
- User is self, or `create_user` or `manage_user` permission globally'
maxLength: 30
email:
type: string
description: 'The user''s email address
# Conditions
- E-Mail address not hidden
- User is not a new record
- User is self, or `create_user` or `manage_user` permission globally'
maxLength: 60
admin:
type: boolean
description: 'Flag indicating whether or not the user is an admin
# Conditions
- `admin`'
status:
type: string
description: 'The current activation status of the user.
# Conditions
- User is self, or `create_user` or `manage_user` permission globally'
language:
type: string
description: 'User''s language | ISO 639-1 format
# Conditions
- User is self, or `create_user` or `manage_user` permission globally'
identityUrl:
type:
- string
- 'null'
description: 'User''s identity_url for OmniAuth authentication.
**Deprecated:** It will be removed in the near future.
# Conditions
- User is self, or `create_user` or `manage_user` permission globally'
deprecated: true
createdAt:
type: string
format: date-time
description: Time of creation
updatedAt:
type: string
format: date-time
description: Time of the most recent change to the user
_links:
type: object
properties:
showUser:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A relative path to show the user in the web application.
# Condition
- User is not a new record
- User is not `locked`'
updateImmediately:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'A link to update the user resource.
# Conditions
- `admin`'
lock:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Restrict the user from logging in and performing any actions.
# Conditions
- User is not locked
- `admin`'
unlock:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Allow a locked user to login and act again.
# Conditions
- User is not locked
- `admin`'
delete:
allOf:
- $ref: '#/components/schemas/Link'
- description: "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n - `admin`\n - Setting `users_deletable_by_admin` is set\nor:\n - User is self\n - Setting `users_deletable_by_self` is set"
authSource:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'Permanently remove a user from the instance
# Conditions
- LDAP authentication configured
- `admin`'
RevisionsModel:
type: object
example:
_links:
self:
href: /api/v3/work_packages/42/revisions
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _type: Revision
_links:
self:
href: /api/v3/revisions/13
project:
href: /api/v3/projects/1
title: A Test Project
author:
href: /api/v3/users/1
title: John Sheppard - j.sheppard
showRevision:
href: /projects/identifier/repository/revision/11f4b07
id: 13
identifier: 11f4b07dff4f4ce9548a52b7d002daca7cd63ec6
formattedIdentifier: 11f4b07
authorName: John Sheppard
message:
format: plain
raw: 'This revision provides new features
An elaborate description'
html: This revision provides new features
An elaborate description
createdAt: '2015-07-21T13:36:59.201Z'
- _type: Revision
_links:
self:
href: /api/v3/revisions/14
project:
href: /api/v3/projects/1
title: A Test Project
author:
href: /api/v3/users/2
title: Jim Sheppard - j.sheppard
showRevision:
href: /projects/identifier/repository/revision/029ed72a
id: 13
identifier: 029ed72a3b7b7c4ab332b1f6eaa6576e7c946059
formattedIdentifier: 029ed72a
authorName: j1msheppard
message:
format: plain
raw: 'This revision fixes some stuff
More information here'
html: This revision fixes some stuff
More information here
createdAt: '2015-06-30T08:47:00.548Z'
CustomFieldProperties:
type: object
patternProperties:
^customField\d+$:
type:
- 'null'
- number
- boolean
- string
- object
description: 'A custom field value, that belongs to a custom field of a simple type:
- Boolean
- Date
- Float
- Integer
- Link (URL)
- Text
- Long text'
responses:
MissingContentType:
description: Occurs when the client did not send a Content-Type header
content:
text/plain:
schema:
type: string
example: Missing content-type header
UnsupportedMediaType:
description: Occurs when the client sends an unsupported Content-Type header.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:TypeNotSupported
message: Expected CONTENT-TYPE to be (expected value) but got (actual value).
InvalidRequestBody:
description: Occurs when the client did not send a valid JSON object in the request body.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
message: The request body was not a single JSON object.
examples:
WorkPackageCreateValid:
description: A valid request body to create or edit a work package with a couple of properties.
value:
subject: Install Dromund Kass planetary shield
description:
format: markdown
raw: '# TODO
The planetary shield of Dromund Kass needs to be installed to protect the planet from orbital bombardment.'
startDate: '2877-07-21'
duration: P1337D
estimatedTime: P370DT13H
ignoreNonWorkingDays: true
project:
href: /api/v3/projects/42
type:
href: /api/v3/types/13
status:
href: /api/v3/statuses/2
WorkPackageCreateOnlySubject:
description: 'A request body to create a work package with only a subject. This can only be used, if the project context is already
given in the path. All other values will fall back to defaults.'
value:
subject: Replace GNK power droids
WorkPackageEditSubject:
description: A request body to edit a work package's subject.
value:
subject: Replace GNK power droids
WorkPackageWithMetaValidation:
description: A request body to edit a work package with custom field validation enabled via the _meta object.
value:
subject: Replace GNK power droids
lockVersion: 42
_meta:
validateCustomFields: true
securitySchemes:
BasicAuth:
type: http
scheme: basic