OpenProject Posts API

openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Posts 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: Represents a post in a board.
  name: Posts
paths:
  /api/v3/posts/{id}:
    get:
      parameters:
      - description: Post's identifier
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      project:
                        _type: Project...
                    _links:
                      addAttachment:
                        href: /api/v3/posts/1/attachments
                        method: post
                      attachments:
                        href: /api/v3/posts/1/attachments
                      project:
                        href: /api/v3/projects/1
                        title: A project with a title
                      self:
                        href: /api/v3/posts/1
                    _type: Post
                    id: 1
                    subject: A post with a subject
              schema:
                $ref: '#/components/schemas/PostModel'
          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 post does not exist or the client does not have sufficient permissions to see it.


            **Required permission:** view messages in the post''s project'
          headers: {}
      tags:
      - Posts
      description: Retrieve an individual post as identified by the id parameter
      operationId: View_Post
      summary: View Post
components:
  schemas:
    PostModel:
      type: object
      required:
      - subject
      properties:
        id:
          type: integer
          description: Identifier of this post
          readOnly: true
          exclusiveMinimum: 0
        subject:
          type: string
          description: The post's subject
        _links:
          type: object
          properties:
            addAttachment:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'Attach a file to the post


                  # Conditions


                  **Permission**: edit messages'
                readOnly: true
      example:
        _type: Post
        id: 1
        subject: A post with a subject
        _embedded:
          project:
            _type: Project...
        _links:
          self:
            href: /api/v3/posts/1
          attachments:
            href: /api/v3/posts/1/attachments
          addAttachment:
            href: /api/v3/posts/1/attachments
            method: post
          project:
            href: /api/v3/projects/1
            title: A project with a title
    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
    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