Add Heat Details - 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

Add Heat Details – This API adds heat details to the specified MRR.

URL Format

/Projects (':project')/Disciplines(':discipline')/Nls(':language')/ ReceivingHeaders({key})/Com.Ingr.Smat.V1.HeatDetails/

Specify values for project, discipline, language and key parameters in the URL. The first three values together define the project environment in which the MRR header is created. The key parameter defines the MRR header id, for which the heat details are added.

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, :key

Method

POST

Required Privilege

API_CREATE_HEAT DETAIL

Data Parameter

The payload of the request should be in JSON format with the following structure:

<Action Name="HeatDetails" IsBound="true">

<Parameter Name="bindingParameter" 

Type="Com.Ingr.Smat.Core.V1.ReceivingHeader"/>

<Parameter Name="HeatDetails" 

Type="Com.Ingr.Smat.Core.V1.HeatDetail"/>

<ReturnType Type="Edm.Int64" Nullable="false"/>

</Action>

Below is the JSON structure of Com.Ingr.Smat.Core.V1.HeatDetail:

<ComplexType Name="HeatDetail">

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

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

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

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

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

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

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

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

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

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

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

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

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

</ComplexType>

Where:

InvReceiptId (Edm.Decimal): MRR ID.

Use following Read Only API To know the INV_RECEIPT_ID: https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/InvReceipts

IisId (Edm.Decimal):

HeatNumber (Edm.String): Name (code) of the heat number.

In this case you can decide whether you want to select another heat number or whether you want to continue. If you continue this new heat number will be added to the heat numbers in C.10.04.

CertificateNumber (Edm.String): Certificate Number

The certificate number is only updateable if you have defined a new heat number.

Manufacturer (Edm.String): Manufacturer

The manufacturer is only updateable if you have defined a new heat number.

FileLocation (Edm.String): File Location

The file location is only updateable if you have defined a new heat number.

Quantity (Edm.Decimal): Order quantity of the item shipment.

VendorCode (Edm.String):

HeatNumber2 (Edm.String): Name (code) of the heat number.

CertificateNumber2 (Edm.String): Certificate Number

The certificate number is only updateable if you have defined a new heat number.

Manufacturer2 (Edm.String): Manufacturer

The manufacturer is only updateable if you have defined a new heat number.

Mark (Edm.String):

Mark2 (Edm.String):

Example, use following JSON:

{

"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

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

Content:

{

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

"value": 10000023689

}

Error Response

This API may fail with the following error messages:

HTTP Status Code: 401 Unauthorized

Content:

{

"error": {

"code": "",

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

}

HTTP Status Code: 400 Bad Request

Content:

{

"error": {

"code": "",

"message": "Invalid/Missing input JSON data. Please refer metadata" }

}

HTTP Status Code: 400 Bad Request

Content:

{

"error": {

"code": "",

"message": "The request is invalid.",

"innererror": {

"message": " : INV_RECEIPT_ID or IIS_ID is required.\r\n",

"type": "",

"stacktrace": "" }

}

}

Notes