public-v2

API change history

Search_Get

Try it

Request

Request URL

Request parameters

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    array
  • (optional)
    array
  • (optional)
    array
  • (optional)
    string
  • (optional)
    array
  • (optional)
    array
  • (optional)
    array

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OpenID Connect id token obtained from ComAround OpenId. Supported grant types: Authorization code, Implicit.

Request body

Responses

200 OK

OK

Representations

{
  "spellCheckedSearchPhrase": "string",
  "totalResultCount": 0,
  "unFilteredResultCount": 0,
  "currentPage": 0,
  "totalPages": 0,
  "maxRelevance": 0.0,
  "searchId": "string",
  "facets": {
    "authors": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "tags": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "knowledgeStates": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "languages": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "flags": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "contentTags": [
      {
        "key": "string",
        "value": 0
      }
    ]
  },
  "result": [
    {
      "id": 0,
      "searchResultId": "string",
      "title": "string",
      "body": "string",
      "knowledgeState": "workInProgress",
      "url": "string",
      "type": "folder",
      "tag": "folder",
      "views": 0,
      "solutionRatio": 0,
      "relevance": 0.0,
      "urlTarget": "_blank",
      "breadcrumb": [
        {
          "contentId": 0,
          "title": "string",
          "url": "string"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "spellCheckedSearchPhrase": {
      "type": "string"
    },
    "totalResultCount": {
      "format": "int32",
      "type": "integer"
    },
    "unFilteredResultCount": {
      "format": "int32",
      "type": "integer"
    },
    "currentPage": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    },
    "maxRelevance": {
      "format": "double",
      "type": "number"
    },
    "searchId": {
      "type": "string"
    },
    "facets": {
      "type": "object",
      "properties": {
        "authors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "knowledgeStates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "flags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "contentTags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "searchResultId": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "knowledgeState": {
            "enum": [
              "workInProgress",
              "draft",
              "approved",
              "published",
              "archived",
              "deleted"
            ],
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "type": {
            "enum": [
              "folder",
              "article",
              "link",
              "shortcut"
            ],
            "type": "string"
          },
          "tag": {
            "enum": [
              "folder",
              "text",
              "link",
              "elearning",
              "video"
            ],
            "type": "string"
          },
          "views": {
            "format": "int32",
            "type": "integer"
          },
          "solutionRatio": {
            "format": "int32",
            "type": "integer"
          },
          "relevance": {
            "format": "double",
            "type": "number"
          },
          "urlTarget": {
            "enum": [
              "_blank",
              "_self",
              "_parent",
              "_top"
            ],
            "type": "string"
          },
          "breadcrumb": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "contentId": {
                  "format": "int32",
                  "type": "integer"
                },
                "title": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
{
  "spellCheckedSearchPhrase": "string",
  "totalResultCount": 0,
  "unFilteredResultCount": 0,
  "currentPage": 0,
  "totalPages": 0,
  "maxRelevance": 0.0,
  "searchId": "string",
  "facets": {
    "authors": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "tags": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "knowledgeStates": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "languages": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "flags": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "contentTags": [
      {
        "key": "string",
        "value": 0
      }
    ]
  },
  "result": [
    {
      "id": 0,
      "searchResultId": "string",
      "title": "string",
      "body": "string",
      "knowledgeState": "workInProgress",
      "url": "string",
      "type": "folder",
      "tag": "folder",
      "views": 0,
      "solutionRatio": 0,
      "relevance": 0.0,
      "urlTarget": "_blank",
      "breadcrumb": [
        {
          "contentId": 0,
          "title": "string",
          "url": "string"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "spellCheckedSearchPhrase": {
      "type": "string"
    },
    "totalResultCount": {
      "format": "int32",
      "type": "integer"
    },
    "unFilteredResultCount": {
      "format": "int32",
      "type": "integer"
    },
    "currentPage": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    },
    "maxRelevance": {
      "format": "double",
      "type": "number"
    },
    "searchId": {
      "type": "string"
    },
    "facets": {
      "type": "object",
      "properties": {
        "authors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "knowledgeStates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "flags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        },
        "contentTags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "format": "int32",
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "searchResultId": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "knowledgeState": {
            "enum": [
              "workInProgress",
              "draft",
              "approved",
              "published",
              "archived",
              "deleted"
            ],
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "type": {
            "enum": [
              "folder",
              "article",
              "link",
              "shortcut"
            ],
            "type": "string"
          },
          "tag": {
            "enum": [
              "folder",
              "text",
              "link",
              "elearning",
              "video"
            ],
            "type": "string"
          },
          "views": {
            "format": "int32",
            "type": "integer"
          },
          "solutionRatio": {
            "format": "int32",
            "type": "integer"
          },
          "relevance": {
            "format": "double",
            "type": "number"
          },
          "urlTarget": {
            "enum": [
              "_blank",
              "_self",
              "_parent",
              "_top"
            ],
            "type": "string"
          },
          "breadcrumb": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "contentId": {
                  "format": "int32",
                  "type": "integer"
                },
                "title": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

504 Gateway Timeout

GatewayTimeout

Code samples

@ECHO OFF

curl -v -X GET "https://api2.comaround.com/rest/v2/search/?searchPhrase={string}&contentId={integer}&currentPage={integer}&sortBy={string}&itemsPerPage={integer}&authors={array}&tags={array}&knowledgeStates={array}&highlight={string}&languages={array}&flags={array}&contentTags={array}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {id token}"

--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}");
            client.DefaultRequestHeaders.Add("Authorization", "{id token}");

            // Request parameters
            queryString["searchPhrase"] = "{string}";
            queryString["contentId"] = "{integer}";
            queryString["currentPage"] = "{integer}";
            queryString["sortBy"] = "{string}";
            queryString["itemsPerPage"] = "{integer}";
            queryString["authors"] = "{array}";
            queryString["tags"] = "{array}";
            queryString["knowledgeStates"] = "{array}";
            queryString["highlight"] = "{string}";
            queryString["languages"] = "{array}";
            queryString["flags"] = "{array}";
            queryString["contentTags"] = "{array}";
            var uri = "https://api2.comaround.com/rest/v2/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/v2/search/");

            builder.setParameter("searchPhrase", "{string}");
            builder.setParameter("contentId", "{integer}");
            builder.setParameter("currentPage", "{integer}");
            builder.setParameter("sortBy", "{string}");
            builder.setParameter("itemsPerPage", "{integer}");
            builder.setParameter("authors", "{array}");
            builder.setParameter("tags", "{array}");
            builder.setParameter("knowledgeStates", "{array}");
            builder.setParameter("highlight", "{string}");
            builder.setParameter("languages", "{array}");
            builder.setParameter("flags", "{array}");
            builder.setParameter("contentTags", "{array}");

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


            // 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}",
            "contentId": "{integer}",
            "currentPage": "{integer}",
            "sortBy": "{string}",
            "itemsPerPage": "{integer}",
            "authors": "{array}",
            "tags": "{array}",
            "knowledgeStates": "{array}",
            "highlight": "{string}",
            "languages": "{array}",
            "flags": "{array}",
            "contentTags": "{array}",
        };
      
        $.ajax({
            url: "https://api2.comaround.com/rest/v2/search/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{id token}");
            },
            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/v2/search/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"searchPhrase={string}",
                         @"contentId={integer}",
                         @"currentPage={integer}",
                         @"sortBy={string}",
                         @"itemsPerPage={integer}",
                         @"authors={array}",
                         @"tags={array}",
                         @"knowledgeStates={array}",
                         @"highlight={string}",
                         @"languages={array}",
                         @"flags={array}",
                         @"contentTags={array}",
                      ];
    
    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 setValue:@"{id token}" forHTTPHeaderField:@"Authorization"];
    // 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/v2/search/');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'searchPhrase' => '{string}',
    'contentId' => '{integer}',
    'currentPage' => '{integer}',
    'sortBy' => '{string}',
    'itemsPerPage' => '{integer}',
    'authors' => '{array}',
    'tags' => '{array}',
    'knowledgeStates' => '{array}',
    'highlight' => '{string}',
    'languages' => '{array}',
    'flags' => '{array}',
    'contentTags' => '{array}',
);

$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}',
    'Authorization': '{id token}',
}

params = urllib.urlencode({
    # Request parameters
    'searchPhrase': '{string}',
    'contentId': '{integer}',
    'currentPage': '{integer}',
    'sortBy': '{string}',
    'itemsPerPage': '{integer}',
    'authors': '{array}',
    'tags': '{array}',
    'knowledgeStates': '{array}',
    'highlight': '{string}',
    'languages': '{array}',
    'flags': '{array}',
    'contentTags': '{array}',
})

try:
    conn = httplib.HTTPSConnection('api2.comaround.com')
    conn.request("GET", "/rest/v2/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}',
    'Authorization': '{id token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'searchPhrase': '{string}',
    'contentId': '{integer}',
    'currentPage': '{integer}',
    'sortBy': '{string}',
    'itemsPerPage': '{integer}',
    'authors': '{array}',
    'tags': '{array}',
    'knowledgeStates': '{array}',
    'highlight': '{string}',
    'languages': '{array}',
    'flags': '{array}',
    'contentTags': '{array}',
})

try:
    conn = http.client.HTTPSConnection('api2.comaround.com')
    conn.request("GET", "/rest/v2/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/v2/search/')

query = URI.encode_www_form({
    # Request parameters
    'searchPhrase' => '{string}',
    'contentId' => '{integer}',
    'currentPage' => '{integer}',
    'sortBy' => '{string}',
    'itemsPerPage' => '{integer}',
    'authors' => '{array}',
    'tags' => '{array}',
    'knowledgeStates' => '{array}',
    'highlight' => '{string}',
    'languages' => '{array}',
    'flags' => '{array}',
    'contentTags' => '{array}'
})

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 headers
request['Authorization'] = '{id token}'
# 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