Udostępnij za pośrednictwem

Pages - Get Page

  • Odwołanie
Usługa:
Wiki
Wersja interfejsu API:
7.1

Pobiera metadane lub zawartość strony typu wiki dla podanej ścieżki. Negocjowanie zawartości odbywa się na podstawie nagłówka Accept wysłanego w żądaniu.

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?api-version=7.1
Z parametrami opcjonalnymi: 
GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&recursionLevel={recursionLevel}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&api-version=7.1

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
 path True

string

Nazwa organizacji usługi Azure DevOps.
project
 path True

string

Identyfikator projektu lub nazwa projektu
wikiIdentifier
 path True

string

Identyfikator witryny typu wiki lub nazwa witryny typu wiki.
api-version
 query True

string

Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
includeContent
 query

boolean

Wartość True, aby uwzględnić zawartość strony w odpowiedzi dla typu zawartości Json. Wartości domyślne to false (opcjonalnie)
path
 query

string

Ścieżka strony typu wiki.
recursionLevel
 query

VersionControlRecursionType

Poziom rekursji dla pobierania podstron. Wartość domyślna to None (opcjonalnie).
versionDescriptor.version
 query

string

Identyfikator ciągu wersji (nazwa tagu/gałęzi, SHA1 zatwierdzenia)
versionDescriptor.versionOptions
 query

GitVersionOptions

Opcje wersji — określ dodatkowe modyfikatory do wersji (np. Poprzednie)
versionDescriptor.versionType
 query

GitVersionType

Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak identyfikator jest interpretowany

Odpowiedzi

Nazwa Typ Opis
200 OK

WikiPage

operacja zakończona powodzeniem

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

Nagłówki

ETag: string

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa Opis
vso.wiki Umożliwia odczytywanie stron typu wiki, stron typu wiki i załączników typu wiki. Ponadto umożliwia wyszukiwanie stron typu wiki.

Przykłady

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

Get page as JSON

Przykładowe żądanie

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=/SamplePage973&api-version=7.1

Przykładowa odpowiedź

Kod stanu:
200 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
{
  "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 as JSON with content

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"
{
  "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 as JSON with recursion level

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
eTag: "566070412a9a28ded41d443a39b3addf76b27453"
{
  "path": "/",
  "order": 0,
  "isParentPage": true,
  "gitItemPath": "/",
  "subPages": [
    {
      "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"
    },
    {
      "path": "/SamplePage99",
      "order": 4,
      "gitItemPath": "/SamplePage99.md",
      "subPages": [],
      "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage99",
      "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage99"
    },
    {
      "path": "/nhhm mjmj",
      "order": 3,
      "gitItemPath": "/nhhm-mjmj.md",
      "subPages": [],
      "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2Fnhhm%20mjmj",
      "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2Fnhhm%20mjmj"
    },
    {
      "path": "/test test test",
      "order": 0,
      "gitItemPath": "/test-test-test.md",
      "subPages": [],
      "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2Ftest%20test%20test",
      "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2Ftest%20test%20test"
    },
    {
      "path": "/test test",
      "order": 2,
      "gitItemPath": "/test-test.md",
      "subPages": [],
      "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2Ftest%20test",
      "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2Ftest%20test"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2F",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2F",
  "content": ""
}

Get page as text

Przykładowe żądanie

GET https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=/SamplePage973&api-version=7.1

Przykładowa odpowiedź

Kod stanu:
200 
transfer-Encoding: chunked
eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"

Definicje

Nazwa Opis
GitVersionOptions

Opcje wersji — określ dodatkowe modyfikatory do wersji (np. Poprzednie)
GitVersionType

Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak identyfikator jest interpretowany
VersionControlRecursionType

Poziom rekursji dla pobierania podstron. Wartość domyślna to None (opcjonalnie).
WikiPage

Definiuje stronę w witrynie typu wiki.

GitVersionOptions

Wyliczanie

Opcje wersji — określ dodatkowe modyfikatory do wersji (np. Poprzednie)

Wartość Opis
firstParent

Pierwszy element nadrzędny zatwierdzenia (HEAD^)
none

Nie określono
previousChange

Zatwierdzanie zmienionego elementu przed bieżącą wersją

GitVersionType

Wyliczanie

Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak identyfikator jest interpretowany

Wartość Opis
branch

Interpretowanie wersji jako nazwy gałęzi
commit

Interpretowanie wersji jako identyfikatora zatwierdzenia (SHA1)
tag

Interpretowanie wersji jako nazwy tagu

VersionControlRecursionType

Wyliczanie

Poziom rekursji dla pobierania podstron. Wartość domyślna to None (opcjonalnie).

Wartość Opis
full

Zwraca określony element i wszystkie elementy podrzędne
none

Zwróć tylko określony element.
oneLevel

Zwróć określony element i jego bezpośrednie elementy podrzędne.
oneLevelPlusNestedEmptyFolders

Zwróć określony element i jego bezpośrednie elementy podrzędne, a także cyklicznych łańcuchów zagnieżdżonych folderów podrzędnych, które zawierają tylko jeden folder.

WikiPage

Objekt

Definiuje stronę w witrynie typu wiki.

Nazwa Typ Opis
content

string

Zawartość strony typu wiki.
gitItemPath

string

Ścieżka elementu git odpowiadającego stronie typu wiki przechowywanej w repozytorium Git.
id

integer (int32)

Gdy jest obecny, trwały identyfikator strony typu wiki
isNonConformant

boolean

Prawda, jeśli strona jest niezgodna, tj. 1), jeśli nazwa nie jest zgodna ze standardami nazewnictwa stron. 2) jeśli strona nie ma prawidłowego wpisu w odpowiednim pliku zamówienia.
isParentPage

boolean

Prawda, jeśli ta strona ma podstrony pod ścieżką.
order

integer (int32)

Kolejność strony typu wiki względem innych stron na tym samym poziomie hierarchii.
path

string

Ścieżka strony typu wiki.
remoteUrl

string

Zdalny internetowy adres URL do strony typu wiki.
subPages

WikiPage[]

Lista podstron bieżącej strony.
url

string

Adres URL REST dla tej strony typu wiki.