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)

Retrieves all the table groups for a specified table ID.

Sample URI request

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

If no <TableGroupId> is passed, the API retrieves all the available table groups for the specified table 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

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

TableID

The table id to which you want to retrieve the table group

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

Project

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

String

TableGroupName

Name of the table group.

String

StandardId

A unique standard id.

String

StandardName

Name of the standard

String

ControlStatus

Sets the control status of the instance.

Default value is 1

Sample response

{

"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/Tables(7490)/TableGroups",

"value": [

{

"TableId": 7490,

"TableGroupId": 5175,

"Project": "SDB",

"TableGroupName": "VN_US",

"StandardId": 5021,

"StandardName": "US",

"ControlStatus": 1,

},

{

"TableId": 7490,

"TableGroupId": 5594,

"Project": "SDB",

"TableGroupName": "VN_AS",

"StandardId": 5061,

"StandardName": "AS",

"ControlStatus": 1,

},

{

"TableId": 7490,

"TableGroupId": 5746,

"Project": "SDB",

"TableGroupName": "VN_JS",

"StandardId": 5024,

"StandardName": "JS",

"ControlStatus": 1,

},

  • 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.