API: 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

Methods

View wiki page

Retrieve an individual wiki page as identified by the id parameter

id
integer

required path

Wiki page identifier

Example:
1

200

{
  "_embedded": {
    "project": {
      "_type": "Project...",
      "id": 12
    }
  },
  "_links": {
    "addAttachment": {
      "href": "/api/v3/wiki_pages/72/attachments",
      "method": "post"
    },
    "attachments": {
      "href": "/api/v3/wiki_pages/72/attachments"
    },
    "project": {
      "href": "/api/v3/projects/12",
      "title": "some project"
    },
    "self": {
      "href": "/api/v3/wiki_pages/72"
    }
  },
  "_type": "WikiPage",
  "id": 72,
  "title": "A wiki page with a name"
}

Wiki_PageModel

{
  "type": "object",
  "required": [
    "title"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier of this wiki page",
      "readOnly": true,
      "exclusiveMinimum": 0
    },
    "title": {
      "type": "string",
      "description": "The wiki page's title"
    },
    "_links": {
      "type": "object",
      "properties": {
        "addAttachment": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "Attach a file to the wiki page\n\n# Conditions\n\n**Permission**: edit wiki page",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "example": {
    "_type": "WikiPage",
    "id": 72,
    "title": "A wiki page with a name",
    "_embedded": {
      "project": {
        "_type": "Project...",
        "id": 12
      }
    },
    "_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"
      }
    }
  }
}

404

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

{
  "_type": "Error",
  "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
  "message": "The requested resource could not be found."
}

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."
    }
  }
}