This API retrieves the order line items of a project from Smart Materials. You can either retrieve a single order line item using order line item Id or all the order line items 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')/OrderLineItems({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 order line item Id (PoliId).
To retrieve all the order line items of the project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/OrderLineItems
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/OrderLineItems(5013)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/NLS('English')/OrderLineItems",
"value":[
{
"PoliId":5013,
"ProjId":"RS",
"PohId":30622,
"LineItemPosition":1,
"LineItemSubPosition":1,
"DpId":5020,
"Ident":7607213,
"PoliQty":11
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
PoliId |
Unique ID of the purchase order line items |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved line items belong to this Project. |
String |
|
PohId |
Unique ID of the purchase order header. Retrieved line items belong to this purchase order header. |
Decimal |
|
LineItemPosition |
Sequence number that identifies the line items of an order |
Integer |
|
LineItemSubPosition |
Integer |
|
|
DpId |
Unique ID of the Discipline. Retrieved Order line items belong to this Discipline. |
Integer |
|
Ident |
Ident number |
Integer |
|
PoliQty |
Quantity of the line item |
Decimal |