This API retrieves the work package of a project from Smart Materials. You can either retrieve a single work package using work package ID or all the work packages of a project.
Required Privilege: API_CREATE_FAHEADER
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL: POST https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/WorkPackages({key})
Specify values for the project, discipline, and language in the URL. The project, discipline, and language, together define the project environment. The key parameter defines the work package ID (WpId).
.
To retrieve all the work packages of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Workpackages
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Workpackages(5141)
Success Response
{
"@odata.context": "https://localhost:51531/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/WorkPackages/$entity",
"WpId": 5141,
"WpCode": "903",
"LockedInd": "N",
"PriorityType": "WORK PACKAGE",
"WpType": "S",
"Aqc1Id": 56781,
"Aqc2Id": 52423,
"Aqc3Id": 52424,
"Aqc4Id": 12345,
"Aqc5Id": 8878,
"AttrId": 1212,
"ROSDate": null,
"EndDate": "2019-09-11T00:00:00+05:30",
"Name": "RW"
"BOMDetails": [
{
"WpdId":5200,
"OrderSeq": 1,
"LnId" :196724,
"BOMPath" :"/A1/B1/C1"
}
]}
|
Element |
Description |
Type |
|---|---|---|
|
WpId |
Unique ID of the work package |
Integer |
|
WpCode |
Name of the work package |
String |
|
LockedInd |
Indicates whether the work package is locked or not.
Default value is N. |
String |
|
PriorityType |
Priority type specified for the given work package in the current forecast/reservation
run.
Default value is WORK PACKAGE. |
String |
|
WpType |
Defines the type of the work package. Available values are S and D.
Default value is S.
|
String |
|
Aqc1Id |
Represents the unique ID of the Where condition for ident query that is mapped to list positions. |
Integer |
|
Aqc2Id |
Represents the unique ID of the Where condition for List Pos query that is mapped to idents. |
Integer |
|
Aqc3Id |
Represents the unique ID of the Where Condition for Mandatory LP query that is mapped to mandatory LP. |
Integer |
|
Aqc4Id |
Represents the unique ID of the Where Condition for CIP (List Pos) query that is used for Shortage Option 2-Pass CIP. |
Integer |
|
Aqc5Id |
Represents the unique ID of the Where Condition for CIP (Ident) query that is used for Shortage Option 2-Pass CIP. |
Integer |
|
AttrId |
Unique ID of the attribute |
Integer |
|
ROSDate |
Date and time when the work package is Required on Site |
Date Time Offset |
|
EndDate |
Individual end date for the work package |
Date Time Offset |
|
Name |
Name of the user who is responsible for this work package. |
String |
|
BOMDetails |
Details of the BOM nodes that are assigned to a work package.
|
Collection |
Workpackage with WpType (S) are only retrieved.
-
BOMDetails
Element
Description
Type
OrderSeq
Sequence of the work packages considered while forecast/reservation run.
Integer
LnId
Unique ID of the list node
Integer
WpdId
Unique ID of the work package detail
Integer
BOMPath
BOM path of the list node
String