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

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

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)/ SpecificationHeaders(6201)/ SpecificationHeaderComments (<CommentId >)

Get URI Parameter

Parameter

Description

Type

Required

Notes

CommentId

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

Integer

Required

Response

Element

Description

Type

Notes

CommentId

A unique ID for the specification header comment

Integer

Sequence

Sequence ID of the specification header comment

Integer

Comment

Comment value

String

Sample response

{

"@odata.context":

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

"CommentId": 5274,

"Sequence": 2000,

"Comment": "PURPOSE AND USE OF PROCESS INDUSTRY PRACTICES"

}