Add an Attribute - 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

POST body

Element

Description

Type

Required

Notes

AttributeGroupName

Identifies the attribute group which the current attribute is assigned to

String

Required

Attribute group name must be specified in uppercase

AttributeName

Name of the new attribute

String

Required

Attribute name must be specified in uppercase

DataWidth

Max data length of the field. The Length depends on the physical column that the attribute is assigned to.

Integer

Required

The maximum width is 14, for character(attr_char), the maximum width is 255, and for Geom-in/Outs it is 60.

FormWidth

Size of display item in user interface

String

Required

Unit

Lookup unit

String

Required

Sample request

POST https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Attributes

Authorization: Bearer <Access Token>

Content-Type: application/json

{

"AttributeName": "ADD_ATTRIBUTE",

"AttributeGroupName": "STR ATTR",

"FormWidth": 13,

"DataWidth": 12,

"Precision": null,

"Unit": "-"

}

Response

Element

Description

Type

Notes

AttributeId

A unique ID for the attributeID of the attribute

Integer

Generated by the software

AttributeName

Name of the new attribute

String

AttributeTypeId

Integer

Generated by the software

AttributeGroupName

Identifies the attribute group which the current attribute is assigned to

String

Project

The project or product group where you want to insert the attribute

String

DataType

Attribute data type that you want to assign

String

Required

Specifies if the new attribute is mandatory

String

Default value is ON

FormWidth

Size of display item in user interface

Integer

DataWidth

Max data length of the field. The length depends on the physical column that the attribute is assigned to

Integer

Default value is ‘CHAR’.Available data types are 'ALPHA', 'CHAR', 'INT', 'NUMBER', 'DATE', 'DATETIME', 'EDATE',

'JDATE', 'LONG', 'MONEY', 'RINT', 'RNUMBER', 'TIME', 'GRAPHICS'.

Precision

Digits after decimal point. The precision depends on the physical column that the attribute is assigned to.

Integer

MetrEngl

Reference to conversion table

String

Default value is S.40.04.01

UnitId

Integer

Unit

Lookup unit

String

Sample response

{

"@odata.context":

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

"AttributeId": 17979,

"AttributeName": "ADD_ATTRIBUTE",

"AttributeTypeId": 5162,

"AttributeGroupName": "STR ATTR",

"Project": "SDB",

"DataType": "CHAR",

"Required": "ON",

"FormWidth": 13,

"DataWidth": 12,

"Precision": null,

"MetrEngl": "S.40.04.01",

"UnitId": 5282,

"Unit": "-"

}