Headers
Header Name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access Token |
Required |
Bearer <access-token> |
Content-Type |
Request type format |
Required |
application/json |
Sample URI request
GET
To retrieve a specification header with Nls for a specific specification header:
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(<SpecifiationHeaderId>)?$expand=SpecificationHeaderNls
GET
To retrieve all commodity parts with NIs for a commodity group:
https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders?$expand=SpecificationHeaderNls
Response
Parameter |
Description |
Type |
Notes |
---|---|---|---|
SpecificationHeaderId |
A unique ID for the specification Header |
Integer |
|
SpecificationCode |
Retrieves the name of the specification |
String |
|
RevisionNumber |
Retrieves the revision number of the specification |
Integer |
|
SpecificationType |
Retrieves the name of the specification Type |
String |
|
SpecificationRuleId |
A unique ID for the specification Rule |
Integer |
|
SpecificationRuleCode |
Retrieves the name of the specification Rule associated with the Specification Type. |
String |
|
ControlStatus |
Retrieves the control status of the instance |
Integer |
|
Project |
Retrieves the project details for the selected Specification Header. |
String |
|
PREF_PERM_TAP |
PREF_PERM_TAP attribute is associated with ATTR_CHAR1 physical attribute for specification rule. |
String |
|
Pds_Fluid_Code |
Pds_Fluid_Code attribute is associated with ATTR_CHAR2 physical attribute for specification rule. |
String |
|
Pds_Corr_Allow |
Pds_Corr_Allow attribute is associated with ATTR_NUM1 physical attribute for specification rule. |
Float |
|
PDS_PMC_CL148 |
PDS_PMC_CL148 attribute is associated with ATTR_NUM2 physical attribute for specification rule. |
Float |
|
NlsId |
Language identifier |
Integer |
|
ShortDescription |
Short description of the Specification Header |
String |
|
Description |
Description of the specification Header |
String |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders",
"value": [
{
"SpecificationHeaderId": 6201,
"SpecificationCode": "9CS1S01",
"RevisionNumber": 0,
"SpecificationType": "SDB_PIP",
"SpecificationRuleId": 5020,
"SpecificationRuleCode": "SDB_SPEC_R",
"ControlStatus": 1,
"ProjectId": "SDB",
"PREF_PERM_TAP": "Tap-003",
"Pds_Fluid_Code": "FC001",
"Pds_Corr_Allow": 0.0630,
"PDS_PMC_CL148": 8001,
"SpecificationHeaderNls@odata.context":
"https:<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/SpecificationHeaders(6201)/SpecificationHeaderNls",
"SpecificationHeaderNls": [
{
"SpecificationHeaderId": 6201,
"NlsId": 1,
"ControlStatus": 1,
"ShortDescription": "PIP PN09CS1S01",
"Description": "Class 900, Carbon Steel, Socket Weld,\n0.063\" C.A. Steam/Condensate"
}
]
}
]
}