Purchase Order Headers (POHeaders) - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

This API retrieves the Purchase Order (PO) headers of a project from Smart Materials. You can either retrieve a single PO header using PO header Id or all the Purchase Order headers of a project.

Only Purchase Order headers that belong to approved agreements can be retrieved.

Required Privilege: API_READONLY

Headers

Body

URL Format: GET https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/PoHeaders({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 Purchase Order header Id (PohId).

To retrieve all the PO headers of a project, use the following URL:

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

Only Approved agreements are retrieved.

Sample Code

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

Success Response

Status: 200 OK

Content:

{

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

"value": [

{

"PohId":5001,

"ProjId":"RS",

"OriginId":500005,

"OrderType":"PO",

"PoNumber":"PO 0002-8577Y-2000-4122-001",

"PoSuppId":0,

"ParentPohId":null,

"ApprovedDate":"2010-01-07T11:43:19+05:30"

"Attribute1":"DummyColumn1",

"Attribute2":"DummyColumn2",

"Attribute3":"DummyColumn3",

"Attribute4":"DummyColumn4",

"Attribute5":"DummyColumn5",

"Attribute6":"DummyColumn6",

"Attribute7":"DummyColumn7",

"Attribute8":"DummyColumn8",

"Attribute9":"DummyColumn9",

"Attribute10":"DummyColumn10"

}]

}