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

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Sample URI request

To retrieve all the idents

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(75043)/Idents

To retrieve an ident for a specific Id:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(75043)/Idents(IdentId)

Parameter

Description

Type

Required

IdentId

The Ident id to which you want to retrieve the data

Integer

Required

Response

Parameter

Description

Type

Notes

IdentId

A unique ID for the Ident.

Integer

IdentCode

The ident code identifying an

item

Integer

ControlStatus

Retrieves the control status of the instance

Integer

CommodityId

A unique ID for the commodity code.

Integer

Project

Retrieves the project details for the selected ident.

String

UnitSystemId

Unit System ID

Integer

UnitSystemName

The unit system which is

applied

String

NPS1, NPS2, SCH1 and SCH2

Ident values as input

String

Sample response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(75043)/Idents",

"value": [

{

"IdentId": 4437014,

"Project": "SDB",

"IdentCode": "I4437014",

"CommodityId": 75043,

"NPS1": ".25",

"NPS2": ".125",

"SCH1": "S-10",

"SCH2": "S-10",

"ControlStatus": 1,

"UnitSystemId": 5001,

"UnitSystemName": "IMP/MET"

}

]

}

  • Dynamic attribute name and it’s label text shall not have spaces (like NPD From) as OData query operation cannot be performed on columns having spaces.

  • Dynamic attribute name and it’s label text shall not start with number (like 1_END_PRP_SP3D) as OData query operation cannot be performed on columns starting with number.