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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"added" : 0
}
Produces
This API call produces the following media types according to the 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"cleared" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"cleared" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"removed" : 0
}
Produces
This API call produces the following media types according to the 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:
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 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:
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 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:
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 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:
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 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
BlacklistList
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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
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:
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 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:
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 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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
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:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"matched" : false
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"matched" : false
}
Produces
This API call produces the following media types according to the 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
Return type
Example data
Content-Type: application/json
{
"dropped" : true
}
Produces
This API call produces the following media types according to the 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
AddTermsResult
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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
EntityList
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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
ConfigurationList
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:
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 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:
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 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:
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 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:
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 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
inline_response_200_8
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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
DomainList
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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
DomainList
Highlights the supplied text (highlightPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
inline_response_200_9
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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
inline_response_200_8
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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
PathList_1
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:
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 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:
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 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:
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 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:
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 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
SentenceDetails
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:
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 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:
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 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:
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 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:
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 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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"deleted" : true
}
Produces
This API call produces the following media types according to the 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:
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 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:
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 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:
Return type
Example data
Content-Type: application/json
{
"deleted" : true
}
Produces
This API call produces the following media types according to the 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:
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 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:
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 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:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
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:
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 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:
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 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:
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 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:
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful response
SourceList