CData Python Connector for Azure DevOps

Build 24.0.9060

WikiPages

Retrieves metadata or content of the wiki page for the provided path.

Table Specific Information

Select

The connector uses the Azure DevOps API to process WHERE clause conditions built with the following columns and operators:

  • ProjectId supports the '=' operator.
  • WikiId supports the '=' operator.
  • Path supports the '=' operator.
  • IncludeContent supports the '=' operator.
  • RecursionLevel supports the '=' operator.
  • VersionOptions supports the '=' operator.
  • Version supports the '=' operator.
  • VersionType supports the '=' operator.

The rest of the filter is executed client-side in the connector.

NOTE: WikiId is required in order to query WikiPages.

For example:

	SELECT * FROM WikiPages WHERE ProjectId = '837ccd31-8159-4db3-b8ce-de0c36d2a0bf' AND WikiId = '9d910096-122d-432e-b64a-8ef4d06d2905'
	SELECT * FROM WikiPages WHERE ProjectId = '837ccd31-8159-4db3-b8ce-de0c36d2a0bf' AND WikiId = '9d910096-122d-432e-b64a-8ef4d06d2905' AND RecursionLevel = 'full'
	SELECT * FROM WikiPages WHERE ProjectId = '837ccd31-8159-4db3-b8ce-de0c36d2a0bf' AND WikiId = '9d910096-122d-432e-b64a-8ef4d06d2905' AND Version = 'wikiMaster'

Insert

The following is an example of inserting a WikiPages table:

INSERT INTO WikiPages(WikiId, Content, ProjectId, Path) VALUES ('e7c569e7-3ff0-432c-93f0-084c09d578b5', 'Content for testing', 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937', 'main')

Update

The following is an example of updating a WikiPages table:

UPDATE WikiPages SET Content = 'cd' WHERE Path = 'main' AND WikiId = 'e7c569e7-3ff0-432c-93f0-084c09d578b5' AND ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937'

Delete

The following is an example of deleting data in the WikiPages table:

DELETE FROM WikiPages WHERE WikiId = 'e7c569e7-3ff0-432c-93f0-084c09d578b5' AND ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937'

Columns

Name Type ReadOnly References Description
Id Integer True

Permanent Id of the wiki page.

ProjectId String True

Id of the project for which this wiki was created.

WikiId [KEY] String True

Wikis.Id

Id of the wiki to which this page belongs to.

Content String False

Content of the wiki page.

GitItemPath String True

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

IsParentPage Boolean True

True if this page has subpages under its path.

Order Integer True

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

Path [KEY] String False

Path of the wiki page.

RemoteUrl String True

Remote web url to the wiki page.

SubPages String True

Sub Pages of the wiki page.

Url String True

REST url for this wiki page.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements, and offer a more granular control over the tuples that are returned from the data source. Unless otherwise specified, only the = operator is permitted when filtering on pseudocolumns.

Name Type Description
IncludeContent Boolean

True to include the content of the page in the response for JSON content type.

RecursionLevel String

Recursion level for subpages retrieval. Defaults to None.

The allowed values are full, none, oneLevel, oneLevelPlusNestedEmptyFolders.

VersionOptions String

Version options - specify additional modifiers to version.

The allowed values are firstParent, none, previousChange.

Version String

Version string identifier (name of tag/branch, SHA1 of commit).

VersionType String

Version type (branch, tag, or commit). Determines how Id is interpreted.

The allowed values are branch, commit, tag.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060