Retrieve Tables with NLS - 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

GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Tables(7490)/TableGroups?$expand=TableGroupNls

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

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

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

NlsId

Language identifier

Integer

Required

ShortDescription

Short description of the table

String

Required

Description

Description of the table

String

Required

ControlStatus

Sets the control status of the table group

Integer

Default value is 1

Sample response

{

"@odata.context": "//<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,

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

"TableGroupNls": [

{

"TableId": 7490,

"TableGroupId": 5175,

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "Needle Valve US",

"Description": "Needle Valve US"

},

{

"TableId": 7490,

"TableGroupId": 5175,

"NlsId": 2,

"ControlStatus": 1,

"ShortDescription": "Needle Valve US",

"Description": "Needle Valve US"

}

]

}