SIsimscale
CADs

Run a CAD query

Changed on

Run a CAD query on a given CAD state. CAD queries that involve complex computation might take some time to complete. Please refer to the following steps to run a CAD query:

  1. Trigger the query computation via POST /cads/{cadId}/states/{cadStateId}/query
  2. Monitor progress via POST /cads/{cadId}/states/{cadStateId}/query
post/cads/{cadId}/states/{cadStateId}/query

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/cads/{cadId}/states/{cadStateId}/query
  • Auth
    API key in header X-API-KEY

Request body

query'detect-contacts-v3' | 'find_gaps' | 'find_interfering_bodies' | 'measure-entities' required

Available query types:

  • detect-contacts-v3: Identify contacts between solid regions. Supported internal formats: PARASOLID.
  • find_gaps: Find all gaps between solid regions. Supported internal formats: PARASOLID.
  • find_interfering_bodies: Find all interfering solid regions. Supported internal formats: PARASOLID.
  • measure-entities: Calculate the measurements of the given entities. Supported internal formats: PARASOLID.
  • measure-entities-v2: Measure any mix of bodies, faces, edges and vertices in one call, unlike measure-entities which requires every entity to share a type. Can also report the combined size and centroid of the input entities when they share a type, and the relationship between them when exactly two are given. Supported internal formats: PARASOLID.

Example request

{
  "parameters": {}
}

Response

Query submitted successfully.

status'READY' | 'QUEUED' | 'RUNNING' | 'FINISHED' | 'CANCELED' | 'FAILED'

Status of the operation.

Example response

{
  "status": "RUNNING",
  "result": null,
  "failureReason": null
}

Changes

  • abba4167cbe2Revision changes
    • breaking

      removed the enum value find_small_gaps of the request property

    • breaking

      added to the response property oneOf list for the response status

    • info

      added the new find_gaps enum value to the request property

    • info

      added to the request property oneOf list

  • 2376c5707aa6Revision changes
    • breaking

      removed from the request property oneOf list

    • info

      removed from the response property oneOf list for the response status