Edit a Table Group 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

Headers

Header name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

PUT body

Element

Description

Type

Notes

TableGroupName

Name of the table detail

String

StandardName

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

Depends on required field of TableAttributes mapping

BDIA

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

Integer

Depends on required field of TableAttributes mapping

A0_SR_NUM

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

CDLST_NUM

CDLST_NUM attribute is associated with ATTR_NUM2 physical attribute for parent physical table

NlsId

Language identifier

Integer

ControlStatus

Sets the control status of the instance

Integer

ShortDesription

Short description of language identifier

String

Description

Description of language identifier

String

Sample request

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

{

"TableGroupName": "VN_DE_UPDT",

"StandardName": "US",

"ControlStatus": 1,

"BASE_MAT": "1",

"BDIA": "",

"A0_SR_NUM": "11",

"CDLST_NUM": "",

"TableGroupNls": [

{

"NlsId": 1,

"ControlStatus": 1,

"ShortDescription": "All Standards",

"Description": "All Standards"

}

]

}

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

BASE_MAT

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

String

BDIA

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

String

A0_SR_NUM

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

Integer

CDLST_NUM

CDLST_NUM attribute is associated with ATTR_NUM2 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(7477)/TableGroups/$entity",

"TableId": 7477,

"TableGroupId": 13266,

"Project": "SDB",

"TableGroupName": "VN_DE_UPDT",

"StandardId": 5021,

"StandardName": "US",

"ControlStatus": 1,

"BASE_MAT": "1",

"BDIA": "",

"A0_SR_NUM": "11",

"CDLST_NUM": ""

}