Request to list the valid PCB Modeling input fields given the user configuration.

Proto Request Example:

{}

Python Example:

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

Request to list the valid Harmonic Vibe input fields for the provided model source and user configuration.

Proto Request Example

{
  "modelSource": 1
}

Python Example:

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

Request to list the valid ICT analysis input fields given the user configuration.

Proto Request Example

{}

Python Example:

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

Request to list the valid mechanical shock input fields for the provided model source and user configuration.

Proto Request Example

{
  "modelSource": 2
}

Python Example:

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

Request to list the valid natural frequency input fields given the user configuration.

Proto Request Example:

{}

Python Example:

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

Request to list the valid PCB Modeling input fields given the user configuration.

Proto Request Example:

{}

Python Example:

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

Request to list the valid solder fatigue input fields given the user configuration.

Proto Request Example

{}

Python Example:

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

Request to run one or more Sherlock analyses given the project path, CCA name, analyses, Life Cycle phases and events.

Proto Request Example

{
  "project": "Tutorial",
  "ccaName": "Main Board",
  "analyses": [
    {
      "type": 10
    },
    {
      "type": 4,
      "phases": [
        {
          "name": "On The Road",
          "events": [
            {
              "name": "2 - Pothole"
            }
          ]
        },
        {
          "name": "Environmental",
          "events": [
            {
              "name": "3 - Earthquake"
            }
          ]
        }
      ]
    }
  ]
}

Python Example

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

Request to run Sherlock strain map analysis given the project name, CCA name, and strain maps.

Proto Request Example

{
  "project": "Tutorial Project",
  "ccaName": "Main Board",
  "strainMapAnalyses": [
    {
      "type": 1,
      "eventStrainMaps": [
        {
          "phaseName": "On The Road",
          "eventName": "1 - Vibration",
          "pcbSide": "TOP",
          "strainMap": "StrainMap - Top",
          "subAssemblyName": "Main Board"
        },
        {
          "phaseName": "On The Road",
          "eventName": "1 - Vibration",
          "pcbSide": "BOTTOM",
          "strainMap": "StrainMap - Bottom",
          "subAssemblyName": "Main Board"
        }
      ]
    }
  ]
}

Python Example:

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

Request to update the harmonic vibe analysis properties one or more CCA's in the project indicated.

Proto Request Example

{
  "project": "Tutorial",
  "harmonicVibeProperties": [
    {
      "ccaName": "Main Board",
      "modelSource": 0,
      "harmonicVibeCount": 10,
      "harmonicVibeDamping": "0.01, 0.02",
      "partValidationEnabled": true,
      "requireMaterialAssignmentEnabled": true,
      "analysisTemp": 50.5,
      "analysisTempUnits": "C",
      "forceModelRebuild": "AUTO",
      "filterByEventFrequency": true,
      "naturalFreqMin": 20,
      "naturalFreqMinUnits": "HZ",
      "naturalFreqMax": 2000,
      "naturalFreqMaxUnits": "HZ",
      "reuseModalAnalysis": true
    }
  ]
}

Python Example:

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

Request to update ICT Analysis properties.

Proto Request Example

{
  "project": "Tutorial",
  "ictAnalysisProperties": [
    {
      "ccaName": "Main Board",
      "applicationTime": 1.4,
      "applicationTimeUnits": "sec",
      "numberOfEvents": 10,
      "partValidationEnabled": true,
      "requireMaterialAssignmentEnabled": true,
      "forceModelRebuild": "FORCE",
      "ictResultCount": 10
    }
  ]
}

Python Example:

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

Request to update the mechanical shock analysis properties.

Proto Request Example

{
  "project": "Tutorial",
  "mechanicalShockProperties": [
    {
      "ccaName": "Main Board",
      "modelSource": 1,
      "shockResultCount": 2,
      "criticalShockStrain": 6,
      "criticalShockStrainUnits": "µε",
      "partValidationEnabled": true,
      "requireMaterialAssignmentEnabled": true,
      "forceModelRebuild": "AUTO",
      "naturalFreqMin": 10,
      "naturalFreqMinUnits": "HZ",
      "naturalFreqMax": 2000,
      "naturalFreqMaxUnits": "HZ",
      "analysisTemp": 100.5,
      "analysisTempUnits": "F"
    }
  ]
}

