iKnow REST APIs

This is the OpenAPI Specification of the iKnow REST APIs, giving you RESTful access to iKnow domain contents in your system. Use swagger-ui or a similar tool to conveniently browse and test these APIs. For more information on iKnow, visit intersystems.com.
Contact Info: support@intersystems.com
Version: 1.0.0
Copyright © 1996-2018 InterSystems Corporation, Cambridge, MA. Notices/Terms & Conditions. All Rights Reserved. Privacy PolicySection 508.

Blacklists

get /domain/{domain}/blacklists
Retrieves a list of available blacklists (domainDomainBlacklistsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "blacklists" : [ {
    "elements" : [ "elements", "elements" ],
    "name" : "name",
    "description" : "description",
    "id" : 0
  }, {
    "elements" : [ "elements", "elements" ],
    "name" : "name",
    "description" : "description",
    "id" : 0
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistList
post /domain/{domain}/blacklists/{id}/add
Adds new elements to a given blacklist (domainDomainBlacklistsIdAddPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to extend

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "added" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_5
get /domain/{domain}/blacklists/{id}/add/{string}
Adds new elements to a given blacklist (domainDomainBlacklistsIdAddStringGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to extend
string (required)
Path Parameter — element to add to the blacklist

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "added" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_5
post /domain/{domain}/blacklists/{id}/add/{string}
Adds new elements to a given blacklist (domainDomainBlacklistsIdAddStringPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to extend
string (required)
Path Parameter — element to add to the blacklist

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "added" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_5
get /domain/{domain}/blacklists/{id}/clear
Clears all entries for a given blacklist (domainDomainBlacklistsIdClearGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to clear

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "cleared" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_4
post /domain/{domain}/blacklists/{id}/clear
Clears all entries for a given blacklist (domainDomainBlacklistsIdClearPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to clear

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "cleared" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_4
delete /domain/{domain}/blacklists/{id}
Drops a given blacklist (domainDomainBlacklistsIdDelete)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
get /domain/{domain}/blacklists/{id}/details
Retrieves a particular blacklist's contents (domainDomainBlacklistsIdDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist being queried

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "elements" : [ "elements", "elements" ],
  "name" : "name",
  "description" : "description",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistDetails
post /domain/{domain}/blacklists/{id}/details
Retrieves a particular blacklist's contents (domainDomainBlacklistsIdDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist being queried

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "elements" : [ "elements", "elements" ],
  "name" : "name",
  "description" : "description",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistDetails
get /domain/{domain}/blacklists/{id}/drop
Drops a given blacklist (domainDomainBlacklistsIdDropGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/blacklists/{id}/drop
Drops a given blacklist (domainDomainBlacklistsIdDropPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/blacklists/{id}/remove
Removes elements from a given blacklist (domainDomainBlacklistsIdRemovePost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to modify

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "removed" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_6
get /domain/{domain}/blacklists/{id}/remove/{string}
Removes elements from a given blacklist (domainDomainBlacklistsIdRemoveStringGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to modify
string (required)
Path Parameter — element to remove from the blacklist

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "removed" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_6
post /domain/{domain}/blacklists/{id}/remove/{string}
Removes elements from a given blacklist (domainDomainBlacklistsIdRemoveStringPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the blacklist to modify
string (required)
Path Parameter — element to remove from the blacklist

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "removed" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_6
get /domain/{domain}/blacklists/new/{name}
Creates a new blacklist (domainDomainBlacklistsNewNameGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
name (required)
Path Parameter — name of the new blacklist

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "elements" : [ "elements", "elements" ],
  "name" : "name",
  "description" : "description",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistDetails
post /domain/{domain}/blacklists/new/{name}
Creates a new blacklist (domainDomainBlacklistsNewNamePost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
name (required)
Path Parameter — name of the new blacklist

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "elements" : [ "elements", "elements" ],
  "name" : "name",
  "description" : "description",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistDetails
post /domain/{domain}/blacklists/new
Creates a new blacklist (domainDomainBlacklistsNewPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "elements" : [ "elements", "elements" ],
  "name" : "name",
  "description" : "description",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistDetails
post /domain/{domain}/blacklists
Retrieves a list of available blacklists (domainDomainBlacklistsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "blacklists" : [ {
    "elements" : [ "elements", "elements" ],
    "name" : "name",
    "description" : "description",
    "id" : 0
  }, {
    "elements" : [ "elements", "elements" ],
    "name" : "name",
    "description" : "description",
    "id" : 0
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response BlacklistList

Default

get /swagger
Retrieves Swagger definition in YAML (swaggerDefinition)
Simple endpoint to print this Swagger definition in YAML

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/x-yaml

Responses

200

successful response

DictionariesAndMatching

get /domain/{domain}/matching/dictionaries
Retrieves a list of available dictionaries (domainDomainMatchingDictionariesGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "count" : 1,
  "dictionaries" : [ {
    "name" : "name",
    "description" : "description",
    "language" : { },
    "id" : 0,
    "items" : [ {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    }, {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    } ]
  }, {
    "name" : "name",
    "description" : "description",
    "language" : { },
    "id" : 0,
    "items" : [ {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    }, {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DictionaryList
post /domain/{domain}/matching/dictionaries/{id}/add/items
Create new dictionary items (domainDomainMatchingDictionariesIdAddItemsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary to which to add the new item

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "dictionary" : {
    "name" : "name",
    "id" : 0
  },
  "matched" : true,
  "items" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response AddItemsResult
delete /domain/{domain}/matching/dictionaries/{id}
Drops a dictionary (domainDomainMatchingDictionariesIdDelete)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
get /domain/{domain}/matching/dictionaries/{id}/details
Retrieves the detailed contents for a given Dictionary (domainDomainMatchingDictionariesIdDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "description" : "description",
  "language" : { },
  "id" : 0,
  "items" : [ {
    "terms" : [ {
      "id" : 123,
      "string" : "palm tree"
    }, {
      "id" : 123,
      "string" : "palm tree"
    } ],
    "name" : "name",
    "language" : null,
    "id" : 6,
    "uri" : "uri"
  }, {
    "terms" : [ {
      "id" : 123,
      "string" : "palm tree"
    }, {
      "id" : 123,
      "string" : "palm tree"
    } ],
    "name" : "name",
    "language" : null,
    "id" : 6,
    "uri" : "uri"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DictionaryDetails
post /domain/{domain}/matching/dictionaries/{id}/details
Retrieves the detailed contents for a given Dictionary (domainDomainMatchingDictionariesIdDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "description" : "description",
  "language" : { },
  "id" : 0,
  "items" : [ {
    "terms" : [ {
      "id" : 123,
      "string" : "palm tree"
    }, {
      "id" : 123,
      "string" : "palm tree"
    } ],
    "name" : "name",
    "language" : null,
    "id" : 6,
    "uri" : "uri"
  }, {
    "terms" : [ {
      "id" : 123,
      "string" : "palm tree"
    }, {
      "id" : 123,
      "string" : "palm tree"
    } ],
    "name" : "name",
    "language" : null,
    "id" : 6,
    "uri" : "uri"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DictionaryDetails
get /domain/{domain}/matching/dictionaries/{id}/drop
Drops a dictionary (domainDomainMatchingDictionariesIdDropGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/matching/dictionaries/{id}/drop
Drops a dictionary (domainDomainMatchingDictionariesIdDropPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
get /domain/{domain}/matching/dictionaries/new/{name}
Create a new dictionary (domainDomainMatchingDictionariesNewNameGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
name (required)
Path Parameter — name for the new dictionary

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful response
post /domain/{domain}/matching/dictionaries/new/{name}
Create a new dictionary (domainDomainMatchingDictionariesNewNamePost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
name (required)
Path Parameter — name for the new dictionary

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
post /domain/{domain}/matching/dictionaries/new
Create a new dictionary (domainDomainMatchingDictionariesNewPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
post /domain/{domain}/matching/dictionaries
Retrieves a list of available dictionaries (domainDomainMatchingDictionariesPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "count" : 1,
  "dictionaries" : [ {
    "name" : "name",
    "description" : "description",
    "language" : { },
    "id" : 0,
    "items" : [ {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    }, {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    } ]
  }, {
    "name" : "name",
    "description" : "description",
    "language" : { },
    "id" : 0,
    "items" : [ {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    }, {
      "terms" : [ {
        "id" : 123,
        "string" : "palm tree"
      }, {
        "id" : 123,
        "string" : "palm tree"
      } ],
      "name" : "name",
      "language" : null,
      "id" : 6,
      "uri" : "uri"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DictionaryList
post /domain/{domain}/matching/items/{id}/add/terms
Create new dictionary terms (domainDomainMatchingItemsIdAddTermsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID or URI of the dictionary item to which to add the new terms

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "dictionary" : {
      "name" : "name",
      "id" : 6
    },
    "name" : "name",
    "id" : 0,
    "uri" : "uri"
  },
  "terms" : "",
  "matched" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response AddTermsResult
delete /domain/{domain}/matching/items/{id}
Drops a dictionary item (domainDomainMatchingItemsIdDelete)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID or URI of the dictionary item to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
get /domain/{domain}/matching/items/{id}/details
Retrieves the detailed contents for a given Dictionary Item (domainDomainMatchingItemsIdDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID or URI of the dictionary item to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful response
post /domain/{domain}/matching/items/{id}/details
Retrieves the detailed contents for a given Dictionary Item (domainDomainMatchingItemsIdDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID or URI of the dictionary item to retrieve

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful response
get /domain/{domain}/matching/items/{id}/drop
Drops a dictionary item (domainDomainMatchingItemsIdDropGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID or URI of the dictionary item to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/matching/items/{id}/drop
Drops a dictionary item (domainDomainMatchingItemsIdDropPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID or URI of the dictionary item to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/matching/items/new
Create new dictionary items (domainDomainMatchingItemsNewPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "dictionary" : {
    "name" : "name",
    "id" : 0
  },
  "matched" : true,
  "items" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response AddItemsResult
get /domain/{domain}/matching/match
Matches all sources against the current dictionary contents (domainDomainMatchingMatchGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "matched" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_7
get /domain/{domain}/matching/match/{id}
Matches a particular source against the current dictionary contents (domainDomainMatchingMatchIdGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "matched" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_7
post /domain/{domain}/matching/match/{id}
Matches a particular source against the current dictionary contents (domainDomainMatchingMatchIdPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "matched" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_7
post /domain/{domain}/matching/match
Matches all sources against the current dictionary contents (domainDomainMatchingMatchPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "matched" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_7
get /domain/{domain}/matching/matches/by/item/{id}
Retrieves all dictionary matches for a dictionary item (domainDomainMatchingMatchesByItemIdGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — the dictionary item ID or URI to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "matches" : [ {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  }, {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response MatchList
post /domain/{domain}/matching/matches/by/item/{id}
Retrieves all dictionary matches for a dictionary item (domainDomainMatchingMatchesByItemIdPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — the dictionary item ID or URI to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "matches" : [ {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  }, {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response MatchList
get /domain/{domain}/matching/matches/by/source/{id}
Retrieves all dictionary matches for a given source (domainDomainMatchingMatchesBySourceIdGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "matches" : [ {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  }, {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response MatchList
post /domain/{domain}/matching/matches/by/source/{id}
Retrieves all dictionary matches for a given source (domainDomainMatchingMatchesBySourceIdPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "matches" : [ {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  }, {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response MatchList
delete /domain/{domain}/matching/terms/{id}
Drops a dictionary term (domainDomainMatchingTermsIdDelete)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary term to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
get /domain/{domain}/matching/terms/{id}/drop
Drops a dictionary term (domainDomainMatchingTermsIdDropGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary term to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/matching/terms/{id}/drop
Drops a dictionary term (domainDomainMatchingTermsIdDropPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — ID of the dictionary term to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dropped" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_3
post /domain/{domain}/matching/terms/new
Create new dictionary terms (domainDomainMatchingTermsNewPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "dictionary" : {
      "name" : "name",
      "id" : 6
    },
    "name" : "name",
    "id" : 0,
    "uri" : "uri"
  },
  "terms" : "",
  "matched" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response AddTermsResult

Entities

post /domain/{domain}/entities/details
Retrieves details for the supplied entity (domainDomainEntitiesDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "id" : 0,
  "metricsAsConcept" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  },
  "value" : "value",
  "metricsAsAny" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  },
  "metricsAsRelation" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityDetails
get /domain/{domain}/entities/{entity}/details
Retrieves details for the supplied entity (domainDomainEntitiesEntityDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity whose details need to be returned

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "id" : 0,
  "metricsAsConcept" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  },
  "value" : "value",
  "metricsAsAny" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  },
  "metricsAsRelation" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityDetails
post /domain/{domain}/entities/{entity}/details
Retrieves details for the supplied entity (domainDomainEntitiesEntityDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity whose details need to be returned

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "id" : 0,
  "metricsAsConcept" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  },
  "value" : "value",
  "metricsAsAny" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  },
  "metricsAsRelation" : {
    "tfidf" : 5.962133916683182377482808078639209270477294921875,
    "frequency" : 6,
    "spread" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityDetails
get /domain/{domain}/entities/{entity}/related
Retrieves entities related to a seed entity based on proximity or direct relationships (domainDomainEntitiesEntityRelatedGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the seed entity to find related entities for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList
post /domain/{domain}/entities/{entity}/related
Retrieves entities related to a seed entity based on proximity or direct relationships (domainDomainEntitiesEntityRelatedPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the seed entity to find related entities for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList
get /domain/{domain}/entities
Retrieves the top entities for this domain (domainDomainEntitiesGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "bm25" : 2.3021358869347654518833223846741020679473876953125,
    "id" : 0,
    "dominance" : 5.962133916683182377482808078639209270477294921875,
    "tfidf" : 5.63737665663332876420099637471139430999755859375,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "bm25" : 2.3021358869347654518833223846741020679473876953125,
    "id" : 0,
    "dominance" : 5.962133916683182377482808078639209270477294921875,
    "tfidf" : 5.63737665663332876420099637471139430999755859375,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList_1
post /domain/{domain}/entities
Retrieves the top entities for this domain (domainDomainEntitiesPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "bm25" : 2.3021358869347654518833223846741020679473876953125,
    "id" : 0,
    "dominance" : 5.962133916683182377482808078639209270477294921875,
    "tfidf" : 5.63737665663332876420099637471139430999755859375,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "bm25" : 2.3021358869347654518833223846741020679473876953125,
    "id" : 0,
    "dominance" : 5.962133916683182377482808078639209270477294921875,
    "tfidf" : 5.63737665663332876420099637471139430999755859375,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList_2
post /domain/{domain}/entities/related
Retrieves entities related to a seed entity based on proximity or direct relationships (domainDomainEntitiesRelatedPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList
post /domain/{domain}/entities/similar
Retrieves entities similar to a seed string (domainDomainEntitiesSimilarPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList
get /domain/{domain}/entities/{string}/similar
Retrieves entities similar to a seed string (domainDomainEntitiesStringSimilarGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
string (required)
Path Parameter — the seed string to find similar entities for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList
post /domain/{domain}/entities/{string}/similar
Retrieves entities similar to a seed string (domainDomainEntitiesStringSimilarPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
string (required)
Path Parameter — the seed string to find similar entities for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "entities" : [ {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  }, {
    "id" : 0,
    "value" : "value",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response EntityList

Miscellaneous

get /configurations
Retrieves all the configurations for this namespace, with basic info (configurationsGet)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "configurations" : [ {
    "maxConceptLength" : 6,
    "languages" : [ { }, { } ],
    "name" : "name",
    "id" : 0,
    "userDictionary" : {
      "entries" : [ {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      }, {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      } ],
      "name" : "name"
    }
  }, {
    "maxConceptLength" : 6,
    "languages" : [ { }, { } ],
    "name" : "name",
    "id" : 0,
    "userDictionary" : {
      "entries" : [ {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      }, {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      } ],
      "name" : "name"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response ConfigurationList
post /configurations
Retrieves all the configurations for this namespace, with basic info (configurationsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — additional parameters to configure this query

Return type

Example data

Content-Type: application/json
{
  "configurations" : [ {
    "maxConceptLength" : 6,
    "languages" : [ { }, { } ],
    "name" : "name",
    "id" : 0,
    "userDictionary" : {
      "entries" : [ {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      }, {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      } ],
      "name" : "name"
    }
  }, {
    "maxConceptLength" : 6,
    "languages" : [ { }, { } ],
    "name" : "name",
    "id" : 0,
    "userDictionary" : {
      "entries" : [ {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      }, {
        "string" : "string",
        "label" : "label",
        "rewrite" : "rewrite"
      } ],
      "name" : "name"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response ConfigurationList
get /domain/{domain}/details
Retrieve more detailed information about an individual domain (domainDomainDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "metadata" : [ {
    "operators" : [ { }, { } ],
    "dataType" : "string",
    "name" : "name",
    "id" : 6,
    "storage" : "storage"
  }, {
    "operators" : [ { }, { } ],
    "dataType" : "string",
    "name" : "name",
    "id" : 6,
    "storage" : "storage"
  } ],
  "name" : "name",
  "id" : 0,
  "parameters" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DomainDetails
post /domain/{domain}/details
Retrieve more detailed information about an individual domain (domainDomainDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "metadata" : [ {
    "operators" : [ { }, { } ],
    "dataType" : "string",
    "name" : "name",
    "id" : 6,
    "storage" : "storage"
  }, {
    "operators" : [ { }, { } ],
    "dataType" : "string",
    "name" : "name",
    "id" : 6,
    "storage" : "storage"
  } ],
  "name" : "name",
  "id" : 0,
  "parameters" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DomainDetails
post /domain/{domain}/highlight
Highlights the supplied text (domainDomainHighlightPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "text" : "text"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_9
post /domain/{domain}/index
Indexes the supplied text and returns concepts, relations and CRCs (domainDomainIndexPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "concepts" : [ {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  }, {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  } ],
  "text" : "text",
  "relations" : [ {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  }, {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  } ],
  "matches" : [ {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  }, {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_8
get /domains
Retrieves all the domains for this namespace, with basic info (domainsGet)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "domains" : [ {
    "definitionClass" : "definitionClass",
    "sourceCount" : 6,
    "name" : "name",
    "id" : 0,
    "version" : 1
  }, {
    "definitionClass" : "definitionClass",
    "sourceCount" : 6,
    "name" : "name",
    "id" : 0,
    "version" : 1
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DomainList
post /domains
Retrieves all the domains for this namespace, with basic info (domainsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "domains" : [ {
    "definitionClass" : "definitionClass",
    "sourceCount" : 6,
    "name" : "name",
    "id" : 0,
    "version" : 1
  }, {
    "definitionClass" : "definitionClass",
    "sourceCount" : 6,
    "name" : "name",
    "id" : 0,
    "version" : 1
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response DomainList
post /highlight
Highlights the supplied text (highlightPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "text" : "text"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_9
post /index
Indexes the supplied text and returns concepts, relations and CRCs (indexPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "concepts" : [ {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  }, {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  } ],
  "text" : "text",
  "relations" : [ {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  }, {
    "dominance" : 6,
    "value" : "value",
    "frequency" : 0
  } ],
  "matches" : [ {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  }, {
    "partialCount" : 1,
    "sentence" : "sentence",
    "score" : 6.02745618307040320615897144307382404804229736328125,
    "ordered" : true,
    "elements" : [ {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    }, {
      "output" : "output",
      "score" : 4.1456080298839363962315474054776132106781005859375,
      "negated" : true,
      "role" : "concept",
      "partId" : 2,
      "entityId" : 7,
      "matchedWords" : "matchedWords",
      "entity" : "entity",
      "literal" : "literal"
    } ],
    "sentenceId" : 3,
    "term" : {
      "item" : {
        "dictionary" : {
          "name" : "name",
          "id" : 7
        },
        "name" : "name",
        "id" : 2,
        "uri" : "uri"
      },
      "string" : "string",
      "id" : 5
    },
    "id" : 0,
    "negatedCount" : 5,
    "target" : {
      "id" : 9,
      "type" : "entity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_8

PathsAndCRCs

get /domain/{domain}/crcs/by/entity/{entity}
Retrieves the CRCs containing a designated entity (domainDomainCrcsByEntityEntityGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "crcs" : [ {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  }, {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response CRCList
post /domain/{domain}/crcs/by/entity/{entity}
Retrieves the CRCs containing a designated entity (domainDomainCrcsByEntityEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "crcs" : [ {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  }, {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response CRCList
post /domain/{domain}/crcs/by/entity
Retrieves the CRCs containing a designated entity (domainDomainCrcsByEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "crcs" : [ {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  }, {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response CRCList
get /domain/{domain}/crcs
Retrieves the top CRCs for this domain (domainDomainCrcsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "crcs" : [ {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  }, {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response CRCList
post /domain/{domain}/crcs
Retrieves the top CRCs for this domain (domainDomainCrcsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "crcs" : [ {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  }, {
    "slave" : "slave",
    "id" : 0,
    "master" : "master",
    "relation" : "relation",
    "frequency" : 6,
    "spread" : 1
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response CRCList
get /domain/{domain}/paths/by/entity/{entity}
Retrieves the paths containing a designated entity (domainDomainPathsByEntityEntityGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "paths" : [ {
    "entities" : [ {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    } ],
    "id" : 0
  }, {
    "entities" : [ {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    } ],
    "id" : 0
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response PathList
post /domain/{domain}/paths/by/entity/{entity}
Retrieves the paths containing a designated entity (domainDomainPathsByEntityEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "paths" : [ {
    "entities" : [ {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    } ],
    "id" : 0
  }, {
    "entities" : [ {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    } ],
    "id" : 0
  } ],
  "count" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response PathList_1
post /domain/{domain}/paths/by/entity
Retrieves the paths containing a designated entity (domainDomainPathsByEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "paths" : [ {
    "entities" : [ {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    } ],
    "id" : 0
  }, {
    "entities" : [ {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "id" : 6,
      "stemId" : 5,
      "entity" : "entity",
      "stem" : "stem"
    } ],
    "id" : 0
  } ],
  "count" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response PathList_1

Sentences

get /domain/{domain}/sentences/by/entity/{entity}
Retrieves the sentences containing a given entity (domainDomainSentencesByEntityEntityGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sentences" : [ {
    "sourceId" : 6,
    "parts" : [ {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    } ],
    "id" : 0,
    "text" : "text"
  }, {
    "sourceId" : 6,
    "parts" : [ {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    } ],
    "id" : 0,
    "text" : "text"
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SentenceList
post /domain/{domain}/sentences/by/entity/{entity}
Retrieves the sentences containing a given entity (domainDomainSentencesByEntityEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sentences" : [ {
    "sourceId" : 6,
    "parts" : [ {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    } ],
    "id" : 0,
    "text" : "text"
  }, {
    "sourceId" : 6,
    "parts" : [ {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    } ],
    "id" : 0,
    "text" : "text"
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SentenceList
post /domain/{domain}/sentences/by/entity
Retrieves the sentences containing a given entity (domainDomainSentencesByEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — the entity to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sentences" : [ {
    "sourceId" : 6,
    "parts" : [ {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    } ],
    "id" : 0,
    "text" : "text"
  }, {
    "sourceId" : 6,
    "parts" : [ {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    }, {
      "role" : "concept",
      "partId" : 1,
      "entityId" : 5,
      "attributes" : [ {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      }, {
        "level" : "path",
        "words" : "words",
        "type" : "type"
      } ],
      "stemId" : "stemId",
      "entity" : "entity",
      "literal" : "literal",
      "stem" : "stem"
    } ],
    "id" : 0,
    "text" : "text"
  } ],
  "count" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SentenceList
get /domain/{domain}/sentences/{id}/details
Retrieves the details for a particular sentence (domainDomainSentencesIdDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — the sentence ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "sourceId" : 6,
  "parts" : [ {
    "role" : "concept",
    "partId" : 1,
    "entityId" : 5,
    "attributes" : [ {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    }, {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    } ],
    "stemId" : "stemId",
    "entity" : "entity",
    "literal" : "literal",
    "stem" : "stem"
  }, {
    "role" : "concept",
    "partId" : 1,
    "entityId" : 5,
    "attributes" : [ {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    }, {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    } ],
    "stemId" : "stemId",
    "entity" : "entity",
    "literal" : "literal",
    "stem" : "stem"
  } ],
  "id" : 0,
  "text" : "text"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SentenceDetails
post /domain/{domain}/sentences/{id}/details
Retrieves the details for a particular sentence (domainDomainSentencesIdDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
id (required)
Path Parameter — the sentence ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sourceId" : 6,
  "parts" : [ {
    "role" : "concept",
    "partId" : 1,
    "entityId" : 5,
    "attributes" : [ {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    }, {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    } ],
    "stemId" : "stemId",
    "entity" : "entity",
    "literal" : "literal",
    "stem" : "stem"
  }, {
    "role" : "concept",
    "partId" : 1,
    "entityId" : 5,
    "attributes" : [ {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    }, {
      "level" : "path",
      "words" : "words",
      "type" : "type"
    } ],
    "stemId" : "stemId",
    "entity" : "entity",
    "literal" : "literal",
    "stem" : "stem"
  } ],
  "id" : 0,
  "text" : "text"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SentenceDetails

Sources

get /domain/{domain}/sources/by/crc/{crc}
Retrieves all sources containing the supplied CRC (domainDomainSourcesByCrcCrcGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
crc (required)
Path Parameter — CRC to look for, as a colon-separated sequence of master, relation and slave.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
post /domain/{domain}/sources/by/crc/{crc}
Retrieves all sources containing the supplied CRC (domainDomainSourcesByCrcCrcPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
crc (required)
Path Parameter — CRC to look for, as a colon-separated sequence of master, relation and slave. If supplied in the request object, that value will take precedence over the path parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
post /domain/{domain}/sources/by/crc
Retrieves all sources containing the supplied CRC (domainDomainSourcesByCrcPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
get /domain/{domain}/sources
Retrieves all sources matching the supplied filter (domainDomainSourcesGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
post /domain/{domain}/sources/new
Adds a source to the domain (domainDomainSourcesNewPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200
post /domain/{domain}/sources
Retrieves all sources matching the supplied filter (domainDomainSourcesPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
delete /domain/{domain}/sources/{source}
Deletes a source from the domain (domainDomainSourcesSourceDelete)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "deleted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_1
get /domain/{domain}/sources/{source}/details
Retrieves the details of a particular source (domainDomainSourcesSourceDetailsGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "metadata" : "{}",
  "virtual" : true,
  "text" : "text"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response Source
post /domain/{domain}/sources/{source}/details
Retrieves the details of a particular source (domainDomainSourcesSourceDetailsPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "metadata" : "{}",
  "virtual" : true,
  "text" : "text"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response Source
get /domain/{domain}/sources/{source}/drop
Deletes a source from the domain (domainDomainSourcesSourceDropGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "deleted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_1
post /domain/{domain}/sources/{source}/drop
Deletes a source from the domain (domainDomainSourcesSourceDropPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to drop

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "deleted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_1
post /domain/{domain}/sources/{source}/set/metadata
Registers metadata values for a given source (domainDomainSourcesSourceSetMetadataPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID whose metadata needs updating

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "updated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_2
get /domain/{domain}/sources/{source}/similar
Retrieves all sources similar to a seed source (domainDomainSourcesSourceSimilarGet)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful response
post /domain/{domain}/sources/{source}/similar
Retrieves all sources similar to a seed source (domainDomainSourcesSourceSimilarPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
source (required)
Path Parameter — the source ID to query for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
get /domain/{domain}/sources/by/entity/{entity}
Retrieves all sources containing the supplied entity (sourcesByEntityPost)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — entity to look for.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
post /domain/{domain}/sources/by/entity/{entity}
Retrieves all sources containing the supplied entity (sourcesByEntityPost_1)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query
entity (required)
Path Parameter — entity to look for. If supplied in the request object, that value will take precedence over the path parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList
post /domain/{domain}/sources/by/entity
Retrieves all sources containing the supplied entity (sourcesByEntityPost_2)

Path parameters

domain (required)
Path Parameter — the ID of the domain to query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Body Parameter — JSON object with a list of query-specific arguments

Return type

Example data

Content-Type: application/json
{
  "sources" : [ {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  }, {
    "snippet" : "snippet",
    "metadata" : "{}",
    "id" : 0,
    "extId" : "extId"
  } ],
  "count" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response SourceList

Models

Table of Contents

  1. AddItemsResult
  2. AddTermsResult
  3. AttributeInfo
  4. BlacklistDetails
  5. BlacklistList
  6. Blacklists
  7. CRC
  8. CRCList
  9. CRC_1
  10. Configuration
  11. ConfigurationList
  12. CountOnly
  13. DictionaryDetails
  14. DictionaryDetails_1
  15. DictionaryDetails_2
  16. DictionaryItemDetails
  17. DictionaryItemDetails_1
  18. DictionaryList
  19. DictionaryTermDetails
  20. Domain
  21. DomainDetails
  22. DomainDetails_metadata
  23. DomainList
  24. Entity
  25. EntityDetails
  26. EntityDetails_metricsAsConcept
  27. EntityList
  28. EntityList_1
  29. EntityList_2
  30. Entity_1
  31. Filter
  32. FilterMode
  33. Highlighting
  34. HighlightingRule
  35. IncludeCount
  36. LanguageCode
  37. MatchList
  38. MatchListItem
  39. MatchTarget
  40. MatchedDictionary
  41. MatchedElements
  42. MatchedItem
  43. MatchedTerm
  44. MetadataOperator
  45. PageNumber
  46. PageSize
  47. Path
  48. PathEntity
  49. PathList
  50. PathList_1
  51. RequestBody
  52. RequestBody_1
  53. RequestBody_10
  54. RequestBody_11
  55. RequestBody_12
  56. RequestBody_13
  57. RequestBody_14
  58. RequestBody_15
  59. RequestBody_16
  60. RequestBody_17
  61. RequestBody_18
  62. RequestBody_19
  63. RequestBody_2
  64. RequestBody_20
  65. RequestBody_21
  66. RequestBody_22
  67. RequestBody_23
  68. RequestBody_24
  69. RequestBody_25
  70. RequestBody_26
  71. RequestBody_27
  72. RequestBody_28
  73. RequestBody_29
  74. RequestBody_3
  75. RequestBody_30
  76. RequestBody_31
  77. RequestBody_32
  78. RequestBody_33
  79. RequestBody_34
  80. RequestBody_35
  81. RequestBody_36
  82. RequestBody_37
  83. RequestBody_38
  84. RequestBody_39
  85. RequestBody_4
  86. RequestBody_40
  87. RequestBody_41
  88. RequestBody_42
  89. RequestBody_43
  90. RequestBody_44
  91. RequestBody_45
  92. RequestBody_46
  93. RequestBody_47
  94. RequestBody_48
  95. RequestBody_5
  96. RequestBody_6
  97. RequestBody_7
  98. RequestBody_8
  99. RequestBody_9
  100. SentenceDetails
  101. SentenceList
  102. SentencePart
  103. Source
  104. SourceList
  105. Source_1
  106. UserDictionary
  107. UserDictionaryEntry
  108. inline_response_200
  109. inline_response_200_1
  110. inline_response_200_2
  111. inline_response_200_3
  112. inline_response_200_4
  113. inline_response_200_5
  114. inline_response_200_6
  115. inline_response_200_7
  116. inline_response_200_8
  117. inline_response_200_8_concepts
  118. inline_response_200_9

AddItemsResult Up

dictionary (optional)
items (optional)
matched (optional)
Boolean format: integer

AddTermsResult Up

item (optional)
terms (optional)
matched (optional)
Boolean format: integer

AttributeInfo Up

type
String name of the attribute
level
String level at which the attribute applies
Enum:
path
word
words (optional)
String if level="word", the actual words affected

BlacklistDetails Up

id
name
description (optional)
elements (optional)

BlacklistList Up

blacklists

Blacklists Up

array of blacklist IDs or names to use for limiting query results, OR a valid SELECT clause retrieving entity values outright

CRC Up

master (optional)
String entity value of the master concept
relation
String entity value of the relation
slave (optional)
String entity value of the slave concept

CRCList Up

crcs
count (optional)
Integer number of result CRCs (ignoring page and pageSize)

CRC_1 Up

id
Integer unique entity ID
master (optional)
String entity value of the master concept
relation
String entity value of the relation
slave (optional)
String entity value of the slave concept
frequency
Integer number of times the CRC occurs in the result set
spread
Integer number of distinct sources the CRC occurs in in the result set

Configuration Up

id
name
languages
userDictionary (optional)
maxConceptLength (optional)

ConfigurationList Up

configurations

CountOnly Up

whether or not to retrieve just the count and no result list

DictionaryDetails Up

id
name
language (optional)
description (optional)
items (optional)

DictionaryDetails_1 Up

the dictionary these items were added to
id (optional)
name (optional)

DictionaryDetails_2 Up

the dictionary these terms were added to
id (optional)
name (optional)

DictionaryItemDetails Up

id
name
String display label
uri
String unique, domain-wide identifier for this Dictionary Item
language (optional)
terms (optional)

DictionaryItemDetails_1 Up

the dictionary item these terms were added to
id (optional)
name (optional)
uri (optional)
dictionary (optional)

DictionaryList Up

dictionaries
count (optional)
Integer total number of dictionaries (ignoring page and pageSize)

DictionaryTermDetails Up

id
language (optional)
string (optional)
String if this is a regular term, the term string value
regexp (optional)
String if this is a regular expression format term, the regular expression
replace (optional)
String if this is a regular expression format term, the replacement string
formatClass (optional)
String if this is a format term, the name of the format implementation class
formatParams (optional)
array[String] if this is a format term, any additional parameters for the format implementation class

Domain Up

id
name
definitionClass (optional)
sourceCount (optional)
version (optional)

DomainDetails Up

id
name
parameters (optional)
metadata (optional)

DomainDetails_metadata Up

id
name
operators
dataType
Enum:
string
number
date
storage

DomainList Up

domains

Entity Up

id
Integer unique entity ID
value
String entity value
frequency (optional)
Integer number of times the entity occurs in the result set
spread (optional)
Integer number of distinct sources the entity occurs in in the result set

EntityDetails Up

id
Integer unique entity ID
value
String entity value
metricsAsConcept (optional)
metricsAsRelation (optional)
metricsAsAny (optional)

EntityDetails_metricsAsConcept Up

frequency (optional)
Integer number of times the entity occurs in the result set
spread (optional)
Integer number of distinct sources the entity occurs in in the result set
tfidf (optional)
BigDecimal TFIDF-based metric expressing relevance of the entity in this result set

EntityList Up

list of entities
entities (optional)
count (optional)
Integer number of result entities (ignoring page and pageSize)

EntityList_1 Up

entities (optional)

EntityList_2 Up

entities (optional)
count (optional)
Integer total number of entities in this domain (if RequestBody.includeCount is true, ignoring page and pageSize)

Entity_1 Up

id
Integer unique entity ID
value
String entity value
frequency (optional)
Integer number of times the entity occurs in the result set
spread (optional)
Integer number of distinct sources the entity occurs in in the result set
dominance (optional)
BigDecimal relevance of the entity in this result set
tfidf (optional)
BigDecimal TFIDF-based metric expressing relevance of the entity in this result set
bm25 (optional)
BigDecimal BM25-based metric expressing relevance of the entity in this result set

Filter Up

filter object restricting the sources to be considered in this query
ids (optional)
array[Integer] for use with source-ID-based filters
extIds (optional)
array[String] for use with external-ID-based filters
operator (optional)
String for use with group filters ("AND"|"OR") or metadata-based filters (any other value)
Enum:
AND
OR
=
!=
<
>
>=
<=
BETWEEN
IS NULL
IS NOT NULL
field (optional)
String for use with metadata-based filters
value (optional)
String for use with metadata-based filters
negate (optional)
Boolean for use with group filters
filters (optional)
array[Filter] for use with group filters
className (optional)
String use for filters not covered by other shorthands
arguments (optional)
array[String] for use with 'className' property, any arguments to be passed to the filter's %New() method (except domain ID)

FilterMode Up

filter mode to use for optionally recalculating certain metrics. Defaults to recalculating all and re-sorting the results (15).

Highlighting Up

array of highlighting rules

HighlightingRule Up

"style" property is mandatory, then pick one selector per rule
style
String style specification for this highlighting rule: either a two-character sequence or a HTML tag to use for wrapping the to-be-highlighted element. Use one selector per highlighting rule.
entities (optional)
array[String] selector - selects list of entities
role (optional)
String selector - selects all entities with this role
Enum:
concept
relation
pathRelevant
nonRelevant
attribute (optional)
String selector - selects all entities affected by this attribute
Enum:
negation
positiveSentiment
negativeSentiment
attributeWords (optional)
String selector - selects all marker terms indicating this attribute
Enum:
negation
positiveSentiment
negativeSentiment
anyMatch (optional)
Boolean selector - selects any dictionary match
dictionaries (optional)
array[Integer] selector - selects any dictionary match of the specified dictionary IDs
dictionaryItems (optional)
array[Integer] selector - selects any dictionary match of the specified dictionary item IDs
matchType (optional)
String refines the "anyMatch", "dictionaries" or "dictionaryItems" selectors to the designated match type
Enum:
full
partial

IncludeCount Up

whether or not to include a count of all results (ignoring page and pageSize)

LanguageCode Up

2-letter ISO language code

MatchList Up

matches

MatchListItem Up

id
score
BigDecimal aggregated score for this match
partialCount (optional)
Integer number of partially matched entities for this match
ordered (optional)
Boolean whether or not the matched entities appear in the term's order format: integer
negatedCount (optional)
Integer number of entities
term (optional)
target (optional)
sentenceId (optional)
sentence (optional)
String full text of the sentence where the match occurred
elements (optional)
array[MatchedElements] detailed overview of entity-level match results

MatchTarget Up

the matched piece of the source text
id (optional)
type (optional)
Enum:
entity
crc
path
sentence

MatchedDictionary Up

id
name

MatchedElements Up

partId
Integer entity occurrence / part ID of the matched sentence part
literal
String literal string how this part appeared in the sentence
score
BigDecimal entity-level score
role
String role of this sentence part
Enum:
concept
relation
pathRelevant
matchedWords
String which words within the entity actually matched
negated
Boolean whether this sentence part is part of a negative context format: integer
entityId (optional)
Integer entity ID, if this part corresponds to an entity
entity (optional)
String entity value, if this part corresponds to an entity
output (optional)
String format output, if this part corresponds to a matched format providing output

MatchedItem Up

id
name
uri
dictionary (optional)

MatchedTerm Up

id
string (optional)
item (optional)

MetadataOperator Up

PageNumber Up

which "page" of the results to retrieve

PageSize Up

how many results to retrieve per "page"

Path Up

id (optional)
Integer path ID
entities (optional)
array[PathEntity] entities in this path

PathEntity Up

id
Integer unique entity ID
entity
String entity value
partId (optional)
Integer entity occurrence ID
role (optional)
String role of this entity in the path
Enum:
concept
relation
pathRelevant
stemId (optional)
Integer stem ID for this entity, if the domain is configured for stemming
stem (optional)
String stem value of this entity, if the domain is configured for stemming
attributes (optional)
array[AttributeInfo] semantic attributes for this entity

PathList Up

paths (optional)

PathList_1 Up

paths (optional)
count (optional)
Integer total number of paths, ignoring page and pageSize

RequestBody Up

page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
blacklists (optional)
sortBy (optional)
String criterion to use for retrieving the top entities
Enum:
frequency
spread
domainDefault
dominance
bm25
tfidf
useStems (optional)
Integer retrieve stems rather than entities. (only available when the domain has stemming enabled and for certain sortBy values) format: integer
role (optional)
String whether to retrieve top concepts, relationships or both (only available for certain sortBy values)
Enum:
concept
relation
any
includeMetrics (optional)
array[String] additional metrics to retrieve, on top of what is automatically retrieved based on the sortBy value
Enum:
includeCount (optional)
countOnly (optional)

RequestBody_1 Up

string (optional)
String if set, overrides value of path parameter
page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
blacklists (optional)
type (optional)
String method to calculate / retrieve similar entities. ("ngrams" requires the domain to be configured for it)
Enum:
domainDefault
parts
ngrams
words
useStems (optional)
Boolean retrieve stems rather than entities. (only available when the domain has stemming enabled and for certain sortBy values) format: integer
role (optional)
String whether to retrieve top concepts, relationships or both (only available for certain sortBy values)
Enum:
concept
relation
any
includeCount (optional)
countOnly (optional)

RequestBody_10 Up

crc (optional)
array[CRC] if supplied, overwrites the value of the "crc" path parameter
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeMetadata (optional)
Boolean whether or not to include metadata for each retrieved source format: integer
includeSnippets (optional)
Boolean if set to true, a snippet made up of all the sentences containing the designated CRCs will be retrieved for each source format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_11 Up

crc
array[CRC] the CRC to look for
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeMetadata (optional)
Boolean whether or not to include metadata for each retrieved source format: integer
includeSnippets (optional)
Boolean if set to true, a snippet made up of all the sentences containing the designated CRCs will be retrieved for each source format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_12 Up

page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
algorithm (optional)
String algorithm to use for calculating similar entities
Enum:
simple
dominantEntities
parameters (optional)
array[String] additional parameters to tune the algorithm
includeMetadata (optional)
Boolean whether or not to include metadata for each retrieved source format: integer
includeSnippets (optional)
Integer if set to a nonzero value, a snippet of the designated length (in sentences) will be retrieved for each source

RequestBody_13 Up

includeMetadata (optional)
Boolean whether or not to include metadata for the designated source format: integer
includeText (optional)
Boolean whether or not to include the full source text in the result format: integer
summarize (optional)
BigDecimal if set, the text returned will be a summary of the full contents, measuring this many sentences
virtual (optional)
Boolean if set to true, the source ID will be considered to refer to a virtual source format: integer
highlight (optional)

RequestBody_14 Up

reference
String a string to be used for building the new record's external ID
text
String the text to index
configuration (optional)
String name of a valid configuration object to use or the two-letter ISO code for the language to use (if no such configuration exists)
virtual (optional)
Boolean if true, the source will be added as a virtual one format: integer
metadata (optional)
Object map of metadata field values to set for the document

RequestBody_15 Up

virtual (optional)
Boolean if set, the supplied source ID will be used to look up a virtual source format: integer

RequestBody_16 Up

metadata (optional)
Object map of metadata field values to set for this source

RequestBody_17 Up

entity (optional)
array[String] if set, takes precedence over the corresponding path parameter
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeDetails (optional)
Boolean whether or not to include details on the entities for each sentence format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_18 Up

entity (optional)
array[String] if set, takes precedence over the corresponding path parameter
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeDetails (optional)
Boolean whether or not to include details on the entities for each sentence format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_19 Up

entity (optional)
array[String] if set, takes precedence over the corresponding path parameter
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeDetails (optional)
Boolean whether or not to include details on the entities for each sentence format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_2 Up

string
String the seed string to find similar entities for
page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
blacklists (optional)
type (optional)
String method to calculate / retrieve similar entities. ("ngrams" requires the domain to be configured for it)
Enum:
domainDefault
parts
ngrams
words
useStems (optional)
Boolean retrieve stems rather than entities. (only available when the domain has stemming enabled and for certain sortBy values) format: integer
role (optional)
String whether to retrieve top concepts, relationships or both (only available for certain sortBy values)
Enum:
concept
relation
any
includeCount (optional)
countOnly (optional)

RequestBody_20 Up

highlight (optional)
virtualSourceId (optional)
Integer if set, the sentence will be looked up in the context of this virtual source

RequestBody_21 Up

page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
sortBy (optional)
String criterion to use for retrieving the top entities
Enum:
frequency
spread
domainDefault
includeCount (optional)
countOnly (optional)

RequestBody_22 Up

entity (optional)
array[String] if set, takes precedence over the path parameter
page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
positions (optional)
array[String] CRC positions to query
Enum:
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
includeCount (optional)
countOnly (optional)

RequestBody_23 Up

entity
array[String] seed entity or list of entities to query for
page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
positions (optional)
array[String] CRC positions to query
Enum:
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
includeCount (optional)
countOnly (optional)

RequestBody_24 Up

entity (optional)
array[String] if set, takes precedence over the path parameter
page (optional)
pageSize (optional)
filter (optional)
includeDetails (optional)
Boolean whether or not to include details on the entities for each path format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_25 Up

entity
array[String] seed entity or list of entities to query paths for
page (optional)
pageSize (optional)
filter (optional)
includeDetails (optional)
Boolean whether or not to include details on the entities for each path format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_26 Up

includeDetails (optional)
Boolean whether or not to retrieve blacklists' contents as well format: integer
includeCrossDomain (optional)
Boolean whether or not to include cross-domain blacklists format: integer

RequestBody_27 Up

name (optional)
String overrides what's passed in through the path parameter if set
description (optional)
elements (optional)

RequestBody_28 Up

name
String name for the new blacklist
description (optional)
elements (optional)

RequestBody_29 Up

elements (optional)
array[String] if set, overrides what's passed in through the path parameter

RequestBody_3 Up

entity (optional)
String if set, overrides value of path parameter
page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
blacklists (optional)
sortBy (optional)
String criterion to use for retrieving the related entities
Enum:
proximity
frequency
spread
includeCount (optional)
countOnly (optional)

RequestBody_30 Up

elements
array[String] array of entries to add to the blacklist

RequestBody_31 Up

elements (optional)
array[String] if set, overrides what's passed in through the path parameter

RequestBody_32 Up

elements
array[String] element or list of elements to remove from the blacklist

RequestBody_33 Up

includeItems (optional)
Boolean whether or not to include item and term details as well format: integer
includeCount (optional)
countOnly (optional)

RequestBody_34 Up

name (optional)
String if provided, overrides the path parameter
description (optional)
language (optional)
LanguageCode default language for dictionary entries
items (optional)
array[DictionaryItemDetails] list of items to add (don't supply id values)
match (optional)
Boolean if set to true, the dictionary is immediately matched against the domain's sources format: integer
filter (optional)
Filter if match=1, restricts the sources to be matched

RequestBody_35 Up

name
String name for the new dictionary
description (optional)
language (optional)
LanguageCode default language for dictionary entries
items (optional)
array[DictionaryItemDetails] list of items to add (don't supply id values)
match (optional)
Boolean if set to true, the dictionary is immediately matched against the domain's sources format: integer
filter (optional)
Filter if match=1, restricts the sources to be matched

RequestBody_36 Up

dictionaryId (optional)
String if provided, overrides the path parameter
items (optional)
array[DictionaryItemDetails] list of items to add (don't supply id values)
match (optional)
Boolean if set to true, the dictionary is immediately matched against the domain's sources format: integer
filter (optional)
Filter if match=1, restricts the sources to be matched

RequestBody_37 Up

dictionaryId
String if provided, overrides the path parameter
items
array[DictionaryItemDetails] list of items to add (don't supply id values)
match (optional)
Boolean if set to true, the dictionary is immediately matched against the domain's sources format: integer
filter (optional)
Filter if match=1, restricts the sources to be matched

RequestBody_38 Up

dictionaryItemId (optional)
String if provided, overrides the corresponding path parameter
terms (optional)
array[DictionaryTermDetails] list of terms to add (don't supply id values). An array of strings will be interpreted as simple terms.
match (optional)
Boolean if set to true, the dictionary is immediately matched against the domain's sources format: integer
filter (optional)
Filter if match=1, restricts the sources to be matched

RequestBody_39 Up

dictionaryItemId
String if provided, overrides the corresponding path parameter
terms
array[DictionaryTermDetails] list of terms to add (don't supply id values). An array of strings will be interpreted as simple terms.
match (optional)
Boolean if set to true, the dictionary is immediately matched against the domain's sources format: integer
filter (optional)
Filter if match=1, restricts the sources to be matched

RequestBody_4 Up

entity (optional)
String the seed entity to find related ones for
page (optional)
pageSize (optional)
filter (optional)
filterMode (optional)
blacklists (optional)
sortBy (optional)
String criterion to use for retrieving the related entities
Enum:
proximity
frequency
spread
includeCount (optional)
countOnly (optional)

RequestBody_40 Up

filter (optional)
Filter optionally limits the operation to those sources selected by this filter
dictionaries (optional)
array[Integer] if set, limits the operation to these dictionary IDs

RequestBody_41 Up

dictionaries (optional)
array[Integer] if set, limits the operation to these dictionary IDs

RequestBody_42 Up

page (optional)
pageSize (optional)
matchFirst (optional)
Boolean ensures this source is matched against the latest dictionaries before retrieving results format: integer
dictionaries (optional)
array[Integer] if set, limits results to these dictionary IDs
includeDictionaryDetails (optional)
Boolean whether or not to retrieve dictionary details as well format: integer
includeMatchDetails (optional)
Boolean whether or not to retrieve entity-level match details as well format: integer
includeSnippets (optional)
Boolean whether or not to include the text of the matched sentence format: integer
highlight (optional)

RequestBody_43 Up

page (optional)
pageSize (optional)
filter (optional)
Filter optionally filters the results to those matches in sources selected by this filter
matchFirst (optional)
Boolean ensures the domain is matched against the latest dictionaries before retrieving results format: integer
includeDictionaryDetails (optional)
Boolean whether or not to dictionary details as well format: integer
includeMatchDetails (optional)
Boolean whether or not to entity-level match details as well format: integer
includeSnippets (optional)
Boolean whether or not to include the text of the matched sentence format: integer
highlight (optional)

RequestBody_44 Up

text
String the text to index
configuration (optional)
String name of a valid configuration object to use or the two-letter ISO code for the language to use (if no such configuration exists)
summarize (optional)
BigDecimal if set to a nonzero value, the text returned will be a summary of the full contents, measuring this many sentences
highlight
Highlighting highlighting specification
includeMatches (optional)
Boolean whether or not to retrieve dictionary matches for the indexed record format: integer
dictionaries (optional)
array[Integer] if set, limits results to these dictionary IDs
includeDictionaryDetails (optional)
Boolean whether or not to retrieve dictionary details as well format: integer
includeMatchDetails (optional)
Boolean whether or not to entity-level match details as well format: integer

RequestBody_45 Up

text
String the text to index
configuration (optional)
String name of a valid configuration object to use or the two-letter ISO code for the language to use (if no such configuration exists)
summarize (optional)
BigDecimal if set to a nonzero value, the text returned will be a summary of the full contents, measuring this many sentences
highlight
Highlighting highlighting specification
includeMatches (optional)
Boolean whether or not to retrieve dictionary matches for the indexed record format: integer
dictionaries (optional)
array[Integer] if set, limits results to these dictionary IDs
includeDictionaryDetails (optional)
Boolean whether or not to retrieve dictionary details as well format: integer
includeMatchDetails (optional)
Boolean whether or not to entity-level match details as well format: integer

RequestBody_46 Up

text
String the text to highlight
configuration (optional)
String name of a valid configuration object to use or the two-letter ISO code for the language to use (if no such configuration exists)
highlight
Highlighting highlighting specification

RequestBody_47 Up

text
String the text to highlight
configuration (optional)
String name of a valid configuration object to use or the two-letter ISO code for the language to use (if no such configuration exists)
highlight
Highlighting highlighting specification

RequestBody_48 Up

includeUserDictionaryContents (optional)
Boolean Whether or not to include user dictionary contents format: integer

RequestBody_5 Up

entity (optional)
String if set, overrides the value of the path parameter
filter (optional)
Filter if set, restricts the dataset on which metrics should be based
useStems (optional)
Boolean only available when the domain has stemming enabled format: integer
roles (optional)
array[String] roles for which the metrics need to be retrieved
Enum:
includeMetrics (optional)
array[String] metrics to retrieve
Enum:

RequestBody_6 Up

entity
String if set, overrides the value of the path parameter
filter (optional)
Filter if set, restricts the dataset on which metrics should be based
useStems (optional)
Boolean only available when the domain has stemming enabled format: integer
roles (optional)
array[String] roles for which the metrics need to be retrieved
Enum:
includeMetrics (optional)
array[String] metrics to retrieve
Enum:

RequestBody_7 Up

page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeMetadata (optional)
Boolean whether or not to include metadata for each retrieved source format: integer
includeSnippets (optional)
Integer if set to a nonzero value, a snippet of the designated length (in sentences) will be retrieved for each source
includeCount (optional)
countOnly (optional)

RequestBody_8 Up

entity (optional)
array[String] if supplied, overwrites the value of the "entity" path parameter
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeMetadata (optional)
Boolean whether or not to include metadata for each retrieved source format: integer
includeSnippets (optional)
Boolean if set to true, a snippet made up of all sentences containing the designated entities will be retrieved for each source format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

RequestBody_9 Up

entity
array[String] the entity or list of entities to query for
page (optional)
pageSize (optional)
filter (optional)
highlight (optional)
includeMetadata (optional)
Boolean whether or not to include metadata for each retrieved source format: integer
includeSnippets (optional)
Boolean if set to true, a snippet made up of all sentences containing the designated entities will be retrieved for each source format: integer
actualFormOnly (optional)
Boolean when this domain supports stemming, set to true to restrict to the supplied actual form only format: integer
setOperation (optional)
String when supplying multiple entities, controls how the results for each entity should be combined
Enum:
union
intersect
includeCount (optional)
countOnly (optional)

SentenceDetails Up

id
Integer sentence ID
sourceId
Integer containing source ID
text
String sentence text, optionally highlighted
parts (optional)
array[SentencePart] entities in this sentence

SentenceList Up

sentences
count (optional)
Integer total number of paths, ignoring page and pageSize (if RequestBody.includeCount is set)

SentencePart Up

partId
Integer entity / part occurrence ID
literal
String literal value of this part in the sentence
role
String role of this entity in the path
Enum:
concept
relation
pathRelevant
entityId (optional)
Integer unique entity ID, if this is not a non-relevant
entity (optional)
String entity value, if this is not a non-relevant
stemId (optional)
String stem ID for this entity, if the domain is configured for stemming
stem (optional)
String stem value of this entity, if the domain is configured for stemming
attributes (optional)
array[AttributeInfo] semantic attributes for this entity

Source Up

text (optional)
String textual contents (optionally summarized) of this source
metadata (optional)
Object metadata map for this source
virtual (optional)
Boolean whether or not this is a virtual source format: integer

SourceList Up

list of sources
sources
count (optional)
Integer number of result sources (ignoring page and pageSize)

Source_1 Up

id
Integer source ID
extId
String external ID
metadata (optional)
Object map of metadata field values
snippet (optional)
String snippet (summary) of the retrieved source

UserDictionary Up

name (optional)
entries

UserDictionaryEntry Up

string
rewrite (optional)
label (optional)

inline_response_200 Up

id
Integer source ID of the newly created record

inline_response_200_1 Up

deleted
Boolean format: integer

inline_response_200_2 Up

updated
Boolean format: integer

inline_response_200_3 Up

dropped (optional)
Boolean format: integer

inline_response_200_4 Up

cleared (optional)
Boolean format: integer

inline_response_200_5 Up

added (optional)
Integer number of elements added

inline_response_200_6 Up

removed (optional)
Integer number of elements removed

inline_response_200_7 Up

matched (optional)
Boolean format: integer

inline_response_200_8 Up

text
String the highlighted text
concepts (optional)
array[inline_response_200_8_concepts] list of concepts for this text
relations (optional)
array[inline_response_200_8_concepts] list of relations for this text
matches (optional)
array[MatchListItem] list of dictionary matches for this text

inline_response_200_8_concepts Up

value (optional)
frequency (optional)
dominance (optional)

inline_response_200_9 Up

text
String the highlighted text