GET api.ashx/v2/aggregatetags.{json|xml}
LIST aggregate tags.
Scopes
Tags › Read Aggregate Tags tags.aggregatetags.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid? | Content application identifier | Optional | |||
ApplicationTypeId | Guid? | Content application type identifier | Optional | |||
ContainerId | Guid? | Content container identifier | Optional | |||
ContentTypeId | Guid? | Content type identifier | Optional | |||
IncludeSubContainers | bool? | Include sub containers | Optional | |||
LogicallyOrTags | bool? | Returns tags matching any tag versus every tag | Optional | |||
MinimumContentCount | int? | Returns tags with at least the specified total pieces of content | Optional | |||
PageIndex | int? | Page index to retrieve | Optional | |||
PageSize | int? | Page size to retrieve | Optional | |||
SortBy | string | Sort by 'Date' | Optional | |||
SortOrder | string | Sort order 'Ascending' or 'Descending' | Optional | |||
TagNameFilter | string | Used to search tags by name | Optional | |||
Tags | string | A comma-seperated list of tags to filter by | Optional | |||
TypeId | Guid? | Categorization type | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/aggregatetags.json' }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "AggregateTags": [ { "ContentCount": 6, "Name": "name", "LatestTaggedDate": "2012-01-04T00:00:00" }, { "ContentCount": 25, "Name": "name", "LatestTaggedDate": "2012-05-02T00:00:00" } ], "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> <AggregateTags PageSize="2" PageIndex="0" TotalCount="2"> <AggregateTag> <ContentCount>6</ContentCount> <Name>name</Name> <LatestTaggedDate>2012-01-04T00:00:00</LatestTaggedDate> </AggregateTag> <AggregateTag> <ContentCount>25</ContentCount> <Name>name</Name> <LatestTaggedDate>2012-05-02T00:00:00</LatestTaggedDate> </AggregateTag> </AggregateTags> </Response>