Retrieve tables with NLS - 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)

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

GET

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Tables(7487)/TableGroups(7325)/TableDetails(20067)?$expand=TableDetailNls

Where ?$expand=TableDetailNls is the query to retrieve Nls records along with the table details.

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

Sample response

{

"@odata.context":

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

"value": [

{

"TableId": 7487,

"TableGroupId": 7325,

"TableDetailId": 20067,

"Project": "SDB",

"TableDetailName": "A",

"Disused": "Y",

"ControlStatus": 1,

"TableDetailNls": [

{

"TableId": 7487,

"TableGroupId": 7325,

"TableDetailId": 20067,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": ", Bronze Alloy Facing Disc",

"Description": ", Bronze Alloy facing Disc"

}

]

}

]

}