Retrieve Data Tables - 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

To retrieve all the Data Tables:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('TRAINPROJ')//Disciplines(5020)/Nls(1)/Interfaces(5000)/PackageTypes(5606)/ContentPackages('SDB_SPEC_EXP')/Versions(57270)/DataTables()

To retrieve a specific Data Table:

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('TRAINPROJ')//Disciplines(5020)/Nls(1)/Interfaces(5000)/PackageTypes(5606)/ContentPackages('SDB_SPEC_EXP')/Versions(57270)/DataTables(1237)

Get URI Parameter

Parameter

Description

Type

Required

DataTableID

The unique ID of the Data Table

Integer

Required

Response

Parameter

Description

Type

Notes

DataTableId

The ID of the Data Table

Integer

DataTable

The name of the Data Table

Integer

Category

The comment for the requested response

String

HelpText

The notes for the requested response

String

DataTableAction

The action taken on the data table such as addition (A), modification (M), etc.

String

Sample Response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('TRAINPROJ')/Disciplines(5020)/Nls(1)/Interfaces(5000)/PackageTypes(5606)/ContentPackages('SDB_SPEC_EXP')/Versions(57270)/DataTables",

"value": [

{

"DataTableId": 1112,

"DataTable": "PipeStock",

"Category": "PART_DEFINITION",

"HelpText": "The Pipe Stock sheet defines the pipe parts that you want in your catalog.\n(PipeStockClass Sheet orginally imported from PipingCatalog.xls)",

"DataTableAction": "A",

},

{

"DataTableId": 1237,

"DataTable": "PipingCommodityFilter",

"Category": "SPEC_ITEM_FILTER",

"HelpText": "The Piping Commodity Filter sheet defines the data required to select the piping\ncommodity and any additional data required for optional uniqueness per piping\nmaterial class. (Sheet orginally imported from PipingSpecification.xls)",

"DataTableAction": "A",

},

]

}