List Positions (ListPositions) - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

This API retrieves the list positions of a project from Smart Materials. You can either retrieve a single list position using list position Id or all the list positions of a project.

Required Privilege: API_READONLY

Headers

Body

URL Format: GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/ListPositions({key})

Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the list positions Id (LpId).

To retrieve all the list positions of a project, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/ListPositions

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/ListPositions(9782)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/ListPositions",

"value":[

{

"LpId":9782,

"LnId":5945,

"StatId":5565,

"ProjId":"RS",

"LstId":5021,

"DpId":5020,

"ListPosition":"10",

"Quantity":10,

"RequisitionInd":"N",

"LoadInd":"Y",

"ParentLpId":null,

"CommodityId":4507598,

"PartId":500244,

"UnitId":500127,

"Ident":14640871,

"ShortCode":null,

"ItyId":500018,

"ListSubPosition":null,

"Input1":"A10",

"Input2":"B2",

"Input3":"S-20",

"Input4":"S-STD",

"Input5":"0",

"ResvQty":0,

"TagNumber":null,

"FahId":null,

"GroupId":500054,

"IssueQty":0,

"Weight":null,

"WeightUnitId":null,

"PlateId":null,

"LockInd":"N"

}]

}