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

GET

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

To retrieve a specific Specification Header Note for a Specification:

GET

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

Get URI Parameter

Parameter

Description

Type

Required

Notes

SpecificationHeaderNoteId

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

Integer

Required

Response

Element

Description

Type

Notes

SpecificationHeaderNoteId

A unique ID for the specification header Note

Integer

SpecificationHeaderId

A unique ID for the specification header Id of the specific specification header note

Integer

NoteId

A unique ID for Note

Integer

Note

Description of the note

String

NoteCode

Name of the Note

String

SpecificationTypeId

A unique ID for the specification Type Id of the specification header of the specific specification header note

Integer

ControlStatus

Sets the control status of the table group

Integer

Sample response

{

"@odata.context":

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

"value": [

{

"SpecificationHeaderNoteId": 5331,

"SpecificationHeaderId": 6201,

"NoteId": 5187,

"SpecificationTypeId": 5120,

"NoteCode": "R03",

"Note": "PIP PNSMV003 - Carbon Steel Gate Valve Descriptions",

"ControlStatus": 1

}

]

}