Edit a Geometric with Nls - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.1)

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

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

POST body

Element

Description

Type

Required

Notes

GeometricName

Name of the geometric table that you want to edit.

String

Required

TableId

Identifies the table to which the new geometric must be assigned

String

Required

StandardName

GeometricNls

Class that holds the Nls elements

String

Required

NlsId

Language Identifier

Integer

Required

ShortDescription

Short descriptive text that you want to edit

String

Required

Description

Descriptive text

String

Required

Sample request

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

Where GeometricId is the geometric that you want to edit.

{

"GeometricName": "EDIT_Geom",

"TableId": 9203,

"StandardName":"CS",

"GeometricNls": [

{

"NlsId": 1,

"ShortDescription": "MY_SD",

"Description": "MY-D"

}

]

}

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

"TableId": 9203,

"StandardId": 5023,

"StandardName": "CS",

"ControlStatus": 1,

}

Use the following sample GET method to view the associated geometrics and the Nls that you have created:

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

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