OpenProject Programs API

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 Programs 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: "Programs are one of the types of [workspaces](https://www.openproject.org/docs/api/endpoints/workspaces) in OpenProject structuring the information \n(e.g. work packages, wikis) into smaller sets. They are typically used to group, structure and manage projects that \ntarget similar strategic goals of the organization and belong to a portfolio. \n\nAs containers, they also control behaviour of the elements within them. One of the most important aspects of this is that programs limit permissions by having members with a certain permission set (roles) assigned to them.\n\n## Actions\n\n| Link                         | Description                                                          | Condition                                                                                    |\n|:--------------------------:  |----------------------------------------------------------------------| ---------------------------------                                                            |\n| update                       | Form endpoint that aids in updating this program                     | **Permission**: edit workspace                                                               |\n| updateImmediately            | Directly update this program                                         | **Permission**: edit workspace                                                               |\n| delete                       | Delete this program                                                  | **Permission**: admin                                                                        |\n| favor                        | Mark this program as favorited by the current user                   | **Permission**: none but login is required, only present if the program is not yet favorited |\n| disfavor                     | Mark this program as no longer favorited by the current user         | **Permission**: none but login is required, only present if the program is favorited         |\n| createWorkPackage            | Form endpoint that aids in preparing and creating a work package     | **Permission**: add work packages                                                            |\n| createWorkPackageImmediately | Directly creates a work package in the program                       | **Permission**: add work packages                                                            |\n\n## Linked Properties\n\n| Link         | Description                                                                                                     | Type          | Constraints | Supported operations |Condition                                                                                        |\n| :----------: | -------------                                                                                                   | ----          | ----------- | -------------------- |-----------------------------------------                                                        |\n| self         | This program                                                                                                    | Program       | not null    | READ                 |                                                                                                 |\n| ancestors    | Array of all ancestors of the program, down from the root node (first element) to the parent (last element).    | Collection    | not null    | READ                 | **Permission** view program on the ancestor program. Non visible programs will be omitted |\n| categories   | Categories available in this program                                                                            | Collection    | not null    | READ                 |                                                                                                 |\n| types        | Types available in this program                                                                                 | Collection    | not null    | READ                 | **Permission**: view work packages or manage types                                              |\n| versions     | Versions available in this program                                                                              | Collection    | not null    | READ                 | **Permission**: view work packages or manage versions                                           |\n| memberships  | Memberships in the program                                                                                      | Collection    | not null    | READ                 | **Permission**: view members                                                                    |\n| workPackages | Work Packages of this program                                                                                   | Collection    | not null    | READ                 |                                                                                                 |\n| parent       | Parent program of the program                                                                                   | Program       |             | READ/WRITE           | **Permission** edit workspace                                                                   |\n| status       | Denotes the status of the program, so whether the program is on track, at risk or is having trouble.            | ProgramStatus |             | READ/WRITE           | **Permission** edit workspace                                                                   |\n\nDepending on custom fields defined for programs, additional links might exist.\n\nNote, that the parent and ancestor links may contain the \"undisclosed uri\" `urn:openprogram-org:api:v3:undisclosed` in case an\nancestor program is defined but the client lacks permission to see it. See the\n[general introduction into links' properties](https://www.openproject.org/docs/api/basic-objects/#local-properties) for more information.\n\n## Local Properties\n\n| Property               | Description                                                                                         | Type              | Constraints                          | Supported operations |\n| :---------------------:| -------------                                                                                       | ----              | -----------                          | -------------------- |\n| id                     | Programs' id                                                                                        | Integer           | x > 0                                | READ/WRITE           |\n| identifier             |                                                                                                     | String            |                                      | READ/WRITE           |\n| name                   |                                                                                                     | String            |                                      | READ/WRITE           |\n| active                 | Indicates whether the program is currently active or already archived                               | Boolean           |                                      | READ/WRITE           |\n| favorited              | Indicates whether the program is favorited by the current user                                      | Boolean           |                                      | READ                 |\n| statusExplanation      | A text detailing and explaining why the program has the reported status                             | Formattable       |                                      | READ/WRITE           |\n| public                 | Indicates whether the program is accessible for everybody                                           | Boolean           |                                      | READ/WRITE           |\n| description            |                                                                                                     | Formattable       |                                      | READ/WRITE           |\n| createdAt              | Time of creation                                                                                    | DateTime          |                                      | READ                 |\n| updatedAt              | Time of the most recent change to the program                                                       | DateTime          |                                      | READ                 |\n\nDepending on custom fields defined for programs, additional properties might exist."
  name: Programs
