This API retrieves the item shipments of a project from Smart Materials. You can either retrieve a single item shipment using item shipment Id or all the item shipments 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')/ItemShipments({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 item shipment Id (ItemShipId).
To retrieve all the item shipments of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/ItemShipments
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/ItemShipments(5005)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/ItemShipments",
"value": [
{
"ItemShipId":5005,
"ProjId":"RS",
"PoliId":133764,
"ItemShipPosition":1,
"ItemShipSubPosition":1,
"DpId":500017,
"Ident":14640673,
"ItemShipQty":10,
"ItemShipResvQty":0,
"QtyUnitId":500127
}]
}
Element |
Description |
Type |
---|---|---|
ItemShipId |
Unique ID of the item shipments |
Integer |
ProjId |
Unique ID of the Project. Retrieved item shipments belong to this Project. |
String |
PoliId |
Unique ID of the purchase order line item |
Integer |
ItemShipPosition |
Sequence number identifying related shipments of an order line item |
Integer |
ItemShipSubPosition |
Item Shipment sub line item number |
Integer 16 |
DpId |
Unique ID of the Discipline. Retrieved item shipments belong to this Discipline. |
Integer |
Ident |
Ident number |
Integer |
ItemShipResvQty |
Reserved quantity of the item shipments |
Decimal |
QtyUnitId |
Unique ID of the unit of the total and changed quantity |
Integer |