Sample URI request
To retrieve all the commodity groups with Nls:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(78386)/Idents/?$expand=IdentNls
Where ?$expand=IdentNls is the query to retrieve Nls records along with the ident.
To retrieve a ident with Nls for a specific Id:
GET
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(78386)/Idents(<IdentId>)?$expand=IdentNls
Headers
|
Header name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/json |
Response
|
Parameter |
Description |
Type |
Notes |
|---|---|---|---|
|
IdentId |
A unique ID for the Ident. |
Integer |
|
|
IdentCode |
The ident code identifying an item |
Integer |
|
|
ControlStatus |
Retrieves the control status of the instance |
Integer |
|
|
CommodityId |
A unique ID for the commodity code. |
Integer |
|
|
Project |
Retrieves the project details for the selected ident. |
String |
|
|
UnitSystemId |
Unit System ID |
Integer |
|
|
UnitSystemName |
The unit system which is applied |
String |
|
|
NPS1, NPS2, SCH1 and SCH2 |
Ident values as input |
String |
|
|
NlsId |
Language identifier |
Integer |
|
|
ShortDescription |
Short description of the ident |
String |
|
|
Description |
Description of the ident |
String |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(78386)/Idents",
"value": [
{
"IdentId": 7509970,
"Project": "SDB",
"IdentCode": "I7509970",
"CommodityId": 78386,
"NPS1": ".75",
"NPS2": ".5",
"SCH1": "S-160",
"SCH2": "S-160",
"ControlStatus": 1,
"UnitSystemId": 5001,
"UnitSystemName": "IMP/MET",
"IdentNls@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(78386)/Idents(7509970)(7509970)/IdentNls",
"IdentNls": [
{
"IdentId": 7509970,
"NlsId": 1,
"ShortDescription": ".75 x .5 x S-160 x S-160",
"Description": ".75 x .5 x S-160 x S-160",
"ControlStatus": 1,
"Project": "SDB"
}
]
}
]
}