OpenProject

OpenProject Values::Property API

`Values::Property` represents a single key - value pair. That pair typically is an excerpt of the properties of a resource. `Values::Property` itself is not an independent resource. It will always be nested and as such will only exist as part of another resource. It is currently used e.g. in the Notification resource. ## Linked Properties | Property | Description | Type | Constraints | Supported operations | Condition | | :--------------: | ----------------------------| ----------- | --------------------- | -------------------- | ------------------------- | | self | This value | Values::Property | not null | READ | | | schema | This value's schema | Schema | not null | READ | | ## Local Properties | Property | Description | Type | Constraints | Supported operations | Condition | | :--------------: | ------------------------------------------------------ | ----------- | -------------- | -------------------- | ---------------------------- | | property | The pairs' key name | String | not null | READ | | | value | The pairs' value | Polymorphic | | READ | |

Documentation GitHub OpenAPI

Operations 2

GET /api/v3/notifications/{notification_id}/details/{id} Get a notification detail #

GET /api/v3/values/schema/{id} View Values schema #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/openproject-values-property-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Values::Property 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: '`Values::Property` represents a single key - value pair.'
  name: Values::Property
paths:
  /api/v3/notifications/{notification_id}/details/{id}:
    get:
      summary: Get a notification detail
      operationId: view_notification_detail
      tags:
      - Values::Property
      description: Returns an individual detail of a notification identified by the notification id and the id of the detail.
      parameters:
      - name: notification_id
        in: path
        description: notification id
        example: 1
        required: true
        schema:
          type: integer
      - name: id
        in: path
        description: detail id
        example: 0
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ValuesPropertyModel'
              examples:
                Start date notification detail:
                  $ref: '#/components/examples/ValuesPropertyStartDate'
                Due date notification detail:
                  $ref: '#/components/examples/ValuesPropertyDueDate'
                Date notification detail for milestone work package:
                  $ref: '#/components/examples/ValuesPropertyDate'
          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 requested resource could not be found.
          description: 'Returned if the notification or the detail of it does not exist or if the user does not have permission to view it.


            **Required permission** being recipient of the notification'
  /api/v3/values/schema/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: 'The identifier of the value. This is typically the value of the `property` property of

          the `Values` resource. It should be in lower camelcase format.'
        example: startDate
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/SchemaModel'
              examples:
                Values::Property Start date schema:
                  $ref: '#/components/examples/ValuesPropertyStartDateSchema'
                Values::Property Due date schema:
                  $ref: '#/components/examples/ValuesPropertyDueDateSchema'
                Values::Property Date schema for Milestone work package:
                  $ref: '#/components/examples/ValuesPropertyDateSchema'
          description: OK
          headers: {}
        '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 schema does not exist.
        '400':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:BadRequest
                message: 'Bad request: property is invalid'
          description: Returned if the requested property id is not in a lower camel case format.
      tags:
      - Values::Property
      description: The schema of a `Values` resource.
      operationId: View_values_schema
      summary: View Values schema
components:
  examples:
    ValuesPropertyStartDate:
      value:
        _type: Values::Property
        property: startDate
        value: '2021-01-01'
        _links:
          self:
            href: api/v3/notifications/123/details/0
          schema:
            href: api/v3/values/schemas/startDate
    ValuesPropertyDueDateSchema:
      value:
        _type: Schema
        property:
          name: Property
          type: String
        value:
          name: Due date
          type: Date
        _links:
          self:
            href: api/v3/values/schemas/dueDate
    ValuesPropertyStartDateSchema:
      value:
        _type: Schema
        property:
          name: Property
          type: String
        value:
          name: Start date
          type: Date
        _links:
          self:
            href: api/v3/values/schemas/startDate
    ValuesPropertyDate:
      value:
        _type: Values::Property
        property: date
        value: '2021-01-01'
        _links:
          self:
            href: api/v3/notifications/123/details/0
          schema:
            href: api/v3/values/schemas/date
    ValuesPropertyDateSchema:
      value:
        _type: Schema
        property:
          name: Property
          type: String
        value:
          name: Date
          type: Date
        _links:
          self:
            href: api/v3/values/schemas/date
    ValuesPropertyDueDate:
      value:
        _type: Values::Property
        property: dueDate
        value: '2021-01-01'
        _links:
          self:
            href: api/v3/notifications/123/details/0
          schema:
            href: api/v3/values/schemas/dueDate
  schemas:
    SchemaModel:
      type: object
      required:
      - _type
      - _links
      properties:
        _type:
          type: string
          enum:
          - Schema
        _dependencies:
          type: array
          description: A list of dependencies between one property's value and another property
          items:
            type: string
        _links:
          type: object
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This schema


                  **Resource**: Schema'
    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
    ValuesPropertyModel:
      type: object
      required:
      - _type
      - property
      - value
      - _links
      properties:
        _type:
          type: string
          enum:
          - Values::Property
        property:
          type: string
          description: The key of the key - value pair represented by the Values::Property
        value:
          type: string
          description: The value of the key - value pair represented by the Values::Property
        _links:
          type: object
          required:
          - self
          - schema
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This key - value pair.


                  **Resource**: Storage'
            schema:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The schema describing the key - value pair.


                  **Resource**: Schema'
    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.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic