Heats - 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

Heats - All heat numbers of a project are returned

URL Format

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

Specify values for ProjId, DisciplineCode and NlsDescription parameters in the URL.

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

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

Heats is a collection of type WebApi.SPMaterials.Service.Models.EDM.MVW_HEATS.

MVW_HEATS Metadata:

<EntityType Name="Heat">

<Key>

<PropertyRef Name="HeatId"/>

</Key>

<Property Name="HeatId" Type="Edm.Int64" Nullable="false"/>

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

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

<Property Name="DpId" Type="Edm.Int64"/>

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

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

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

</EntityType>

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

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('{project}')/Disciplines('{discipline}')/Nls('{nls}')/Heatsx",

"value":[

{

HeatId:6607,

ProjId: "CD",

HeatNumber:"TITUS",

DpId: 5020,

CertificateNumber:null,

Manufacturer:null,

FileLocation:null

},

{

HeatId:7032,

ProjId:"CD",

HeatNumber:"FFFFFF",

DpId:5020,

CertificateNumber:null,

Manufacturer:null,

FileLocation:null

}]

}

Error Response

This API may fail with the following error messages: 
Error Code: 401 Unauthorized 
Content:

{

"error": {

"code": "",

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

}

Notes