Create Search Result REST Endpoint

Ben Tiedt — Tue, 19 Nov 2019 20:24:40 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:24:40

URLs

POST api.ashx/v2/search.xml (or .json)

CREATE a search result - add a document to the index.

Request Parameters

Name	Type	Description	Required
Collapse	`string`	Collapse	Optional
Content	`string`	Content	Required
ContentId	`string`	Unique Id for the content type	Required
ContentType	`string`	Content Type	Required
ContentUrl	`string`	Content Url	Required
CreatedBy	`string`	Optional username for the user who created the content	Optional
Date	`DateTime`	Date	Required
EditedBy	`string`	Optional username for the user who last edited the content	Optional
GroupId	`int?`	Group Id	Optional
Rating	`double?`	Rating is a real number from 0 to 100 maintaining one decimal place: 000.0	Optional
Roles	`string`	List of role ids, separated by commas, that have permission to view the item.	Required
SectionId	`int?`	Section Id	Optional
Tags	`string`	List of tags, separated by commas	Optional
ThreadId	`int?`	Thread Id	Optional
Title	`string`	Title	Required
UserId	`int?`	UserId or Username is required when specifying a user.	Optional
Username	`string`	Either UserId or Username is required when specifying a user.	Optional
WikiId	`int?`	Wiki Id	Optional
CustomFields	`RestSearchFields`	Custom Fields	Optional
GuidId	`Guid?`	The GUID representing the content.	Optional
ApplicationId	`Guid?`	The GUID representing the application.	Optional
ContainerId	`Guid?`	The GUID representing the container.	Optional
Category	`string`	Category	Optional
IsContent	`bool?`	Is Content	Optional
IsApplication	`bool?`	Is Application	Optional
IsContainer	`bool?`	Is Container	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.PostToDynamic(2, "search.json", false, new RestPostOptions {
	PostParameters = new System.Collections.Specialized.NameValueCollection {
		{ "Content", "content" },
		{ "ContentId", "contentid" },
		{ "ContentType", "contenttype" },
		{ "ContentUrl", "contenturl" },
		{ "Date", "2012-01-04T00:00:00" },
		{ "Roles", "roles" },
		{ "Title", "title" }
	}
});

Widget Javascript

This example uses the [[rest JavaScript API Module|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.post({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/search.json',
	data: { 
		'Content': 'content',
		'ContentId': 'contentid',
		'ContentType': 'contenttype',
		'ContentUrl': 'contenturl',
		'Date': '2012-01-04T00:00:00',
		'Roles': 'roles',
		'Title': 'title'
	},
	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" -d "Content=content&ContentId=contentid&ContentType=contenttype&ContentUrl=contenturl&Date=2012-01-04T00%3a00%3a00&Roles=roles&Title=title" -X POST https://mysite.com/api.ashx/v2/search.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>
  <DocumentId>documentid</DocumentId>
</Response>

JSON

{
  "DocumentId": "documentid",
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}