Retrieve Specification Item Notes - 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)

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 Item Notes for a specific Specification:

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

To retrieve a specific Specification Item Note for a Specification:

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

Get URI Parameter

Parameter

Description

Type

Required

Notes

Specification Item Note Id

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

Integer

Required

Response

Element

Description

Type

Notes

SpecificationItemNoteId

Sequence ID of Specification Item Note table

Integer

Generated by the software

SpecificationItemId

Sequence ID of Specification Item table

Integer

SpecificationHeaderId

Sequence ID of Specification Header table

Integer

SpecificationTypeId

Sequence ID of Specification Type table

Integer

NoteId

Sequence ID of Note table

Integer

NoteCode

Name of the Note code

String

Note

Name of the note

String

ControlStatus

Control status of the specification item note

Integer

Sample response

{

"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('TRAINPROJ')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationItems(32494)/SpecificationItemNotes",

"value": [

{

"SpecificationItemNoteId": 6159,

"SpecificationItemId": 32494,

"SpecificationHeaderId": 6201,

"SpecificationTypeId": 5120,

"NoteId": 5192,

"NoteCode": "03",

"Note": "Threaded joints are permitted only at the outlet of vent and drain valves, hydrostatic connections, outlet of instrument take-off valves, and to match equipment.",

"ControlStatus": 1

}

]

}