paths:
  /api/v3/programs:
    get:
      summary: List programs
      operationId: list_programs
      tags:
      - Programs
      description: Returns a collection of programs. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain programs the client is allowed to see.
      parameters:
      - name: filters
        schema:
          type: string
        in: query
        required: false
        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:


          + active: based on the active property of the program

          + ancestor: filters programs by their ancestor. A program is not considered to be its own ancestor.

          + available_project_attributes: filters programs based on the activated project attributes.

          + created_at: based on the time the program was created

          + favorited: based on the favorited property of the program

          + id: based on programs'' id.

          + latest_activity_at: based on the time the last activity was registered on a program.

          + name_and_identifier: based on both the name and the identifier.

          + parent_id: filters programs by their parent.

          + principal: based on members of the program.

          + project_phase_any: based on the project phases active in a program.

          + project_status_code: based on status code of the program

          + storage_id: filters programs by linked storages

          + storage_url: filters programs by linked storages identified by the host url

          + type_id: based on the types active in a program.

          + user_action: based on the actions the current user has in the program.

          + visible: based on the visibility for the user (id) provided as the filter value. This filter is useful for admins to identify the programs visible to a user.


          There might also be additional filters based on the custom fields that have been configured.


          Each defined lifecycle step will also define a filter in this list endpoint. Given that the elements are not

          static but rather dynamically created on each OpenProject instance, a list cannot be provided. Those filters follow the schema:

          + project_start_gate_[id]: a filter on a project phase''s start gate active in a program. The id is the id of the phase the gate belongs to.

          + project_finish_gate_[id]: a filter on a project phase''s finish gate active in a program. The id is the id of the phase the gate belongs to.

          + project_phase_[id]: a filter on a project phase active in a program. The id is the id of the phase queried for.'
        example: '[{ "ancestor": { "operator": "=", "values": ["1"] }" }]'
      - name: sortBy
        schema:
          type: string
        in: query
        required: false
        description: 'JSON specifying sort criteria.

          Currently supported orders are:


          + id

          + name

          + typeahead (sorting by hierarchy and name)

          + created_at

          + public

          + latest_activity_at

          + required_disk_space


          There might also be additional orders based on the custom fields that have been configured.'
        example: '[["id", "asc"]]'
      - name: select
        schema:
          type: string
        in: query
        required: false
        description: Comma separated list of properties to include.
        example: total,elements/identifier,elements/name
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ProgramCollectionModel'
              examples:
                simple program collection:
                  $ref: '#/components/examples/ProgramCollection'
        '400':
          description: Returned if the client sends invalid request parameters e.g. filters
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
                message: Filters Invalid filter does not exist.
  /api/v3/programs/{id}:
    get:
      parameters:
      - description: Program id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ProgramModel'
          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 requested resource could not be found.
          description: 'Returned if the program does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** any permission in the program


            *Note: A client without sufficient permissions shall not be able to test for the existence of a program.

            That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
          headers: {}
      tags:
      - Programs
      description: ''
      operationId: View_program
      summary: View program
    patch:
      parameters:
      - description: Program id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProgramModel'
            examples:
              with custom fields:
                $ref: '#/components/examples/ProgramBody'
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ProgramModel'
              examples:
                with custom fields:
                  $ref: '#/components/examples/Program'
          description: OK
          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 authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** edit project for the program to be altered'
          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 requested resource could not be found.
          description: 'Returned if the program does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** view project


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a version. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
          headers: {}
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _embedded:
                      details:
                        attribute: name
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                    message: Name can't be blank.
          description: 'Returned if:


            * a constraint for a property was violated (`PropertyConstraintViolation`)'
          headers: {}
      tags:
      - Programs
      description: Updates the given program by applying the attributes provided in the body.
      operationId: Update_Program
      summary: Update Program
    delete:
      parameters:
      - description: Program id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: 'Returned if the program was successfully deleted. There is currently no endpoint to query for the actual deletion status.

            Such an endpoint _might_ be added in the future.'
          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:** admin'
          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 requested resource could not be found.
          description: 'Returned if the program does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** any permission in the program


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a version. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
          headers: {}
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _embedded:
                      details:
                        attribute: base
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                    message: Work packages in non descendant projects reference versions of the program or its descendants.
          description: 'Returned if the program cannot be deleted. This can happen when there are still references to the program in other workspaces

            that need to be severed at first.'
          headers: {}
      tags:
      - Programs
      description: 'Deletes the program permanently. As this is a lengthy process, the actual deletion is carried out asynchronously.

        So the program might exist well after the request has returned successfully. To prevent unwanted changes to

        the program scheduled for deletion, it is archived at once.'
      operationId: Delete_Program
      summary: Delete Program
  /api/v3/programs/{id}/form:
    post:
      parameters:
      - description: Program id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              with custom fields:
                $ref: '#/components/examples/ProgramBody'
              empty:
                description: Empty request to get the form initially in order to start the guided update of a program
                value: {}
      responses:
        '200':
          description: OK
          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 authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** edit workspace in the program'
          headers: {}
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
      tags:
      - Programs
      description: ''
      operationId: Program_update_form
      summary: Program update form
components:
  schemas:
    ProgramCollectionModel:
      allOf:
      - $ref: '#/components/schemas/OffsetPaginatedCollectionModel'
      - type: object
        required:
        - _links
        - _embedded
        properties:
          _links:
            allOf:
            - $ref: '#/components/schemas/OffsetPaginatedCollectionLinks'
            - type: object
              properties:
                representations:
                  type: array
                  items:
                    allOf:
                    - $ref: '#/components/schemas/Link'
                    - description: A program collection representation in a specific file format.
          _embedded:
            type: object
            required:
            - elements
            properties:
              elements:
                type: array
                items:
                  $ref: '#/components/schemas/ProgramModel'
    C

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-programs-api-openapi.yml