Add Heat details - 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 adds Heat details to the specified Material Receiving Report (MRR) in Smart Materials.

Required Privilege: API_CREATE_HEAT_DETAIL

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: POST https://localhost:53965/SMAT/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/ ReceivingHeaders({key})/Com.Ingr.Smat.V1.HeatDetails/

Specify values for 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 Receiving header Id.

Element

Description

Type

Required

Notes

InvReceiptId

Unique ID of the inventory receipts

Decimal

Optional

To view existing
Inventory receipts,
use:

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

HeatNumber

Name of the heat number.

  • You can use either an existing heat
    number or a new
    heat number.

  • If you are using a new heat number,
    it gets added automatically
    in
    the heat number
    list.

String

Optional

To view existing
heat numbers,
use:

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

CertificateNumber

Certificate number

String

Optional

You can update a certificate number only
when a new heat number is defined.

Maximum allowed length is 30.

Manufacturer

Name of the manufacturer

String

Optional

You can update a manufacturer only
when a new heat number is defined.

Maximum allowed length is 30.

FileLocation

File location

String

Optional

You can update a file location only
when a new heat number is defined.

Maximum allowed length is 30.

Quantity

Order quantity of the item shipment

Decimal

Optional

Allowed range is (0- 9999999.999).

VendorCode

Name of the vendor

String

Optional

Maximum allowed length is 60.

HeatNumber2

Name of the heat number

String

Optional

Maximum allowed length is 30.

CertificateNumber2

Certificate number

String

Optional

You can update a
certificate number only
when a new
heat number is defined.

Maximum allowed length is 30.

Manufacturer2

Name of the manufacturer

String

Optional

You can update a manufacturer
only when a
new heat number is defined.

Maximum allowed length is 30.

Mark

Marking that appears on the item in the first heat number

String

Optional

Maximum allowed length is 30.

Mark2

Marking that appears on the item in the second heat number

String

Optional

Maximum allowed length is 30.

Sample Code

POST https://localhost:53965/SMAT/V1//Projects('AB')/Disciplines('PIPING')/Nls('English')/ReceivingHeaders(6578)/Com.Ingr.Smat.V1.HeatDetails/

{

"heatDetails":{

"InvReceiptId":10000114460,

"HeatNumber":"testing",

"CertificateNumber":"CERTIFICATE 1",

"Manufacturer":"INTERGRAPH",

"FileLocation":"",

"Quantity":500,

"VendorCode":"VENDOR INTERGRAPH",

"HeatNumber2":"HEAT 2",

"CertificateNumber2":"CERTIFICATE 2",

"Manufacturer2":"INTERGRAPH",

" Mark":"",

" Mark2":""

}

}

Success Response
Status: 200 OK

{

"@odata.context": " https://{host}/Smat/V1/$metadata#Edm.Int64",

"value": 10000023689

}

Where value is the unique ID of the heat.