Freigeben über

Wikis - Create

  • Referenz
Service:
Wiki
API Version:
5.0

Erstellt die Wikiressource.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
 path True

string

Der Name der Azure DevOps-Organisation.
project
 path

string

Projekt-ID oder Projektname
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "5.0" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
mappedPath

string

Ordnerpfad innerhalb des Repositorys, das als Wiki angezeigt wird. Für den ProjectWiki-Typ nicht erforderlich.
name

string

Wikiname.
projectId

string

ID des Projekts, in dem das Wiki erstellt werden soll.
repositoryId

string

ID des Git-Repositorys, das das Wiki sichert. Für den ProjectWiki-Typ nicht erforderlich.
type

WikiType

Typ des Wikis.
version

GitVersionDescriptor

Version des Wikis. Für den ProjectWiki-Typ nicht erforderlich.

Antworten

Name Typ Beschreibung
201 Created

WikiV2

Wiki erstellt

Sicherheit

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 Beschreibung
vso.wiki_write Ermöglicht das Lesen, Erstellen und Aktualisieren von Wikis, Wiki-Seiten und Wiki-Anlagen.

Beispiele

Create code wiki
Create project wiki

Create code wiki

Sample Request

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

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

Definitionen

Name Beschreibung
GitVersionDescriptor
GitVersionOptions

Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)
GitVersionType

Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.
WikiCreateParametersV2

Parameter für die Wikierstellung.
WikiType

Typ des Wikis.
WikiV2

Definiert eine Wikiressource.

GitVersionDescriptor

Name Typ Beschreibung
version

string

Versionszeichenfolgenbezeichner (Name von Tag/Branch, SHA1 des Commits)
versionOptions

GitVersionOptions

Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)
versionType

GitVersionType

Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.

GitVersionOptions

Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)

Name Typ Beschreibung
firstParent

string

Erstes übergeordnetes Element des Commits (HEAD^)
none

string

Nicht angegeben
previousChange

string

Commit für das geänderte Element vor der aktuellen Version

GitVersionType

Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.

Name Typ Beschreibung
branch

string

Interpretieren der Version als Branchname
commit

string

Interpretieren der Version als Commit-ID (SHA1)
tag

string

Interpretieren der Version als Tagname

WikiCreateParametersV2

Parameter für die Wikierstellung.

Name Typ Beschreibung
mappedPath

string

Ordnerpfad innerhalb des Repositorys, das als Wiki angezeigt wird. Für den ProjectWiki-Typ nicht erforderlich.
name

string

Wikiname.
projectId

string

ID des Projekts, in dem das Wiki erstellt werden soll.
repositoryId

string

ID des Git-Repositorys, das das Wiki sichert. Für den ProjectWiki-Typ nicht erforderlich.
type

WikiType

Typ des Wikis.
version

GitVersionDescriptor

Version des Wikis. Für den ProjectWiki-Typ nicht erforderlich.

WikiType

Typ des Wikis.

Name Typ Beschreibung
codeWiki

string

Gibt an, dass das Wiki aus einem Git-Repository veröffentlicht wird.
projectWiki

string

Gibt an, dass das Wiki für das Teamprojekt bereitgestellt wird.

WikiV2

Definiert eine Wikiressource.

Name Typ Beschreibung
id

string

ID des Wikis.
mappedPath

string

Ordnerpfad innerhalb des Repositorys, das als Wiki angezeigt wird. Für den ProjectWiki-Typ nicht erforderlich.
name

string

Wikiname.
projectId

string

ID des Projekts, in dem das Wiki erstellt werden soll.
properties

object

Eigenschaften des Wikis.
remoteUrl

string

Remoteweb-URL zum Wiki.
repositoryId

string

ID des Git-Repositorys, das das Wiki sichert. Für den ProjectWiki-Typ nicht erforderlich.
type

WikiType

Typ des Wikis.
url

string

REST-URL für dieses Wiki.
versions

GitVersionDescriptor[]

Versionen des Wikis.