Headers
|
Header name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/json |
POST body
If the value of the project default, ZS_IDN_SUP is set to N, you cannot insert the ident Nls from the request body. However, you can insert ident
Nls by setting the project default property to Y.
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
IdentCode |
Name of the new ident |
String |
Required |
|
|
UnitSystemName |
The unit system which is applied. |
Integer |
Required |
Available unit systems are |
|
NPS1, NPS2, SCH1 and SCH2 |
Ident values as input to be unique. |
Integer |
Optional |
Default value is 0. |
|
ControlStatus |
Control status of the instance. |
Integer |
Optional |
Default value is 1 |
|
NlsId |
Language identifier. |
Integer |
Required |
|
|
ShortDescription |
Short description of the table. |
String |
Required |
|
|
Description |
Description of the table. |
String |
Required |
Sample request
POST
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityGroups(5008)/CommodityParts(5481)/CommodityCodes(78386)/Idents
{
"IdentCode": "I19611647F",
"UnitSystemName":"IMP/MET",
"NPS1":"1",
"NPS2":"1",
"SCH1":"S-10",
"SCH2":"S-10",
"IdentNls":[
{
"NlsId":1,
"ShortDescription":"Test",
"Description":"TestDescription"
}, {
"NlsId":2,
"ShortDescription":"Test",
"Description":"TestDescription"
}]
}
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 |
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/$entity",
"IdentId": 19611723,
"Project": "SDB",
"IdentCode": "I19611647gant",
"CommodityId": 78386,
"NPS1": "1",
"NPS2": "1",
"SCH1": "S-10",
"SCH2": "S-10",
"ControlStatus": 1,
"UnitSystemId": 5001,
"UnitSystemName": "IMP/MET"
}
Use the following sample GET method to view the associated idents and the Nls that you have created:
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
Where ?$expand=IdentNls is the query to retrieve the associated Nls records.