Pages - Create Or Update

Usługa:

Wiki

Wersja interfejsu API:

7.1

Tworzy lub edytuje stronę typu wiki.

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

Z parametrami opcjonalnymi:

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&comment={comment}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&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.
path	query	True	string	Ścieżka strony typu wiki.
comment	query		string	Komentarz do skojarzenia z operacją strony.
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

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Version	True	string	Wersja strony, na której ma zostać wprowadzona zmiana. Obowiązkowe w scenariuszu Edit. Aby zostać wypełniony w nagłówku If-Match żądania.

Treść żądania

Nazwa	Typ	Opis
content	string	Zawartość strony typu wiki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WikiPage	Edytowana strona. Wersja edytowanej strony jest wypełniana w nagłówku odpowiedzi ETag. Nagłówki ETag: string
201 Created	WikiPage	Utworzona strona. Wersja utworzonej strony jest wypełniana w nagłówku odpowiedzi ETag. 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_write	Daje możliwość odczytywania, tworzenia i aktualizowania stron typu wiki, stron typu wiki i załączników typu wiki.

Przykłady

Add a page

Edit a page

Add a page

Przykładowe żądanie

HTTP

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

{
  "content": "Wiki page content"
}

Przykładowa odpowiedź

Kod stanu:

201

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

Edit a page

Przykładowe żądanie

HTTP

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

{
  "content": "New content for page"
}

Przykładowa odpowiedź

Kod stanu:

200

eTag: "c14ea53eb6fc5921c184be18c6b3d2d916548f28"

{
  "path": "/SamplePage973",
  "order": 1,
  "isParentPage": true,
  "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": "New content for page"
}

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
WikiPage	Definiuje stronę w witrynie typu wiki.
WikiPageCreateOrUpdateParameters	Kontrakt hermetyzuje parametry dla operacji tworzenia lub aktualizowania strony.

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

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.

WikiPageCreateOrUpdateParameters

Objekt

Kontrakt hermetyzuje parametry dla operacji tworzenia lub aktualizowania strony.

Nazwa	Typ	Opis
content	string	Zawartość strony typu wiki.