Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/json |
Sample URI request
To retrieve the branch data for a Specification Header Geometric, use the following query:
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/SpecificationTypes(5120)/ SpecificationHeaders(6201)/SpecificationHeaderGeometrics(<TabId>)/Com.Ingr.Srd.V2.Branches()/
This query retrieves the Description of the branchbranch data filtered based on the size ranges given for the specification header geometric.
Get URI Parameter
|
Parameter |
Description |
Type |
Required |
|---|---|---|---|
|
TabId |
Sequence of the spec header geometric to which you want to retrieve the data |
Integer |
Required |
Response
|
Element |
Description |
Type |
Notes |
|---|---|---|---|
|
BranchTableId |
A unique ID for the branch |
Integer |
|
|
BranchTable |
Name of the branch |
String |
|
|
BranchTableShortDescription |
Short description of the branch |
String |
|
|
BranchTableDescription |
Description of the branch |
String |
|
|
BranchUnitId |
Unit id for branch size |
Integer |
|
|
BranchUnitCode |
Unit code for branch size |
String |
|
|
HeaderUnitId |
Unit id for header size |
Integer
|
|
|
HeaderUnitCode |
Unit code for header size |
String |
|
|
Preference |
Single digit number for preference |
Integer |
|
|
HeaderSize |
Header size |
Integer |
|
|
BranchSize |
Branch size |
Integer |
|
|
CommodityGroupId |
A unique ID for the commodity group |
Integer
|
|
|
CommodityGroupName |
Name of the commodity group |
String |
|
|
CommodityPartId |
A unique ID for the commodity part |
Integer |
|
|
CommodityPartName |
Name of the commodity part |
String |
|
|
hortDescription |
Short description of the branch detail |
String |
|
|
P_MIN_HEADER_THK |
The attribute code corresponding to the variable attribute is shown. |
String |
For branches, on response, all the variable attributes assigned in the table attributes for “M_PARTS” and “M_GEOM_BRANCH_DETAILS” are displayed with attribute code name. Total available attribute characters are: For M_GEOM_BRANCH_DETAILS,AttributeCharacter1 to AttributeCharacter5. For M_PARTS, AttributeCharacter1 to AttributeCharacter10. And total available attribute numbers are: For M_GEOM_BRANCH_DETAILS, AttributeNumber1 to AttributeNumber5. For M_PARTS, AttributeNumber1 to AttributeNumber10. The inline sample response shows the available attribute codes. |
|
BR_LEGEND |
The attribute code corresponding to the variable attribute is shown. |
String |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Com.Ingr.Srd.V2.BranchData",
"BranchDetails": [
{
"BranchTableId": 5324,
"BranchTable": "BR9CS1S01",
"BranchTableShortDescription": "Branch Table-9CS1S01",
"BranchTableDescription": "Branch Table-9CS1S01",
"BranchUnitId": 5283,
"BranchUnitCode": "in",
"HeaderUnitId": 5283,
"HeaderUnitCode": "in",
"Preference": 1,
"HeaderSize": 0.50,
"BranchSize": 0.50,
"CommodityGroupId": 5008,
"CommodityGroupName": "O",
"CommodityPartId": 5471,
"CommodityPartName": "ETE",
"ShortDescription": "89.5deg|90.5deg",
"P_MIN_HEADER_THK": "",
"BR_LEGEND": "T"
}
]
}