Wikis

Create, edit, delete and list wikis.

At their core, wikis are free form blocks of wiki text that are rendered into HTML and displayed to the user. There are several wiki namespaces that are used for different purposes and have different sets of features enabled. The namespace and title uniquely defines a wiki. The display_title, if available, is displayed to the user in place of the wiki's title but does not change the location of the wiki.

Namespaces

The namespace determines which fields are returned in API responses and also which fields are modifiable at the wiki create and edit endpoints. There are 6 namespaces:

  • CATEGORY: The content hierarchy — these wikis can be nested in a tree structure. Guides are associated with a wiki in this namespace.
  • ITEM: Parts and tools that can be attached to guides.
  • TEAM: About pages for teams with the title matching the team's teamid.
  • USER: About pages for users with the title matching the user's userid.
  • INFO: Site information such as licensing and about.
  • WIKI: Documentation that doesn't belong in the other namespaces.

GET /wikis/CATEGORY?display=hierarchy

Returns a hierarchical list of categories along with their display titles. Categories with the stub flag can be included with the 'includeStubs' parameter.

GET /wikis/{namespace}

Returns a flat list of light wiki objects.

GET /wikis/{namespace}?display=titles

Returns a flat list of wiki titles.

GET /wikis/{namespace}/{title}

Returns detailed information about the wiki with the given namespace and title.

GET /wikis/{namespace}/{title}/tags

Get all tags on a wiki

GET /wikis/CATEGORY/{title}/children

Get all children of a wiki.

GET /wikis/CATEGORY/{title}/identification

Get the HTML source of the identification section of a device wiki.

POST /wikis

Create a new wiki. The fields available to set as well as the ones returned are determined by the namespace of the new wiki. See namespace definitions.

PATCH /wikis/{namespace}/{title}

Modify an existing wiki. The fields available to set as well as the ones returned are determined by the namespace of the modified wiki. See namespace definitions.

DELETE /wikis/{namespace}/{title}

Delete the wiki. The history of the deleted wiki is still available after deletion and can be accessed by creating a new wiki with the same namespace and title.

POST /wikis/{namespace}/{title}/revert

Revert the wiki to a previous revision.

PUT /wikis/CATEGORY/{title}/parent

Make the category a child of the specified category.

PUT /wikis/{namespace}/{title}/tag

Adds a tag to a wiki, creating the tag if needed.

DELETE /wikis/{namespace}/{title}/tag

Removes a tag from a wiki.

POST /wikis/{wikiid}/releases

Create a new release for a wiki.

DELETE /wikis/releases/{releaseid}

Cancel a wiki release.

© 2021 Jamestown Distributors, Inc. All Rights reserved.
Privacy Policy Credit Card Policy Cookie Policy