Order line items (OrderLineItems) - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R2 (2.2)

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(5010)

Success Response

Status: 200 OK

{

"@odata.context": "http://localhost:51531/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/OrderLineItems",

"value": [

{

"PoliId": 5010,

"ProjId": "RS",

"PohId": 5001,

"ParentPohId": 5001,

"BasePohId": 5001,

"LineItemPosition": 21,

"LineItemSubPosition": 10,

"DpId": 500017,

"Ident": 7500042,

"PoliQty": 1,

"QuantityUnit": 500127,

"RevisedPromiseDate": null

}

Element

Description

Type

PoliId

Unique ID of the purchase order line items

Integer

ProjId

Unique ID of the project and retrieved line items belong to this project

String

PohId

Unique ID of the purchase order header and retrieved line items belong to this purchase order header

Decimal

ParentPohId

Unique ID of the parent purchase order header and retrieved line items belong to this parent purchase order header

Decimal

BasePohId

Unique ID of the base purchase order header and retrieved line items belong to this base purchase order header

Decimal

LineItemPosition

Order line item number

Integer

LineItemSubPosition

Order sub line item number

Integer

DpId

Unique ID of the discipline and retrieved order line items belong to this discipline

Integer

Ident

Ident number

Integer

PoliQty

Quantity of the line item

Decimal

QuantityUnit

Unit of the order line item quantity

Integer

RevisedPromiseDate

Revised original promise date

Date Time Offset