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 |
|
DataWidh |
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 |
|
|
NlsId |
Language identifier |
Integer |
Required |
|
|
LabelText |
Label of the attribute |
String |
Required |
|
|
HintText |
Hint text that you want to apply for the attribute |
String |
Required |
|
|
HelpText |
Help text for the attribute |
String |
Optional |
Default is NULL |
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": "-",
"AttributeNls":[
{
"NlsId": 1,
"LabelText": "IDENT_CODE",
"HintText": "IDENT_CODE",
"HelpText": "IDENT_CODE"
},
{
"NlsId": 2,
"LabelText": "IDENT_CODE",
"HintText": "IDENT_CODE",
"HelpText": "Ident1"
}
]
}
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 |
To view the Nls records, use the expand=AttributeNls query.
Sample URI link,
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Attributes(17982)?$expand=AttributeNls
Response Body
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/Attributes",
"value": [
{
"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": "-",
"AttributeNls@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/Attributes(17982)(17982)/AttributeNls",
"AttributeNls": [
{
"AttributeId": 17979,
"NlsId": 2,
"LabelText": "IDENT_CODE",
"HintText": "IDENT_CODE",
"HelpText": "Ident1"
},
{
"AttributeId": 17979,
"NlsId": 1,
"LabelText": "IDENT_CODE",
"HintText": "IDENT_CODE",
"HelpText": "IDENT_CODE"
}
]
}
]
}