Shipment group (ShipmentGroups) - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

This API retrieves the shipment group of a project from Smart Materials. You can either retrieve a single shipment group using shipment Id or all the shipment groups of a project.

Required Privilege: API_READONLY

Headers

Body

URL Format: GET https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/ShipmentGroups({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 shipment group Id (SgId).

To retrieve all the shipment groups of a project, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/ShipmentGroups

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/ShipmentGroups(5081)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/ShipmentGroups",

"value":[

{

"SgId":5081,

"ProjId":"RS",

"PohId":40369,

"SgCode":"00000000RW01-A_001"

}]

}