API Discoverability - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.2)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.2

The following section helps you to find the available projects, disciplines, and the National Language Support (NLS) in Smart Reference Data database server.

Standard URI format

https://<appserver with domain>/<virtual_directory>/Srd/V2

Resource

Description

appserver with domain

API Server where all the RESTFUL services are deployed

virtual_directory

Virtual directory on the API Server

Srd/V2

Route prefix

Retrieve all projects

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Sample request

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects

Element

Description

Type

Required

Notes

Project

Retrieves all the projects

CHAR

Required

Sample response

{

"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects",

"value": [

{

"ProjectId": "TRAINPROJ",

"Description": "Training Project"

},

{

"ProjectId": "SDB",

"Description": "SDB Standard Catalog"

}

]

}

Retrieve all disciplines

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Sample request

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('<ProjectId>')/Disciplines(<DisciplineId>)

Element

Description

Type

Required

Notes

ProjectId

Retrieves the project details from the Smart Reference Data database server.

Integer

Required

DisciplineId

Retrieves the discipline details for the selected project.

Integer

Required

Sample response

{

"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects",

"value": [

{

"ProjectId": "SDB",

"Description": "SDB Standard Catalog"

}

]

}

Retrieve all NLS

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Sample request

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('<ProjectId>')/Dsiciplines(DisciplineId)/Nls

Element

Description

Type

Required

Notes

ProjectId

Retrieves the project details from the Smart Reference Data database server.

Integer

Required

DisciplineId

Retrieves the discipline details for the selected project.

Integer

Required

Nls

Retrieves the supported languages

Integer

Required

Sample response

{

"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls",

"value": [

{

"NlsId": 1,

"Description": "English"

}

]

}

Retrieve annotations for controllers

Annotations allows you to retrieve all the available controller information in the Smart Reference Data database server.

Sample request

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Annotations/$metadata

Element

Description

Type

Required

Notes

Annotations

Retrieves all the controllers information from Smart Reference Data database server.

String

Required

$metadata

Retrieves the description of all the controllers.

String

Required

Sample response

<?xml version="1.0" encoding="utf-8"?>

<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">

<edmx:DataServices>

<Schema Namespace="Com.Ingr.Srd.V2" xmlns="http://docs.oasis-open.org/odata/ns/edm">

<Annotations Target="Com.Ingr.Srd.V2.Project">

<Annotation Term="Org.OData.Core.V2.Description" String="All the Projects accessible for this user are returned." />

</Annotations>

<Annotations Target="Com.Ingr.Srd.V2.Project/Disciplines">

<Annotation Term="Org.OData.Core.V2.Description" String="All the Disciplines accessible for this Project and user are returned." />

</Annotations>

<Annotations Target="Com.Ingr.Srd.V2.Discipline/Nls">

<Annotation Term="Org.OData.Core.V2.Description" String="All the NLS accessible for this Discipline, Project and user are returned." />

</Annotations>

<Annotations Target="Com.Ingr.Srd.V2.Nls/Attributes">

<Annotation Term="Org.OData.Core.V2.Description" String="This Object supports fetching of attributes. It also supports insertion and updating of attributes." />

</Annotations>

<Annotations Target="Com.Ingr.Srd.V2.Nls/Tables">

<Annotation Term="Org.OData.Core.V2.Description" String="This Object supports fetching of tables. It also supports insertion and updating of tables." />

</Annotations>

<Annotations Target="Com.Ingr.Srd.V2.Nls/Geometrics">

<Annotation Term="Org.OData.Core.V2.Description" String="This Object supports fetching of geometrics, geometrics details and geometric NLS. It also supports insertion and updating of geometrics, geometrics details and geometric NLS." />

</Annotations>

</Schema>

</edmx:DataServices>

</edmx:Edmx>