Retrieve Specification Types - 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 Types:

GET

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

To retrieve a specific Specification Type:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects(‘SDB’)/Disciplines(5020)/Nls(1)/ SpecificationTypes(<SpecificationTypeId>)

Get URI Parameter

Parameter

Description

Type

Required

Notes

SpecificationTypeId

Id of the specification type to which you want to retrieve the data

Integer

Required

Response

Element

Description

Type

Notes

SpecificationTypeId

A unique ID for the specification Type

Integer

SpecificationTypeName

Name of the Specification Type

String

SpecificationRuleId

A unique ID for specification rule mapped to specification type

Integer

SpecificationRule

Name of the specification rule mapped to specification type

String

ControlStatus

Gets the control status of the specification type

Integer

ProjectId

Retrieves the project details for the selected specification type

String

Sample response

{

"@odata.context":

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

"SpecificationTypeId": 5120,

"SpecificationTypeName": "SDB_PIP",

"SpecificationRuleId": 5020,

"SpecificationRule": "SDB_SPEC_R",

"ControlStatus": 1,

"ProjectId": "SDB"

}