Get Wiki Toc REST Endpoint

GET api.ashx/v2/wikis/{wikiid}/pages/{wikipageid}/toc.{json|xml}

GET the table of contents for a wiki page.

Scopes

Wikis › Read Table Of Contents wikis.toc.readonly

Request Parameters

Name Type Location Description Required Default Options
ShowHiddenPages bool? When true items with their HiddenInTableOfContents flag set to true will be included. By default they are not included in the list. Optional
WikiId int Wiki Id Required
WikiPageId int? Wiki Page Id Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/wikis/{wikiid}/pages/{wikipageid}/toc.json',
	data: { 
		'wikiid': '6',
		'wikipageid': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "Pages": [
    {
      "Title": "title",
      "PageKey": "pagekey",
      "Url": "url",
      "Position": 6,
      "HiddenInTableOfContents": true,
      "IsDefaultPage": true,
      "Children": [
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 25,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 8
        },
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 4,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 7
        }
      ],
      "Id": 27
    },
    {
      "Title": "title",
      "PageKey": "pagekey",
      "Url": "url",
      "Position": 32,
      "HiddenInTableOfContents": true,
      "IsDefaultPage": true,
      "Children": [
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 52,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 19
        },
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 112,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 61
        }
      ],
      "Id": 18
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Pages>
    <WikiPage>
      <Id>27</Id>
      <Title>title</Title>
      <PageKey>pagekey</PageKey>
      <Url>url</Url>
      <Position>6</Position>
      <HiddenInTableOfContents>true</HiddenInTableOfContents>
      <IsDefaultPage>true</IsDefaultPage>
      <Children>
        <WikiPage>
          <Id>8</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>25</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
        <WikiPage>
          <Id>7</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>4</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
      </Children>
    </WikiPage>
    <WikiPage>
      <Id>18</Id>
      <Title>title</Title>
      <PageKey>pagekey</PageKey>
      <Url>url</Url>
      <Position>32</Position>
      <HiddenInTableOfContents>true</HiddenInTableOfContents>
      <IsDefaultPage>true</IsDefaultPage>
      <Children>
        <WikiPage>
          <Id>19</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>52</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
        <WikiPage>
          <Id>61</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>112</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
      </Children>
    </WikiPage>
  </Pages>
</Response>

GET api.ashx/v2/wikis/{wikiid}/toc.{json|xml}

GET the table of contents for a wiki.

Scopes

Wikis › Read Table Of Contents wikis.toc.readonly

Request Parameters

Name Type Location Description Required Default Options
ShowHiddenPages bool? When true items with their HiddenInTableOfContents flag set to true will be included. By default they are not included in the list. Optional
WikiId int Wiki Id Required
WikiPageId int? Wiki Page Id Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/wikis/{wikiid}/toc.json',
	data: { 
		'wikiid': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "Pages": [
    {
      "Title": "title",
      "PageKey": "pagekey",
      "Url": "url",
      "Position": 6,
      "HiddenInTableOfContents": true,
      "IsDefaultPage": true,
      "Children": [
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 25,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 8
        },
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 4,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 7
        }
      ],
      "Id": 27
    },
    {
      "Title": "title",
      "PageKey": "pagekey",
      "Url": "url",
      "Position": 32,
      "HiddenInTableOfContents": true,
      "IsDefaultPage": true,
      "Children": [
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 52,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 19
        },
        {
          "Title": "title",
          "PageKey": "pagekey",
          "Url": "url",
          "Position": 112,
          "HiddenInTableOfContents": true,
          "IsDefaultPage": true,
          "Children": [
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            },
            {
              "Title": "title",
              "PageKey": "pagekey",
              "Url": "url",
              "Position": null,
              "HiddenInTableOfContents": true,
              "IsDefaultPage": true,
              "Children": null,
              "Id": null
            }
          ],
          "Id": 61
        }
      ],
      "Id": 18
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Pages>
    <WikiPage>
      <Id>27</Id>
      <Title>title</Title>
      <PageKey>pagekey</PageKey>
      <Url>url</Url>
      <Position>6</Position>
      <HiddenInTableOfContents>true</HiddenInTableOfContents>
      <IsDefaultPage>true</IsDefaultPage>
      <Children>
        <WikiPage>
          <Id>8</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>25</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
        <WikiPage>
          <Id>7</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>4</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
      </Children>
    </WikiPage>
    <WikiPage>
      <Id>18</Id>
      <Title>title</Title>
      <PageKey>pagekey</PageKey>
      <Url>url</Url>
      <Position>32</Position>
      <HiddenInTableOfContents>true</HiddenInTableOfContents>
      <IsDefaultPage>true</IsDefaultPage>
      <Children>
        <WikiPage>
          <Id>19</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>52</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
        <WikiPage>
          <Id>61</Id>
          <Title>title</Title>
          <PageKey>pagekey</PageKey>
          <Url>url</Url>
          <Position>112</Position>
          <HiddenInTableOfContents>true</HiddenInTableOfContents>
          <IsDefaultPage>true</IsDefaultPage>
          <Children>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
            <WikiPage>
              <Id />
              <Title>title</Title>
              <PageKey>pagekey</PageKey>
              <Url>url</Url>
              <Position />
              <HiddenInTableOfContents>true</HiddenInTableOfContents>
              <IsDefaultPage>true</IsDefaultPage>
            </WikiPage>
          </Children>
        </WikiPage>
      </Children>
    </WikiPage>
  </Pages>
</Response>
Related
Recommended

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community