This API retrieves the heat numbers of a project from Smart Materials. You can either retrieve a single heat number using heat number Id or all the heat numbers 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')/Heats({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 heat number Id (HeatId).
To retrieve all the heat numbers of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Heats
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Heats(5061)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/Heats",
"value": [
{
"HeatId":5061,
"ProjId":"RS",
"HeatNumber":"TITUS",
"DpId":5020,
"CertificateNumber":null,
"Manufacturer":null,
"FileLocation":null
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
HeatId |
Unique ID of the retrieved heat number |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved heat number belongs to this Project. |
String |
|
HeatNumber |
Unique identification code/name of the retrieved heat number. |
String |
|
DpId |
Unique ID of the Discipline. Retrieved heat number belongs to this Discipline. |
Integer |
|
CertificateNumber |
Unique certificate number assigned to a heat number. You can assign |
String |
|
Manufacturer |
Name of the manufacturer |
String |
|
FileLocation |
Defines the file location |
String |