Wikis - Create

Service:

Wiki

API Version:

5.0

Vytvoří prostředek wikiwebu.

POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis?api-version=5.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na hodnotu 5.0.

Text požadavku

Name	Typ	Description
mappedPath	string	Cesta ke složce v úložišti, která se zobrazuje jako Wiki. Typ ProjectWiki nevyžaduje.
name	string	Název wikiwebu.
projectId	string	ID projektu, ve kterém má být wikiweb vytvořen.
repositoryId	string	ID úložiště Git, které zálohuje wikiweb. Typ ProjectWiki nevyžaduje.
type	WikiType	Typ wikiwebu
version	GitVersionDescriptor	Verze wikiwebu Typ ProjectWiki nevyžaduje.

Odpovědi

Name	Typ	Description
201 Created	WikiV2	Wikivytvořil se

Zabezpečení

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_write	Umožňuje číst, vytvářet a aktualizovat wikiweby, stránky wikiwebu a přílohy wikiwebu.

Příklady

Create code wiki

Create project wiki

Create code wiki

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "version": {
    "version": "master"
  },
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Sample Response

Status code:

201

{
  "id": "9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "versions": [
    {
      "version": "master"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Create project wiki

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe"
}

Sample Response

Status code:

201

{
  "id": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_apis/wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "remoteUrl": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe",
  "repositoryId": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "mappedPath": "/"
}

Definice

Name	Description
GitVersionDescriptor
GitVersionOptions	Možnosti verze – Zadejte další modifikátory pro verzi (např. Předchozí).
GitVersionType	Typ verze (větev, značka nebo potvrzení). Určuje, jak se ID interpretuje.
WikiCreateParametersV2	Parametry vytváření wikiwebu
WikiType	Typ wikiwebu
WikiV2	Definuje prostředek wikiwebu.

GitVersionDescriptor

Name	Typ	Description
version	string	Identifikátor řetězce verze (název značky nebo větve, SHA1 potvrzení)
versionOptions	GitVersionOptions	Možnosti verze – Zadejte další modifikátory pro verzi (např. Předchozí).
versionType	GitVersionType	Typ verze (větev, značka nebo potvrzení). Určuje, jak se ID interpretuje.

GitVersionOptions

Možnosti verze – Zadejte další modifikátory pro verzi (např. Předchozí).

Name	Typ	Description
firstParent	string	První nadřazená položka potvrzení (HEAD^)
none	string	Neurčené
previousChange	string	Potvrzení změněné položky před aktuální verzí

GitVersionType

Typ verze (větev, značka nebo potvrzení). Určuje, jak se ID interpretuje.

Name	Typ	Description
branch	string	Interpretace verze jako názvu větve
commit	string	Interpretovat verzi jako ID potvrzení (SHA1)
tag	string	Interpretovat verzi jako název značky

WikiCreateParametersV2

Parametry vytváření wikiwebu

Name	Typ	Description
mappedPath	string	Cesta ke složce v úložišti, která se zobrazuje jako Wiki. Typ ProjectWiki nevyžaduje.
name	string	Název wikiwebu.
projectId	string	ID projektu, ve kterém má být wikiweb vytvořen.
repositoryId	string	ID úložiště Git, které zálohuje wikiweb. Typ ProjectWiki nevyžaduje.
type	WikiType	Typ wikiwebu
version	GitVersionDescriptor	Verze wikiwebu Typ ProjectWiki nevyžaduje.

WikiType

Typ wikiwebu

Name	Typ	Description
codeWiki	string	Označuje, že wikiweb je publikovaný z úložiště Git.
projectWiki	string	Označuje, že wikiweb je zřízený pro týmový projekt.

WikiV2

Definuje prostředek wikiwebu.

Name	Typ	Description
id	string	ID wikiwebu
mappedPath	string	Cesta ke složce v úložišti, která se zobrazuje jako Wiki. Typ ProjectWiki nevyžaduje.
name	string	Název wikiwebu.
projectId	string	ID projektu, ve kterém má být wikiweb vytvořen.
properties	object	Vlastnosti wikiwebu
remoteUrl	string	Vzdálená webová adresa URL wikiwebu
repositoryId	string	ID úložiště Git, které zálohuje wikiweb. Typ ProjectWiki nevyžaduje.
type	WikiType	Typ wikiwebu
url	string	Adresa URL REST pro tento wikiweb.
versions	GitVersionDescriptor[]	Verze wikiwebu.