Retrieve Specification Header Details - 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 Specification Header Details for a specific Specification:

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

To retrieve a specific Specification Header Detail for a Specification:

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

Get URI Parameter

Parameter

Description

Type

Required

Notes

SeqId

Sequence of the Detail to which you want to retrieve the data

Integer

Required

Response

Element

Description

Type

Notes

SpecificationHeaderId

A unique ID for the specification

Integer

SeqId

Sequence of the Specification Detail

Integer

TableId

A unique ID for the table

Integer

TableName

Name of the table

String

TableGroupId

A unique ID for the table group

Integer

TableGroupName

Name of the table group.

String

TableDetailId

A unique ID for the table detail

Integer

TableDetailName

Name of the table detail

String

ShortDescription

Short description of the table

String

ControlStatus

Control status of the Specification Header Details

Integer

Default value is 1

UserName

The Smart Reference Data user login name

String

Sample response

{

"@odata.context":

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

"value": [

{

"SpecificationHeaderId": 6201,

"SeqId": 1,

"TableId": 7741,

"TableName": "P_FLUID_CODE",

"TableGroupId": 5385,

"TableGroupName": "ALL",

"TableDetailId": 13310,

"TableDetailName": "AB",

"ShortDescription": "Steam/Condensate(Non - Boiler Code)",

"ControlStatus": 1,

"UserName": "SPRDSDB"

},

{

"SpecificationHeaderId": 6201,

"SeqId": 5,

"TableId": 7743,

"TableName": "P_TEMP_LIMIT",

"TableGroupId": 5387,

"TableGroupName": "ALL",

"TableDetailId": 69052,

"TableDetailName": "FQ",

"ShortDescription": "-29°C to 425°C (-20°F to 800°F) (Note 27)",

"ControlStatus": 1,

"UserName": "SPRDSDB"

},

{

"SpecificationHeaderId": 6201,

"SeqId": 10,

"TableId": 9805,

"TableName": "P_PT_COMMENT",

"TableGroupId": 12582,

"TableGroupName": "PIP_IMP",

"TableDetailId": 70265,

"TableDetailName": "AY2",

"ShortDescription": "For NPS 1/2 through NPS 4 (Full flange ratings per ASME B16.5, Table II-2-1.1.) For NPS 6 through NPS 24 (Note 01)",

"ControlStatus": 1,

"UserName": "SPRDSDB"

}

]

}