Skip to main content

Sherlock APIs 2025 R2

Example: updateThermalMaps

Last update: 17.07.2025

Proto Request Example

{
  "project": "Tutorial Project",
  "thermalMapFiles": [
    {
      "fileName": "Thermal Map CSV",
      "fileType": 0,
      "fileComment": "Test Comment Updated",
      "thermalBoardSide": 0,
      "csvExcelFile": {
        "headerRowCount": 0,
        "referenceIDColumn": "RefDes",
        "temperatureColumn": "Temp",
        "temperatureUnits": "C",
        "numericFormat": "English"
      },
      "thermalProfiles": [
        "On The Road/4 - Thermal Shock - Min", "On The Road/4 - Thermal Shock - Max"
      ],
      "cca": [
        "Main Board"
      ]
    },
    {
      "fileName": "Thermal Image Test",
      "fileType": 2,
      "fileComment": "Test Comment Updated",
      "thermalBoardSide": 0,
      "imageFile": {
        "coordinateUnits": "in",
        "boardBounds": [
          {
            "vertexX": -3.7464,
            "vertexY": -2.2515
          },
          {
            "vertexX": 3.56139,
            "vertexY": -2.132
          },
          {
            "vertexX": 3.7464,
            "vertexY": 2.228887
          },
          {
            "vertexX": -3.5614,
            "vertexY": 2.2488
          }
        ],
        "imageBounds": {
          "imageX": -4.20314,
          "imageY": -4.44105,
          "imageH": 7.0474,
          "imageW": 9.08464157
        },
        "legendBounds": {
          "legendX": 4.17808,
          "legendY": -3.3467,
          "legendH": 4.71934,
          "legendW": 0.27751
        },
        "legendOrientation": 1,
        "minTemperature": 17,
        "minTemperatureUnits": "C",
        "maxTemperature": 90,
        "maxTemperatureUnits": "C"
      },
      "thermalProfiles": [
        "Environmental/1 - Temp Cycle - Max", "Environmental/1 - Temp Cycle - Min"
      ],
      "cca": [
        "Main Board"
      ]
    }
  ]
}

Python Example

For a Python example, refer to the online PySherlock Reference.

Connect with Ansys