Python Example:

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

Request to update natural frequency analysis properties.

Proto Request Example:

{
  "project": "Tutorial Project",
  "ccaName": "Main Board",
  "naturalFreqCount": 8,
  "naturalFreqMin": 100,
  "naturalFreqMinUnits": "HZ",
  "naturalFreqMax": 1000,
  "naturalFreqMaxUnits": "HZ",
  "partValidationEnabled": true,
  "requireMaterialAssignmentEnabled": true,
  "analysisTemp": 20,
  "analysisTempUnits": "C"
}

Python Example:

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

Request to update FEA part modeling properties.

Proto Request Example

{
  "project": "Tutorial",
  "ccaName": "Main Board",
  "partEnabled": true,
  "partMinSize": 0.1,
  "partMinSizeUnits": "mm",
  "partElemOrder": "Second Order (Quadratic)",
  "partMaxEdgeLength": 3.45,
  "partMaxEdgeLengthUnits": "mm",
  "partMaxVertical": 1.23,
  "partMaxVerticalUnits": "mm",
  "partResultsFiltered": false
}

Python Example:

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

Request to update FEA analysis PCB Modeling properties.

Proto Request Example:

{
  "project": "Tutorial Project",
  "ccaNames": [
    "Main Board"
  ],
  "analyses": [
    {
      "type": 6,
      "modelType": 1,
      "modelingRegionEnabled": true,
      "pcbMaterialModel": 2,
      "pcbMaxMaterials": 5,
      "pcbElemOrder": 1,
      "pcbMaxEdgeLength": 0.5,
      "pcbMaxEdgeLengthUnits": "mm",
      "pcbMaxVertical": 1,
      "pcbMaxVerticalUnits": "mm",
      "quadsPreferred": true
    }
  ]
}

Python Example:

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

Request to update random vibe analysis properties.

Proto Request Example:

{
  "project": "Tutorial Project",
  "ccaName": "Main Board",
  "randomVibeDamping": "0.01",
  "naturalFreqMin": 0,
  "naturalFreqMinUnits": "HZ",
  "naturalFreqMax": 500,
  "naturalFreqMaxUnits": "HZ",
  "analysisTemp": 0,
  "analysisTempUnits": "C",
  "partValidationEnabled": true,
  "forceModelRebuild": "AUTO",
  "reuseModalAnalysis": true,
  "performNFFreqRangeCheck": true,
  "requireMaterialAssignmentEnabled": true
}

Python Example:

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

Request to update solder fatigue properties.

Proto Request Example

{
  "project": "Tutorial",
  "solderFatigueProperties": [
    {
      "ccaName": "Main Board",
      "solderMaterial": "SAC305",
      "partTemp": 5.25,
      "partTempUnits": "C",
      "partTempRiseMinEnabled": true,
      "partValidationEnabled": false
    }
  ]
}

Python Example:

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

Request to update thermal mech analysis properties.

Proto Request Example:

{
  "project": "Tutorial Project",
  "ccaName": [
    "Main Board"
  ],
  "thermalResultCount": 4,
  "partValidationEnabled": true,
  "requireMaterialAssignmentEnabled": true
}

Python Example:

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

Proto Request Example:

{
  "project": "Tutorial Project",
  "ccaName": "Main Board",
  "strainMapAnalyses": [
    {
      "type": 1,
      "eventStrainMaps": [
        {
          "phaseName": "On The Road",
          "eventName": "1 - Vibration",
          "pcbSide": "TOP",
          "strainMap": "StrainMap - Top",
          "subAssemblyName": "Main Board"
        }
      ]
    },
    {
      "type": 1,
      "eventStrainMaps": [
        {
          "phaseName": "On The Road",
          "eventName": "1 - Vibration",
          "pcbSide": "BOTTOM",
          "strainMap": "StrainMap - Bottom",
          "subAssemblyName": "Main Board"
        }
      ]
    }
  ]
}

Python Example:

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