Sign in
latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

CADs

Run a CAD query

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 body

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

Available query types:

  • detect-contacts-v3: Identify contacts between solid regions. Supported internal formats: PARASOLID.
  • find_interfering_bodies: Find all interfering solid regions. Supported internal formats: PARASOLID.
  • find_small_gaps: Identify all gaps between solid regions that do not exceed the specified maximum gap distance. Supported internal formats: PARASOLID.
  • measure-entities: Calculate the measurements of the given entities. 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
}