Knowledge Search

The Search API lets you perform text and/or filtered Searches on an Account's Knowledge Base.

Full Search

/Search{?*page,*perPage}

Search within your entire Knowledge Base.

Parameters

Name Type Description
text Text An all-purpose text search.
types List of Type keys Filters the Search for only the types passed.
labels List of text strings Full text search on the label property
keys List of text strings Full text search on the key property
page integer The page number.
perPage integer The total items per page. Pages are default 10 items long.
At least one argument is required to get a result.

Operations

Name HTTP Method Available
CREATE -- --
READ POST
UPDATE -- --
DELETE -- --

Request Template

POST /account/{account}/Search{?page,perPage} HTTP/1.1
Host: https://higgs.online

{text,types,labels,keys}

Response Template

HTTP/1.1 200 OK
 Date: Mon, 1 Mar 2016 11:11:11 GMT

{
  "@context": "https://higgs.online/context",
  "@id": "higgs:Response/Success",
  "@type": "higgs:Response",
  "higgs:Operation": "READ",
  "higgs:Response/Success/message": "Search returned 10 results.",
  "hsd:List": [
    {
      "@id": "higgs:account/public/Property/Person/JasonReinert/{key}",
      "@type": "higgs:Relation/Person/{key}",
      "value": "Jason",
      "dateTimeCreated": "2017-09-15 14:51:09",
      "lastModified": "2017-09-15 14:51:21"
    },
    ...
  ]
}

Search Service

GET /Search/{service}{?*page,*perPage}

Search within the different Higgs API Services.

Parameters

Name Type Description
service key The service you want to search. Ex. 'Class', 'Relation', 'Thing', 'Property', 'Entity'
text Text An all-purpose text search.
types List of Type keys Filters the Search for only the types passed.
labels List of text strings Full text search on the label property
keys List of text strings Full text search on the key property
page integer The page number.
perPage integer The total items per page. Pages are default 10 items long.

Request Template

POST /account/{account}/Search/{service}{?*page,*perPage} HTTP/1.1
Host: higgs.online
{text,types,keys,labels}

Response Template

HTTP/1.1 200 OK
Date: Mon, 1 Mar 2016 11:11:11 GMT

{
  "@context": "https://higgs.online/context",
  "@id": "higgs:Response/Success",
  "@type": "higgs:Response",
  "higgs:Operation": "READ",
  "higgs:Response/Success/message": "Search returned {totalResults} results.",
  "resource": [
    {result-1},
    {result-2},
    ...
    {result-n}
  ]
}