APIs to search the Entity Grid
| Operation | Description |
|---|---|
| GET /entitysets/search/prepare | Optimize subsequent search calls |
| GET /entitysets/search | Search for EntitySets |
| GET /entitysets/search/autocomplete | Autocomplete search keywords |
APIs to get information on datasets through data profiling
| Operation | Description |
|---|---|
| GET /content-types/{schema}/{object} | Content-type identification |
APIs to manage publications to the Entity Grid
| Operation | Description |
|---|---|
| PUT /publications/{publicationArtifact} | Publish contents to the Entity Grid |
| DELETE /publications/{publicationArtifact} | Unpublish contents from the Entity Grid |
Identifies content-types of catalog object's attributes in SAP HANA through data profiling.
| schema | schema of the catalog object |
path | string | |
| object | name of the catalog object |
path | string | |
| attributes | Attributes for which to identify the content-type. If unspecified all attributes will have their content-type identified. |
query | string[] | |
| useCache | specify whether the previous values of content-types found can be used |
query | boolean | |
| code | Type of content-type code to return. Possible values are 'ESS' and 'DQ'. ESS codes are business codes that can be reused in Enterprise Semantic Services Search (see ESS Search syntax). 'DQ' codes are technical codes that are commonly used in other SAP Data Quality (DQ) products. Default is 'ESS'. |
query | string , x ∈ { ESS (default) , DQ } |
Successful response
Invalid request
Server error
Search the EntityGrid using a keywords-based query. This will return EntitySets the user is allowed to consume, along with matching information.
| q | search query string (see Enterprise Semantic Services Search syntax) |
query | string | |
| domain | Domain(s) to consider for term mappings in search. Supports comma-separated values and * wildcards. If unspecified, term mappings will be applied independently of domains. Valid domains are available in this column: "SAP_HANA_IM_ESS"."sap.hana.im.ess.services.search::Mapping"."LIST_ID" |
query | string | |
| language | Language used for term mappings. If unspecified, term mappings will be applied independently of language. Supported values are language codes in this table: "SYS"."M_TEXT_ANALYSIS_LANGUAGES". |
query | string | |
| fields | Fields of matched entitysets to return. If unspecified all fields will be returned. This should contain a comma-separated list of properties fields within the searchResults structure. For instance :"id, name" will only return the id and name of matched EntitySets in the Search Result. Structural properties will be return by default with all of their sub-properties, unless a list is specified within brackets. For instance: "id, name, matchDescription(annotations), attributes(matchDescription,name), representedObjects". |
query | string | |
| limit | number of results to return per request |
query | integer 10 | |
| offset | Number of results to skip in the response. Use it with limit to paginate results. For instance: limit: 10, offset: 0 (get first 10 results) limit: 10, offset: 10 (get next 10 results). |
query | integer |
Successful response
response
pagination offset specified in request
number of results returned in this response
total number of results for the search query (regardless of offset and limit)
| Link | pagination link headers (see http://tools.ietf.org/html/rfc5988) with first, previous, next and last links |
string |
| X-Total-Count | total number of search results |
integer |
Invalid request
Server error
Autocomplete keywords used in EntitySets search query with keywords present in the Entity Grid.
| q | partial search query |
query | string | |
| highlightStart | Highlight characters for autocomplete response. If specified, the autocompletions will contain display texts highlighted with the start and end tags. If set to null, the suggestion response will not contain any display text. Both properties highlightStart and highlightEnd should be set together. |
query | string <b> | |
| hightlightEnd | see highlightStart |
query | string </b> |
Successful responses
Invalid request
Server error
This method performs once per session preparation for an XS session. This offers an opportunity to perform costly operations in the background to improve application responsiveness. In the current implementation, it computes user credential mask that may take several seconds. The call to this method is optional. If this method is not called prior to suggestion or search, the calculation of the user credential mask is triggered by the first call to suggestion or search.
Success
Deletes a publication from the Entity Grid. Enterprise Semantic Services Crawlers will asynchronously remove all associated contents from the Entity Grid.
| publicationArtifact | A publicationArtifactIdentifier is the qualified name of an SAP HANA artifact to publish or unpublish in the Entity Grid.
|
path | string | #/parameters/PublicationArtifactIdentifier |
| publisherGroup | Defines the ownership of the specified publication within the EntityGrid. When a publication is added under a specific publisherGroup, the corresponding entitysets can only be unpublished by the same publisherGroup. A single publication artifact can belong to different publisherGroups. In that case, the corresponding entitysets will be unpublished when all publisherGroups decide to delete those publications. |
query | string | #/parameters/PublisherGroup |
| artifactType | The publicationArtifactType identifies the type of artifact to publish. It must be a string in one of the following enumerations, based on the type of artifact:
|
query | string | #/parameters/PublicationArtifactType |
Successful deletion
Invalid request
Server error
Adds a publication to the Entity Grid. Enterprise Semantic Services Crawlers will asynchronously extract all referenced contents and store it inside the Entity Grid.
| publicationArtifact | A publicationArtifactIdentifier is the qualified name of an SAP HANA artifact to publish or unpublish in the Entity Grid.
|
path | string | #/parameters/PublicationArtifactIdentifier |
| publisherGroup | Defines the ownership of the specified publication within the EntityGrid. When a publication is added under a specific publisherGroup, the corresponding entitysets can only be unpublished by the same publisherGroup. A single publication artifact can belong to different publisherGroups. In that case, the corresponding entitysets will be unpublished when all publisherGroups decide to delete those publications. |
query | string | #/parameters/PublisherGroup |
| artifactType | The publicationArtifactType identifies the type of artifact to publish. It must be a string in one of the following enumerations, based on the type of artifact:
|
query | string | #/parameters/PublicationArtifactType |
| computeContentTypes | whether to compute content-types after publication (by data profiling) |
query | boolean | |
| computeEnumeratedValues | Whether to compute enumerated values after publication (by data profiling). This value can only be true if computeContentTypes is true. |
query | boolean |
Successful creation
Invalid request
Server error
The identifier of the measure or dimension that can be common to a group of attributes (in the case the measure or dimension is implemented by one or more attributes).
role the attribute plays in the given measure or dimension.
indication of the confidence for this content-type
if the content-type has an associated format (for instance date), it is shown here. Currently supported formats are 'DATE_MDY','DATE_YMD','DATE_YDM','DATE_DMY'
score given to the content-type (between 0 and 100).
if this content-type is identified without ambiguity and good confidence, it is declared as a winner. There can be 0 or 1 winner in the list of content-types for a given attribute
only applies to external represented objects. This provides all necessary information about an external data source for identifying it.
type of the DataSource
id of the DataSource within the EntityGrid
list of key/value properties that identify the DataSource and are necessary to connect to it.
Enterprise Semantic Services error code
localized error message
stack trace (for SAP support only)
Describes what was matched in the object during the search
Matching annotations (textual description of metadata objects)
Matching terms in the search query. See search syntax for the definition of a search term.
Matching values. This is only applicable to attributes that have been profiled.
Id of the matched EntitySet in the EntityGrid.
Ranking of this result. Note that some results can have the same rank.
List of matching attributes
RepresentedObjects with location=REMOTE have a RemoteLocationDescriptor that defines the properties to specify in the remoteLocation clause for creating a virtual table using the CREATE VIRTUAL TABLE statement.
Each EntitySet represents one or more representedObjects, which can be local SAP HANA catalog objects, SAP HANA remote objects (associated with a remote source), and external objects (for objects outside SAP HANA)
local: represents a local SAP HANA object in the same SAP HANA instance as Enterprise Semantic Services
remote: represents a remote object of a specific remote source defined in the SAP HANA instance
external: represents an external objects in an external datasource