GET api.ashx/v2/groups/{groupid}/wikis.{json|xml}
LIST wikis.
Scopes
Wikis › Read Wikis wikis.wikis.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationIds | string | Comma separated list of ApplicationIds. Used to limit to a specific set of wikis as well as sort order if SortBy is set to ApplicationIdsOrder | Optional | |||
GroupId | int? | Group Id | Optional | |||
IncludeDisabled | bool? | Only return wikis that are enabled. Default is true. | Optional | |||
IncludeSubGroups | bool? | Only used when GroupId is specified. Default is false. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. | 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 |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/{groupid}/wikis.json', data: { 'groupid': '6' } }).then(function(response) { // use response });
Example Responses
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" ] }
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>