ItemShipments - Intergraph Smart Materials - Version 2017 (2.0) - Help - Hexagon PPM

Intergraph Smart Materials Web API Help 2017 (2.0)

PPMProduct
Intergraph Smart Materials
PPMCategory_custom
Help

Name and Description

ItemShipments - All item shipments of a project are returned

URL Format

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/ItemShipments

Specify values for ProjId, DisciplineCode and NlsDescription parameters in the URL.

Use the following read-only APIs to get the available values for each parameter.

/Projects,

/projects(':project')/Disciplines,

/projects(':project')/Disciplines(':discipline')/nls

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

ItemShipments is a collection of type

WebApi.SPMaterials.Service.Models.EDM.MVW_ITEM_SHIPS.

MVW_ITEM_SHIPS Metadata:

<EntityType Name="ItemShipment">

<Key>

<PropertyRef Name="ItemShipId"/>

</Key>

<Property Name="ItemShipId" Type="Edm.Int64" Nullable="false"/>

<Property Name="ProjId" Type="Edm.String"/>

<Property Name="PoliId" Type="Edm.Int64"/>

<Property Name="ItemShipPos" Type="Edm.Int32"/>

<Property Name="ItemShipSubPos" Type="Edm.Int16"/>

<Property Name="DpId" Type="Edm.Int64"/>

<Property Name="Ident" Type="Edm.Int64"/>

<Property Name="ItemShipQty" Type="Edm.Decimal"/>

<Property Name="ItemShipResvQty" Type="Edm.Decimal"/>

<Property Name="QtyUnitId" Type="Edm.Int64"/>

</EntityType>

HTTP status code sent back to client on the API execution success: 
Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('{project}')/Disciplines('{discipline}')/Nls('{nls}')/ItemShipments",

"value": [

{

ItemShipId: 95274,

ProjId: "CD",

PoliId: 133764,

ItemShipPos: 1,

ItemShipSubPos: 1,

DpId: 5020,

Ident: 14640673,

ItemShipQty: 10,

ItemShipResvQty: 0,

QtyUnitId: 500127

},

{

ItemShipId: 95275,

ProjId: "CD",

PoliId: 133765,

ItemShipPos: 1,

ItemShipSubPos: 1,

DpId: 5020,

Ident: 14640871,

ItemShipQty: 10,

ItemShipResvQty: 0,

QtyUnitId: 500127

}

]

}

Error Response

This API may fail with the following error messages: 
Error Code: 401 Unauthorized 
Content:

{

"error": {

"code": "",

"message": "Authorization has been denied for this request." }

}

Notes