Retrieve a Geometric with Nls - Intergraph Smart Reference Data - Version 2016 R4 (8.4) - Administration & Configuration - Intergraph

Intergraph Smart Reference Data REST API 2016 R4 (8.4)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Administration & Configuration
Smart Materials/Smart Reference Data Version
2016 R4 (8.4)

Sample URI request

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Geometrics(<GeomtricId>)?$expand=GeomtricNls

Where ?$expand=GeometricsNls is the query to retrieve Nls records along with the geometric details.

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

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",

"value": [

{

"GeometricId": 46358,

"Project": "SDB",

"DisciplineName": "PIPING",

"GeometricName": "RETRIEVE_GEOM",

"TableId": 9203,

"StandardId": 5023,

"StandardName": "CS",

"ControlStatus": 1,

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

"GeometricNls": [

{

"GeometricId": 46358,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "MY_SD",

"Description": "MY-D"

}

]

}

]

}