Retrieve Table Groups - 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)

Sample URI request

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Tables(7487)/TableGroups(7325)/TableDetails(<TableDetailId>)

If no <TableDetailId> is passed, the API retrieves all the available table details for the specified table and table group in the Smart Reference Data database server.

Example URI to retrieve all the table details: https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Tables(7487)/TableGroups(7325)/TableDetails

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

Get URI Parameter

Parameter

Description

Type

Required

TableDetailId

The tabled detail id to which you want to retrieve the data

Integer

Required

Response

Element

Description

Type

Notes

TableId

A unique ID for the table.

Integer

Generated by the software

TableGroupId

A unique ID for the table group.

Integer

TableDetailId

A unique ID for the table detail.

Project

The project or product group from where the table is retrieved.

String

TableDetailName

Name of the table detail.

String

Disused

Is the table detail outdated and not used anymore? Y or N. Uppercase.

String

Default value is N

ControlStatus

Sets the control status of the instance.

Default value is 1

BASE_MAT

BASE_MAT attribute is associated with ATTR_CHAR1 physical attribute for parent physical table

String

CL145

CLI45 attribute is associated with ATTR_CHAR2 physical attribute for parent physical table

Integer

WEIGHT_CODE

WEIGHT_CODE attribute is associated with ATTR_NUM1 physical attribute for parent physical table

Integer

Sample response

{

"@odata.context":

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

"TableId": 7471,

"TableGroupId": 5337,

"TableDetailId": 11276,

"Project": "SDB",

"TableDetailName": "A1",

"Disused": "N",

"ControlStatus": 1,

"BASE_MAT": "Aluminum and Aluminum Alloys",

"CL145": "1780",

"WEIGHT_CODE": "34"

}

  • Dynamic attribute name and it’s label text shall not have spaces (like NPD From) as OData query operation cannot be performed on columns having spaces.

  • Dynamic attribute name and it’s label text shall not start with number (like 1_END_PRP_SP3D) as OData query operation cannot be performed on columns starting with number.