Share via

Pages - Get Page By Id

  • Reference
Service:
Wiki
API Version:
7.1-preview.1

Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the Accept header sent in the request.

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?api-version=7.1-preview.1
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?recursionLevel={recursionLevel}&includeContent={includeContent}&api-version=7.1-preview.1

URI Parameters

Name In Required Type Description
id
 path True

integer

int32

Wiki page ID.
organization
 path True

string

The name of the Azure DevOps organization.
project
 path True

string

Project ID or project name
wikiIdentifier
 path True

string

Wiki ID or wiki name..
api-version
 query True

string

Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
includeContent
 query

boolean

True to include the content of the page in the response for Json content type. Defaults to false (Optional)
recursionLevel
 query

VersionControlRecursionType

Recursion level for subpages retrieval. Defaults to None (Optional).

Responses

Name Type Description
200 OK

WikiPage

successful operation

Media Types: "application/zip", "text/plain", "application/json"

Headers

ETag: string

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.wiki Grants the ability to read wikis, wiki pages and wiki attachments. Also grants the ability to search wiki pages.

Examples

Get page as text
Get page by id as JSON
Get page by id as JSON with content
Get page by id as JSON with recursion level

Get page as text

Sample Request

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?api-version=7.1-preview.1

Sample Response

Status code:
200 
transfer-Encoding: chunked
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"

Get page by id as JSON

Sample Request

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?api-version=7.1-preview.1

Sample Response

Status code:
200 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
Response Body
{
  "path": "/SamplePage973",
  "order": 1,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": ""
}

Get page by id as JSON with content

Sample Request

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?includeContent=True&api-version=7.1-preview.1

Sample Response

Status code:
200 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
Response Body
{
  "path": "/SamplePage973",
  "order": 1,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": "Wiki page content"
}

Get page by id as JSON with recursion level

Sample Request

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages/{id}?recursionLevel=OneLevel&api-version=7.1-preview.1

Sample Response

Status code:
200 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
Response Body
{
  "path": "/SamplePage973",
  "order": 1,
  "isParentPage": true,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [
    {
      "path": "/SamplePage973/SubPage449",
      "order": 1,
      "gitItemPath": "/SamplePage973/SubPage449.md",
      "subPages": [],
      "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973%2FSubPage449",
      "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973%2FSubPage449"
    },
    {
      "path": "/SamplePage973/SubPage609",
      "order": 0,
      "gitItemPath": "/SamplePage973/SubPage609.md",
      "subPages": [],
      "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973%2FSubPage609",
      "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973%2FSubPage609"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": ""
}

Definitions

Name Description
VersionControlRecursionType

Recursion level for subpages retrieval. Defaults to None (Optional).
WikiPage

Defines a page in a wiki.

VersionControlRecursionType

Recursion level for subpages retrieval. Defaults to None (Optional).

Name Type Description
full

string

Return specified item and all descendants
none

string

Only return the specified item.
oneLevel

string

Return the specified item and its direct children.
oneLevelPlusNestedEmptyFolders

string

Return the specified item and its direct children, as well as recursive chains of nested child folders that only contain a single folder.

WikiPage

Defines a page in a wiki.

Name Type Description
content

string

Content of the wiki page.
gitItemPath

string

Path of the git item corresponding to the wiki page stored in the backing Git repository.
id

integer

When present, permanent identifier for the wiki page
isNonConformant

boolean

True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.
isParentPage

boolean

True if this page has subpages under its path.
order

integer

Order of the wiki page, relative to other pages in the same hierarchy level.
path

string

Path of the wiki page.
remoteUrl

string

Remote web url to the wiki page.
subPages

WikiPage[]

List of subpages of the current page.
url

string

REST url for this wiki page.