Add (Indexes)

URL:
https://<kgserver_datamodel_typeName_indexes-url>/add
Methods:
GET

Description

The add operation is available for the indexes resource associated with a named type in a knowledge graph service's data model. With this operation, you can add an index to a field or to multiple fields associated with an entity type or relationship type in the data model. Adding an index to text or GUID fields allows you to search their content from the knowledge graph service's graph resource.

Identify the type whose indexes you want to modify by specifying the type name. Use the data model query operation to learn about the item types that are defined in the schema and the fields already defined for that type.

You must have sufficient privileges to edit content and editing must be enabled for the knowledge graph service for this operation to be successful. You can enable editing for a knowledge graph service in the same way that you enable it for a hosted feature layer. The knowledge graph service's strict property must not be set to true, which indicates the data model cannot be modified.

Requests and responses

This operation can only be performed by sending a Protocolbuffer Binary Format (PBF)-formatted request and receiving a PBF-formatted response. Details of the request and response parameters are provided in the appropriate .proto files.

PBF request

Create a PBF-formatted request to perform this operation based on the AddIndexesRequest.proto file.

PBF response

Create a PBF-formatted response to get feedback from the operation based on the AddIndexesResponse.proto file.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.