URLs
GET api.ashx/v2/groups/{groupid}/wikis.xml (or .json)
LIST wikis.
GET api.ashx/v2/wikis.xml (or .json)
LIST wikis.
Request Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| GroupId | int? |
Group Id | Optional | ||
| IncludeSubGroups | bool? |
Only used when GroupId is specified. Default is false. | Optional | ||
| ApplicationIds | string |
Comma separated list of ApplicationIds. Used to limit to a specific set of wikis as well as sort order if SoryBy is set to ApplicationIdsOrder | Optional | ||
| IncludeDisabled | bool? |
Only return wikis that are enabled. Default is true. | Optional | ||
| PermissionId | string |
Used to get a list of blogs for which the accessing or impersonated user has the provided Permission ID. | Optional | ||
| SortBy | string |
Options: Name, ApplicationIdsOrder | Optional | ||
| UserId | int? |
Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead | Optional | ||
| PageSize | int? |
Specify the number of results to return per page. If not set the default is 20. The max is 100. | Optional | ||
| PageIndex | int? |
Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional |
Example Requests
C# REST SDK
This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.
var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.GetToDynamic(2, "groups/{groupid}/wikis.json", false, new RestGetOptions {
PathParameters = new System.Collections.Specialized.NameValueCollection {
{ "groupid", "6" }
}
});
Widget Javascript
This example uses the rest JavaScript API to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/{groupid}/wikis.json',
data: {
'groupid': '6'
},
success: function(response) {
}
});
cURL
This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.
curl -H "Rest-User-Token: ENCODED_TOKEN" -X GET https://mysite.com/api.ashx/v2/groups/6/wikis.xml
Example Responses
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>
<Wikis PageSize="2" PageIndex="0" TotalCount="2">
<Wiki>
<Id>32</Id>
<Name>title</Name>
<Key>key</Key>
<Url>url</Url>
<Group>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>6</ParentGroupId>
<Url>url</Url>
<TotalMembers>25</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>8</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes>
<key>value</key>
<key>value</key>
</ExtendedAttributes>
<ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
<Container>
<ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
<ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<LastModifiedUtcDate>2012-05-02T00:00:00</LastModifiedUtcDate>
<Description>description</Description>
<Enabled>true</Enabled>
<PageCount>7</PageCount>
<CommentCount>27</CommentCount>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<Application>
<ApplicationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationId>
<ApplicationTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Container>
<ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
<ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Application>
</Wiki>
<Wiki>
<Id>6</Id>
<Name>title</Name>
<Key>key</Key>
<Url>url</Url>
<Group>
<Id>61</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-06-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>52</ParentGroupId>
<Url>url</Url>
<TotalMembers>19</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>112</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes>
<key>value</key>
<key>value</key>
</ExtendedAttributes>
<ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
<Container>
<ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId>
<ContainerTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<LastModifiedUtcDate>2011-05-28T00:00:00</LastModifiedUtcDate>
<Description>description</Description>
<Enabled>true</Enabled>
<PageCount>18</PageCount>
<CommentCount>76</CommentCount>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<Application>
<ApplicationId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationId>
<ApplicationTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Container>
<ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
<ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Application>
</Wiki>
</Wikis>
</Response>
JSON
{
"PageSize": 2,
"PageIndex": 0,
"TotalCount": 2,
"Wikis": [
{
"Name": "title",
"Title": "title",
"Key": "key",
"Url": "url",
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 6,
"Url": "url",
"TotalMembers": 25,
"HasGroups": true,
"GroupCount": 8,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [
{
"Key": "key",
"Value": "value"
},
{
"Key": "key",
"Value": "value"
}
],
"ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 4
},
"LastModifiedUtcDate": "2012-05-02T00:00:00",
"Description": "description",
"Enabled": true,
"PageCount": 7,
"CommentCount": 27,
"SearchUniqueId": "searchuniqueid",
"Application": {
"ApplicationId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ApplicationTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": {
"ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
"ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
}
},
"Id": 32
},
{
"Name": "title",
"Title": "title",
"Key": "key",
"Url": "url",
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-06-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 52,
"Url": "url",
"TotalMembers": 19,
"HasGroups": true,
"GroupCount": 112,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [
{
"Key": "key",
"Value": "value"
},
{
"Key": "key",
"Value": "value"
}
],
"ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
"ContainerTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 61
},
"LastModifiedUtcDate": "2011-05-28T00:00:00",
"Description": "description",
"Enabled": true,
"PageCount": 18,
"CommentCount": 76,
"SearchUniqueId": "searchuniqueid",
"Application": {
"ApplicationId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ApplicationTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": {
"ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContainerTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
}
},
"Id": 6
}
],
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}