Default end points - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R1 (2.1)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R1 (2.1)

S.No

URL Name & Format

SAM Authentication

Description

1

Service description:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/description

Not Required

Include product, product name, version, scope, base Uri,
licenses, and SAM details.

Provides information that is relevant to different client applications.
For example: Smart API Manager (SAM) requires the service
description to register your Smart API.

2

Open API document:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/Doc

Not Required

Describes your Smart API and enables other applications
to read and visualize its resources.

It also describes, and constructs URI based on the metadata.

3

Smart API Explorer:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/Doc/explorer

Done via
Smart API Explorer

Acts as a web client that
allow users to explore
a Smart API directly from a browser.

To send any request from explorer,
click Authorize and provide the required details.

4

Service document:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1

Required

Service document

5

Metadata:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/$metadata

Required

Describes metadata

6

Annotations:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/Annotations/$metadata

Required

Contains entity annotations and descriptions.

7

Vocabularies:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/Vocabularies/
Capabilities/$metadata

Required

8

Capabilities:

http(s)://{{hostname}}/
{{Applicationname}}/SMAT/V1/
Capabilities/$metadata

Required

Odata vocabularies and annotations helps you in
understanding the capabilities of the Smart API.