Retrieve Specification Items - 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

Sample URI request

To retrieve all Specification Items for a specific Specification:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationItems

To retrieve a specific Specification Item for a Specification:

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationItems(35234)

Get URI Parameter

Parameter

Description

Type

Required

Notes

Specification Item Id

Sequence of the Specification Item to which you want to retrieve the data

Integer

Required

Response

Element

Description

Type

Notes

SpecificationItemId

A unique ID for the specification

Integer

SpecificationHeaderId

A unique ID for the specification

Integer

ShortCode

Name of the short code

String

User defined short code. Users can also enter the wild card characters ('%' or '_').

GroupId

Sequence ID of group table

Integer

Generated by the software

GroupCode

Name of the group code

String

Group Code

PartId

Sequence ID of Part table

Integer

Generated by the software

PartCode

Name of the Part code

String

OptionCode

Name of Option code

String

SizeFrom1

Start of nominal size range 1

Double

SizeTo1

End of nominal size range 1

Double

SizeFrom2

Start of nominal size range 2

String

SizeTo2

End of nominal size range 2

String

SizeFrom3

Start of nominal size range 3

String

SizeTo3

End of nominal size range 3

String

SizeFrom4

Start of nominal size range 4

String

SizeTo4

End of nominal size range 4

String

SizeFrom5

Start of nominal size range 5

String

SizeTo5

End of nominal size range 5

String

Size1UnitId

Size 1 Unit Id

Integer

Size1GeometricId

Size 1 Geometric Id

Integer

Size2UnitId

Size 2 Unit Id

Integer

Size2GeometricId

Size 2 Geometric Id

Integer

Size3UnitId

Size 3 Unit Id

Integer

Size3GeometricId

Size 3 Geometric Id

Integer

Size4UnitId

Size 4 Unit Id

Integer

Size4GeometricId

Size 5 Geometric Id

Integer

Size5UnitId

Size 5 Unit Id

Integer

Size5GeometricId

Size 5 Geometric Id

Integer

CommodityId

A unique ID for the commodity code

Integer

CommodityCode

Name of the commodity code

String

CommodityShortDescription

Name of the commodity code short description

String

CommodityDescription

Name of the commodity code description

String

FirstSizeSchedule

Dynamic attribute

Secondsizesch

Dynamic attribute

SCH2

Dynamic attribute

Schedule Dependent CC

Dynamic attribute

SCH1

Dynamic attribute

Max_Temp

Dynamic attribute

Min_Temp

Dynamic attribute

MultiSizeOption

Dynamic attribute

Sample response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationItems",

"value": [

{

"SpecificationItemId": 32494,

"SpecificationHeaderId": 6201,

"ShortCode": "TOL",

"GroupId": 5008,

"GroupCode": "O",

"PartId": 5485,

"PartCode": "THL",

"OptionCode": "1",

"SizeFrom1": 2,

"SizeTo1": 24,

"SizeFrom2": ".5",

"SizeTo2": "1.5",

"SizeFrom3": null,

"SizeTo3": null,

"SizeFrom4": null,

"SizeTo4": null,

"SizeFrom5": null,

"SizeTo5": null,

"Size1UnitId": 5283,

"Size1GeometricId": null,

"Size2UnitId": 5283,

"Size2GeometricId": null,

"Size3UnitId": null,

"Size3GeometricId": null,

"Size4UnitId": null,

"Size4GeometricId": null,

"Size5UnitId": null,

"Size5GeometricId": null,

"CommodityId": 75570,

"CommodityCode": "OTHLAM9XTFACGZZZZ",

"CommodityShortDescription": " TOL , MSS SP-97 , CL6000 , FTE , ASTM A105 ",

"CommodityDescription": " Thredolet®, reducing , MSS SP-97, Integrally Reinforced Forged Branch Outlet Fittings - Socket Welding, Threaded and Buttwelding Ends , Class 6000 , Female Threaded End , ASTM A105 ",

"FirstSizeSchedule": "",

"Secondsizesch": "",

"SCH2": "",

"Schedule Dependent CC": "",

"SCH1": "",

"Max_Temp": "",

"Min_Temp": "",

"MultiSizeOption": ""

},

{

"SpecificationItemId": 32496,

"SpecificationHeaderId": 6201,

"ShortCode": "GSK",

"GroupId": 5003,

"GroupCode": "G",

"PartId": 5441,

"PartCode": "SW",

"OptionCode": "1",

"SizeFrom1": 3,

"SizeTo1": 24,

"SizeFrom2": null,

"SizeTo2": null,

"SizeFrom3": null,

"SizeTo3": null,

"SizeFrom4": null,

"SizeTo4": null,

"SizeFrom5": null,

"SizeTo5": null,

"Size1UnitId": 5283,

"Size1GeometricId": null,

"Size2UnitId": null,

"Size2GeometricId": null,

"Size3UnitId": null,

"Size3GeometricId": null,

"Size4UnitId": null,

"Size4GeometricId": null,

"Size5UnitId": null,

"Size5GeometricId": null,

"CommodityId": 113003,

"CommodityCode": "GSWAB9NAZHBACZ",

"CommodityShortDescription": " Spiral Wound Gasket , ASME B16.20, Spiral Wound Gaskets for ASME B16.5 Flanges , CL900 , 304 stainless steel (18 Cr-8 Ni) , w/ flexible graphite filler , w/ 304 SS inner ring and CS outer ring ",

"CommodityDescription": " Spiral Wound Gasket , ASME B16.20, Spiral Wound Gaskets for ASME B16.5 Flanges , Class 900 , 304 stainless steel (18 Cr-8 Ni) , w/ flexible graphite filler , w/ 304 SS inner ring and CS outer ring ",

"FirstSizeSchedule": "",

"Secondsizesch": "",

"SCH2": "",

"Schedule Dependent CC": "",

"SCH1": "",

"Max_Temp": "",

"Min_Temp": "",

"MultiSizeOption": ""

}

  • 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.