GET api.ashx/v2/related/{id}.{json|xml}
LIST related content.
Scopes
Content › Read Related Content content.related.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid? | The GUID representing the application. | Optional | |||
Category | string | Category | Optional | |||
Collapse | bool? | Result collapsing will default to false if not specified. | Optional | |||
ContainerId | Guid? | The GUID representing the container. | Optional | |||
DateRangeFacets | string | Date Range Facets | Optional | |||
DateRangeFilters | string | Date Range Filters | Optional | |||
EndDate | DateTime? | End Date | Optional | |||
FieldFacets | string | Field Facets | Optional | |||
FieldFilters | string | Field Filters | Optional | |||
Filters | string | Filters is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | Optional | |||
GuidId | Guid? | The GUID representing the content. | Optional | |||
Id | string | Used when using MLT. | Optional | |||
IsApplication | bool? | Is Application | Optional | |||
IsContainer | bool? | Is Container | Optional | |||
IsContent | bool? | Is Content | Optional | |||
IsLoggable | bool? | Whether the search should be logged for reporting. | Optional | |||
LogicallyOrTags | bool? | Whether to AND or OR tags specified in the Tags parameter. Default is False, logically AND tags. | Optional | |||
Mlt | bool? | More Like This. Can be used in conjunction with Filters. If using MLT, Id should be set. | 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 | |||
PostTarget | string | Render target. Options: Unknown, Web, Syndication, Offline, Other, Print, Nntp, Email, WebQuote, WebServices. | Optional | |||
Query | string | Query is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | Optional | |||
SearchFlags | string | Comma delimited list of search flags, used for flagging the search as well as for reporting | Optional | |||
Sort | string | Two options for sort are titlesort and date and it also supports asc and desc. To sort by title ascending use sort=titlesort+asc, to sort by date descending use sort=date+desc. | Optional | |||
StartDate | DateTime? | Start Date | Optional | |||
Tags | string | Comma delimited list of tags. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/related/{id}.json', data: { 'id': 'id' } }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "SearchResults": [ { "Id": "id", "ContentId": "contentid", "Title": "title", "Url": "url", "Date": "2012-01-04T00:00:00", "ContentType": "contenttype", "Body": "body", "BestMatch": "bestmatch", "BestMatchTitle": "bestmatchtitle", "SearchFields": [ { "Name": "name", "Value": "value" }, { "Name": "name", "Value": "value" } ], "SectionId": 6, "ThreadId": 25, "WikiId": 8, "Tags": [ { "Value": "value" }, { "Value": "value" } ], "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-05-02T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 4, "Url": "url", "TotalMembers": 7, "HasGroups": true, "GroupCount": 27, "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": 32 }, "Users": [ { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "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": [], "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 61 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2011-05-28T00:00:00", "ReplyCount": 18, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "CreatedDate": "2011-12-09T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46" }, "Id": 76 }, { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-03-29T00: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": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 4 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-04-19T00:00:00", "ReplyCount": 7, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-01-16T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e" }, "Id": 27 } ], "IndexedAt": "2012-01-04T00:00:00", "GuidId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ApplicationId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "IsContent": true, "IsApplication": true, "IsContainer": true, "ViewHtml": "viewhtml", "PreviewHtml": "previewhtml", "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-05-02T00:00:00", "ReplyCount": 32, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-06-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e" }, "Id": 52 }, "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContentTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "CreatedDate": "2011-05-28T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "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": "id", "ContentId": "contentid", "Title": "title", "Url": "url", "Date": "2011-12-09T00:00:00", "ContentType": "contenttype", "Body": "body", "BestMatch": "bestmatch", "BestMatchTitle": "bestmatchtitle", "SearchFields": [ { "Name": "name", "Value": "value" }, { "Name": "name", "Value": "value" } ], "SectionId": 19, "ThreadId": 112, "WikiId": 61, "Tags": [ { "Value": "value" }, { "Value": "value" } ], "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-03-29T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 18, "Url": "url", "TotalMembers": 76, "HasGroups": true, "GroupCount": 6, "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": 25 }, "Users": [ { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-04-19T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 8, "Url": "url", "TotalMembers": 4, "HasGroups": true, "GroupCount": 7, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "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": 27 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-01-16T00:00:00", "ReplyCount": 32, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContentTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "CreatedDate": "2012-01-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4" }, "Id": 52 }, { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-05-02T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 19, "Url": "url", "TotalMembers": 112, "HasGroups": true, "GroupCount": 61, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 18 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-06-04T00:00:00", "ReplyCount": 76, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "CreatedDate": "2011-05-28T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "6cdcf200-3bad-476d-af45-97b52545c337" }, "Id": 6 } ], "IndexedAt": "2011-12-09T00:00:00", "GuidId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "IsContent": true, "IsApplication": true, "IsContainer": true, "ViewHtml": "viewhtml", "PreviewHtml": "previewhtml", "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-03-29T00:00:00", "ReplyCount": 25, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "CreatedDate": "2012-04-19T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "6cdcf200-3bad-476d-af45-97b52545c337" }, "Id": 8 }, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-01-16T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "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" } } } } ], "FieldFacets": null, "DateRangeFacets": null, "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
GET api.ashx/v2/search.{json|xml}
LIST search results.
Scopes
Search › Read Search Results search.results.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid? | The GUID representing the application. | Optional | |||
Category | string | Category | Optional | |||
Collapse | bool? | Result collapsing will default to false if not specified. | Optional | |||
ContainerId | Guid? | The GUID representing the container. | Optional | |||
DateRangeFacets | string | Date Range Facets | Optional | |||
DateRangeFilters | string | Date Range Filters | Optional | |||
EndDate | DateTime? | End Date | Optional | |||
FieldFacets | string | Field Facets | Optional | |||
FieldFilters | string | Field Filters | Optional | |||
Filters | string | Filters is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | Optional | |||
GuidId | Guid? | The GUID representing the content. | Optional | |||
Id | string | Used when using MLT. | Optional | |||
IsApplication | bool? | Is Application | Optional | |||
IsContainer | bool? | Is Container | Optional | |||
IsContent | bool? | Is Content | Optional | |||
IsLoggable | bool? | Whether the search should be logged for reporting. | Optional | |||
LogicallyOrTags | bool? | Whether to AND or OR tags specified in the Tags parameter. Default is False, logically AND tags. | Optional | |||
Mlt | bool? | More Like This. Can be used in conjunction with Filters. If using MLT, Id should be set. | 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 | |||
PostTarget | string | Render target. Options: Unknown, Web, Syndication, Offline, Other, Print, Nntp, Email, WebQuote, WebServices. | Optional | |||
Query | string | Query is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | Optional | |||
SearchFlags | string | Comma delimited list of search flags, used for flagging the search as well as for reporting | Optional | |||
Sort | string | Two options for sort are titlesort and date and it also supports asc and desc. To sort by title ascending use sort=titlesort+asc, to sort by date descending use sort=date+desc. | Optional | |||
StartDate | DateTime? | Start Date | Optional | |||
Tags | string | Comma delimited list of tags. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/search.json' }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "SearchResults": [ { "Id": "id", "ContentId": "contentid", "Title": "title", "Url": "url", "Date": "2012-01-04T00:00:00", "ContentType": "contenttype", "Body": "body", "BestMatch": "bestmatch", "BestMatchTitle": "bestmatchtitle", "SearchFields": [ { "Name": "name", "Value": "value" }, { "Name": "name", "Value": "value" } ], "SectionId": 6, "ThreadId": 25, "WikiId": 8, "Tags": [ { "Value": "value" }, { "Value": "value" } ], "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-05-02T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 4, "Url": "url", "TotalMembers": 7, "HasGroups": true, "GroupCount": 27, "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": 32 }, "Users": [ { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "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": [], "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 61 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2011-05-28T00:00:00", "ReplyCount": 18, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "CreatedDate": "2011-12-09T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46" }, "Id": 76 }, { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-03-29T00: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": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 4 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-04-19T00:00:00", "ReplyCount": 7, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-01-16T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e" }, "Id": 27 } ], "IndexedAt": "2012-01-04T00:00:00", "GuidId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ApplicationId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "IsContent": true, "IsApplication": true, "IsContainer": true, "ViewHtml": "viewhtml", "PreviewHtml": "previewhtml", "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-05-02T00:00:00", "ReplyCount": 32, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-06-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e" }, "Id": 52 }, "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContentTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "CreatedDate": "2011-05-28T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "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": "id", "ContentId": "contentid", "Title": "title", "Url": "url", "Date": "2011-12-09T00:00:00", "ContentType": "contenttype", "Body": "body", "BestMatch": "bestmatch", "BestMatchTitle": "bestmatchtitle", "SearchFields": [ { "Name": "name", "Value": "value" }, { "Name": "name", "Value": "value" } ], "SectionId": 19, "ThreadId": 112, "WikiId": 61, "Tags": [ { "Value": "value" }, { "Value": "value" } ], "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-03-29T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 18, "Url": "url", "TotalMembers": 76, "HasGroups": true, "GroupCount": 6, "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": 25 }, "Users": [ { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-04-19T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 8, "Url": "url", "TotalMembers": 4, "HasGroups": true, "GroupCount": 7, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "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": 27 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-01-16T00:00:00", "ReplyCount": 32, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContentTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "CreatedDate": "2012-01-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4" }, "Id": 52 }, { "MembershipType": "membershiptype", "IsDirectMember": true, "IsRoleMember": true, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-05-02T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 19, "Url": "url", "TotalMembers": 112, "HasGroups": true, "GroupCount": 61, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 18 }, "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-06-04T00:00:00", "ReplyCount": 76, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "CreatedDate": "2011-05-28T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "6cdcf200-3bad-476d-af45-97b52545c337" }, "Id": 6 } ], "IndexedAt": "2011-12-09T00:00:00", "GuidId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "IsContent": true, "IsApplication": true, "IsContainer": true, "ViewHtml": "viewhtml", "PreviewHtml": "previewhtml", "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-03-29T00:00:00", "ReplyCount": 25, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "CreatedDate": "2012-04-19T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "6cdcf200-3bad-476d-af45-97b52545c337" }, "Id": 8 }, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-01-16T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "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" } } } } ], "FieldFacets": null, "DateRangeFacets": null, "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }