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
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
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
-
List nodes attached to parent and child positions are also retrieved now.
Sample Code
GET https://in-smatapi.ingrnet.com/sprint/smat/v1/Projects('DEMO')/Disciplines('PIPING')/NLS('English')/ListPositions(423662)?$expand=PositionAttributes
Success Response
Status: 200 OK
Content:
{
{
"LpId": 423662,
"LnId": 92419,
"StatId": 5062,
"ProjId": "RS",
"LstId": 5021,
"DpId": 5020,
"Position": "40",
"SubPosition": null,
"Quantity": 2,
"RequisitionInd": "Y",
"LoadInd": "Y",
"ParentLpId": null,
"CommodityId": null,
"PartId": null,
"UnitId": 500127,
"Ident": null,
"ShortCode": "B1F",
"ItyId": 500018,
"Input1": "2",
"Input2": null,
"Input3": null,
"Input4": null,
"Input5": null,
"ResvQty": 0,
"TagNumber": null,
"GroupId": null,
"IssueQty": 0,
"ManResvQty": 0,
"Weight": null,
"WeightUnitId": null,
"PlateId": null,
"LockInd": "N",
"ChildPositions": [
{
"LpId": 470258,
"LnId": 92419,
"StatId": 5062,
"ProjId": "RS",
"LstId": 5021,
"DpId": 5020,
"Position": "1",
"SubPosition": null,
"Quantity": 4,
"RequisitionInd": "Y",
"LoadInd": "Y",
"ParentLpId": 423662,
"CommodityId": null,
"PartId": null,
"UnitId": 500127,
"Ident": null,
"ShortCode": "BOL",
"ItyId": 500018,
"Input1": ".625",
"Input2": "90",
"Input3": "0",
"Input4": "0",
"Input5": "0",
"ResvQty": 0,
"TagNumber": null,
"GroupId": null,
"IssueQty": 0,
"ManResvQty": 0,
"Weight": null,
"WeightUnitId": null,
"PlateId": null,
"LockInd": "N"
}
],
"ParentPosition": null,
"ListNode": {
"LnId": 92419,
"LsId": 5036,
"ProjId": "RS",
"DpId": 5020,
"LnCode": "01",
"ParentLnId": 92418,
"GeneratedName": "SHEET: 01",
"LoadInd": "Y",
"LockInd": "N",
"SiteStatId": 5062,
"EstShortNodeInd": "N",
"BOMPath": "/0PIPING1/121_PS_TEST/121L/AF538008/01"
},
"IssueStatus": {
"StatId": 5062,
"Status": "0111",
"ProjId": "RS",
"OrderSeq": 10
}
}
|
Element |
Description |
Type |
|---|---|---|
|
LpId |
Unique ID of the retrieved list position |
Integer |
|
LnId |
Unique ID of the list node. Retrieved list position belongs to this node. |
Integer |
|
StatId |
Unique ID of the associated issue status |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved list positions belong to this Project. |
String |
|
LstId |
Unique ID of the list status |
Integer |
|
DpId |
Unique ID of the Discipline. Retrieved list positions belong to this Discipline. |
Integer |
|
ListPosition |
Unique position with this structure-element |
String |
|
Quantity |
Ident - quantity of the list position |
Decimal |
|
RequisitionInd |
Available values are Y and N.
|
String |
|
LoadInd |
Available values are Y and N.
|
String |
|
ParentLpId |
Unique ID of the parent list position |
Integer |
|
CommodityId |
Unique ID of the commodity code |
Integer |
|
PartId |
Unique ID of the commodity part |
Integer |
|
UnitId |
Unique ID of the unit |
Integer |
|
Ident |
Ident number |
Integer |
|
ShortCode |
Specifies the short code |
String |
|
ItyId |
Unique ID of the item type |
Integer |
|
ListSubPosition |
Sub positions of the list position |
String |
|
Input (1-5) |
Value for size 1 to 5 |
String |
|
ResvQty |
Reserved quantity set by the Forecast Run |
Decimal |
|
TagNumber |
Tag number |
String |
|
GroupId |
Unique ID of the commodity group |
Integer |
|
IssueQty |
Issued quantity |
Decimal |
|
ManResvQty |
Manually reserved quantity |
Decimal |
|
Weight |
Specifies weight for position of current node |
Decimal |
|
WeightUnitId |
Specifies unit of weight for position of current node |
Integer |
|
PlateId |
Unique ID of the plate |
Integer |
|
LockInd |
Available values are Y and N.
|
String |
|
PositionAttributes |
Represents the details of the attributes of a list position |
Collection |
|
ChildPositions |
Represents all the details about the child positions attached with this position. |
Collection |
|
ListNode |
Represents the details of the list nodes attached to the positions.
|
Entity |
To know more details about list nodes elements , refer -
Position Attributes (PositionAttributes)
Element
Description
Type
AttrId
Unique ID of the list position attribute
Integer
AttrCode
Unique code or name of the list position attribute
String
AttrValue
Value of the list position attribute
String