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

PUT body

PUT

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

Where TableDetailId is the ID for which you want to update the table detail.

Element

Description

Type

Required

TableDetailName

Name of the table detail that you want to edit

String

Optional

Disused

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

String

Optional

ControlStatus

Control status of the instance that you want to edit.

Integer

Optional

BASE_MAT

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

String

Depends on required field of TableAttributes mapping

CL145

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

Integer

Depends on required field of TableAttributes mapping

WEIGHT_CODE

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

Integer

Depends on required field of TableAttributes mapping

NlsId

Language Identifier

Integer

Optional

ShortDescription

Short description of the table detail

String

Description

Description of the table detail

String

Sample request

{

"TableDetailName": "EDIT_TDN",

"BASE_MAT": "Aluminum and Aluminum Alloys",

"CL145": "1780",

"WEIGHT_CODE": "34",

"TableDetailNls": [

{

"NlsId":2,

"ShortDescription": "Needle Valve DE",

"Description": "Needle Valve DE"

}

]

}

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

Depends on required field of TableAttributes mapping

CL145

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

Integer

Depends on required field of TableAttributes mapping

WEIGHT_CODE

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

Integer

Depends on required field of TableAttributes mapping

Sample response

{

"@odata.context":

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

"TableId": 7487,

"TableGroupId": 7325,

"TableDetailId": 66410,

"Project": "SDB",

"TableDetailName": "EDIT_TDN",

"Disused": "N",

"ControlStatus": 1,

"BASE_MAT": "Aluminum and Aluminum Alloys",

"CL145": "1780",

"WEIGHT_CODE": "34"

}

Use the following sample GET method to view the associated Nls that you have created:

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

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