Sample URI request
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Attributes(<AttributeId>)
If no <AttributeId> is passed, the API retrieves all the available attributes in the Smart Reference
Data database server
Example URI to retrieve all the attributes: https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Attributes
Headers
|
Header name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/json |
Get URI Parameter
|
Parameter |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
AttributeID |
The attribute id to which you want to retrieve the data |
Integer |
Required |
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",
"value": [
{
"AttributeId": 17979,
"AttributeName": "EDIT_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": "-"
}
]
}