Retrieve Idents based on Composite Keys - Intergraph Smart Reference Data - Version 2020 (10.0) - Help - Intergraph

Intergraph Smart Reference Data REST API (2020)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
2020 (10.0)

Sample URI request

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityParts(5368)/CommodityCodes(66006)/Idents(10916201)/IdentNls(IdentId=10916201,NlsId=1)

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Response

Parameter

Description

Type

Notes

IdentId

The Ident id to which you want to retrieve the data

NlsId

Language identifier

Integer

ShortDescription

Short description of the ident

String

Description

Description of the ident

String

ControlStatus

Control status of the instance

Integer

Optional

Project

Retrieves the project details for the selected ident

String

Sample response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5000)/CommodityParts(5368)/CommodityCodes(66006)/Idents(10916201)/IdentNls/$entity",

"IdentId": 10916201,

"NlsId": 1,

"ShortDescription": "DN #DN# #DA# x #WD#",

"Description": "DN #DN# OD #da# x WT #wd#",

"ControlStatus": 1,

"Project": "SDB"

}

This is the filtered response using the composite keys i.e. IdentId=10916201 and NlsId=1