ComAround Public

API change history

Search_Get

Implementation Notes Requires user to be in one of the following roles : Any

Try it

Request

Request URL

Request parameters

  • string

    required

  • (optional)
    string
  • (optional)
    number
  • (optional)
    number
  • (optional)
    number
  • (optional)
    string

    one of (WorkInProgress, Draft, Approved, Published, Archived, Deleted), repeatable

  • (optional)
    string

    one of (MostRelevant, MostViewed, MostHelpful, RecentlyAdded, Alphabetic, Position)

  • (optional)
    string

    one of (Text, Elearning, Video, Folder, Link)

  • (optional)
    string

    one of (None, Http)

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Representations

{
  "result": [
    {
      "id": 0,
      "title": "string",
      "body": "string",
      "knowledgeState": "workInProgress",
      "url": "string",
      "type": "folder",
      "tag": "none",
      "views": 0,
      "solutionRatio": 0,
      "breadcrumb": [
        {
          "title": "string",
          "url": "string"
        }
      ],
      "relevance": 0
    }
  ],
  "totalResultCount": 0,
  "currentPage": 0,
  "totalPages": 0,
  "maxRelevance": 0,
  "facets": {
    "authors": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "tags": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "knowledgeStates": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "languages": [
      {
        "key": "string",
        "value": 0
      }
    ]
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api2.comaround.com/rest/v1/search/?SearchPhrase={string}&Authors={string}&ContentId={number}&CurrentPage={number}&ItemsPerPage={number}&KnowledgeStates={string}&SortBy={string}&Tags={string}&Highlight={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["SearchPhrase"] = "{string}";
            queryString["Authors"] = "{string}";
            queryString["ContentId"] = "{number}";
            queryString["CurrentPage"] = "{number}";
            queryString["ItemsPerPage"] = "{number}";
            queryString["KnowledgeStates"] = "{string}";
            queryString["SortBy"] = "{string}";
            queryString["Tags"] = "{string}";
            queryString["Highlight"] = "{string}";
            var uri = "https://api2.comaround.com/rest/v1/search/?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api2.comaround.com/rest/v1/search/");

            builder.setParameter("SearchPhrase", "{string}");
            builder.setParameter("Authors", "{string}");
            builder.setParameter("ContentId", "{number}");
            builder.setParameter("CurrentPage", "{number}");
            builder.setParameter("ItemsPerPage", "{number}");
            builder.setParameter("KnowledgeStates", "{string}");
            builder.setParameter("SortBy", "{string}");
            builder.setParameter("Tags", "{string}");
            builder.setParameter("Highlight", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "SearchPhrase": "{string}",
            "Authors": "{string}",
            "ContentId": "{number}",
            "CurrentPage": "{number}",
            "ItemsPerPage": "{number}",
            "KnowledgeStates": "{string}",
            "SortBy": "{string}",
            "Tags": "{string}",
            "Highlight": "{string}",
        };
      
        $.ajax({
            url: "https://api2.comaround.com/rest/v1/search/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api2.comaround.com/rest/v1/search/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"SearchPhrase={string}",
                         @"Authors={string}",
                         @"ContentId={number}",
                         @"CurrentPage={number}",
                         @"ItemsPerPage={number}",
                         @"KnowledgeStates={string}",
                         @"SortBy={string}",
                         @"Tags={string}",
                         @"Highlight={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api2.comaround.com/rest/v1/search/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'SearchPhrase' => '{string}',
    'Authors' => '{string}',
    'ContentId' => '{number}',
    'CurrentPage' => '{number}',
    'ItemsPerPage' => '{number}',
    'KnowledgeStates' => '{string}',
    'SortBy' => '{string}',
    'Tags' => '{string}',
    'Highlight' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'SearchPhrase': '{string}',
    'Authors': '{string}',
    'ContentId': '{number}',
    'CurrentPage': '{number}',
    'ItemsPerPage': '{number}',
    'KnowledgeStates': '{string}',
    'SortBy': '{string}',
    'Tags': '{string}',
    'Highlight': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api2.comaround.com')
    conn.request("GET", "/rest/v1/search/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'SearchPhrase': '{string}',
    'Authors': '{string}',
    'ContentId': '{number}',
    'CurrentPage': '{number}',
    'ItemsPerPage': '{number}',
    'KnowledgeStates': '{string}',
    'SortBy': '{string}',
    'Tags': '{string}',
    'Highlight': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api2.comaround.com')
    conn.request("GET", "/rest/v1/search/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api2.comaround.com/rest/v1/search/')

query = URI.encode_www_form({
    # Request parameters
    'SearchPhrase' => '{string}',
    'Authors' => '{string}',
    'ContentId' => '{number}',
    'CurrentPage' => '{number}',
    'ItemsPerPage' => '{number}',
    'KnowledgeStates' => '{string}',
    'SortBy' => '{string}',
    'Tags' => '{string}',
    'Highlight' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body