Retrieve Geometrics - 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

Sample URI request

GET https//<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Geometrics(<GeometricId>)

If no <GeometricId> is passed, the API retrieves all the available geomtrics in the Smart Reference Data database server

Example URI to retrieve all the geometrics: GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Geometrics

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Get URI Parameter

Parameter

Description

Type

Required

GeometricId

The geometric id to which you want to retrieve the data

Integer

Required

Response

Element

Description

Type

Notes

GeometricId

A unique ID for the geometric.

Integer

Generated by the software

Project

The project or product group where the geometric is created

String

DisciplineName

The associated discipline name to the geomtric

GeometricName

Name of the new geometric

String

TableId

The associated table to the geometric.

Integer

Generated by the software

StandardId

A unique standard id

Integer

StandardName

Name of the standard

String

ControlStatus

Sets the control status of the geometric

Integer

Default value is 1

NlsId

Language identifier

Integer

Required

ShortDescription

Short description of the table

String

Required

Description

Description of the table

String

Required

Sample Response

{

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

"GeometricId": 46358,

"Project": "SDB",

"DisciplineName": "PIPING",

"GeometricName": "RETRIEVE_GEOM",

"TableId": 9203,

"StandardId": 5023,

"StandardName": "CS",

"ControlStatus": 1,

}

Sample URI request by geometric name

GET https//<appserver with domain>/<virtual_directory>/Srd/V2//Projects('SDB')/Disciplines(5020)/Nls(1)/Geometrics/<Name Space>.ExistsGeometricName(GeometricName='GEO')/

Element

Description

Type

Notes

ExistsGeometricName

Name of the function to retrieve geometric by name.

String

GeometricName

Name of the function parameter that is passed to retrieve a specific geometric name

String

Example: GeometricName='Geo' retrieves all the geometric names that starts with the characters geo and also their numeric extension.

The following table shows the supported special characters for a geometric name:

Special character

Supported character

Notes

-

Same as

:

Same as

.

Same as

_

Same as

?

Replace with %3F

Example: GeometricName='Geo%3F'

$

Same as

/

Replace with !

This character can be configured in Web.config file. Example:

<appSettings>

<add key="SpecialCharacterFwdSlash" value="!" />

</appSettings>

,

Same as

+

Replace with ;

This character can be configured in Web.config file.

<appSettings>

<add key="SpecialCharacterPlus" value=";" />

</appSettings>

[

Same as

]

Same as

(

Same as

)

Same as

=

Same as

>

Same as

ß

Same as

&

Same as

*

Same as

"

Same as

Blank

Same as

Umlauts

Same as

Sample response

{

"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Collection(Com.Ingr.Srd.V1.Geometric)",

"value": [

{

"GeometricId": 50742,

"Project": "SDB",

"DisciplineName": "PIPING",

"GeometricName": "GEO",

"TableId": 7522,

"StandardName": "US",

"ControlStatus": 1,

},

{

"GeometricId": 50722,

"Project": "SDB",

"DisciplineName": "PIPING",

"GeometricName": "GEO_01",

"TableId": 7522,

"StandardName": "US",

"ControlStatus": 1,

}

]

}