OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/api/apiv3/paths/post.yml

59 lines
1.6 KiB

# /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/post_model.yml"
description: OK
headers: {}
'404':
content:
application/hal+json:
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