Wiki Pages
Represents an individual page in a project’s wiki.
This resource is currently a stub
Actions
Link | Description | Condition |
---|---|---|
addAttachment | Attach a file to the wiki page | Permission: edit wiki page |
Linked Properties
Property | Description | Type | Constraints | Supported operations |
---|---|---|---|---|
self | This wiki page | WikiPage | not null | READ |
attachments | The files attached to this wiki page | Collection | READ | |
project | The project the wiki page belongs to | Project | not null | READ |
Local Properties
Property | Description | Type | Constraints | Supported operations |
---|---|---|---|---|
id | Identifier of this wiki page | Integer | x > 0 | READ |
title | The wiki page’s title | String | not null | READ |
Wiki Page
View Wiki Page
Retrieve an individual wiki page as identified by the id parameter
- Parameters
- id
integer
(required) Example: 1Wiki page identifier
- Response
200
Toggle details Headers
Content-Type: application/hal+json
Body
{ "_type": "WikiPage", "id": 72, "title": "A wiki page with a name", "_embedded": { "project": { "_type": "Project", "id": 12, <-- abbreviated --> } } }, "_links": { "self": { "href": "/api/v3/wiki_pages/72" }, "attachments": { "href": "/api/v3/wiki_pages/72/attachments" }, "addAttachment": { "href": "/api/v3/wiki_pages/72/attachments", "method": "post" }, "project": { "href": "/api/v3/projects/12", "title": "some project" } } }
- Response
404
Toggle details Returned if the wiki page does not exist or the client does not have sufficient permissions to see it.
Required permission: view wiki page in the page’s project
Headers
Content-Type: application/hal+json
Body
{ "_type": "Error", "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound", "message": "The requested resource could not be found." }
Help and feedback
If you did not find what you were looking for
If you need help from the community or want to support others
If you are eligible for professional support and have more questions
REQUEST SUPPORT
If you find an easily fixable error or need for improvement in the documentation for the stable release
If you would like to suggest bigger updates or improvements to this documentation
If you want to contribute to translate this documentation to another language
If there's something you don't like or understand about this feature
If you want to propose a new feature that OpenProject does not offer yet
To further help OpenProject to shape and test new features
To view OpenProject premium features and pricing
If you want to try all premium features in the OpenProject Cloud Edition 14 days for free
If you want to try all premium features in your on premise Community installation 14 days for free