API reference endpoints - Intergraph Smart Completions - Intergraph Smart Completions Update 24 - Customization & Programming

API reference endpoints - Intergraph Smart Completions - Intergraph Smart Completions Update 24 - Customization & Programming - Hexagon

Intergraph Smart Completions Smart API Programmer's Reference Guide (5.3.24)

Language

English

Product

Intergraph Smart Completions

Search by Category

Customization & Programming

Smart Completions Version

5.3.24

API reference endpoints are used to get more information about the Smart Completions API itself. As an OData-compliant API, the Smart Completions API provides the common reference endpoints, as follows.

Reference endpoint	Endpoint URL	Authentication Required?	Content
Service document	https://<hostname>/<base url>/	Yes	The service document describing the resource URL.
Service description	https://<hostname>/ <base url>/description	No	The product, product name, version, scope, base URI, licenses, and IdP details for the API. Information relevant to different client applications, for example an identity provider might require the service description to register your Smart API.
Metadata	https://<hostname>/ <base url>/$metadata	Yes	The data model of an OData API. It describes the entities, properties, relationships, and other structural information about the data.
Annotations	https://<hostname>/<base url>/Annotations/$metadata	Yes	Additional characteristics or capabilities of a metadata element, such as a service, entity type, property, function, action, or parameter.