Changelog

rel-1.189 - released 2024-11-01

  • Updated POST : /drawings/d/[:did]/w/[:wid]/e/[:eid]/modify with new optional property outputStatusCode

rel-1.188 - released 2024-10-11

  • New appelements endpoint to resolve bulk app element references GET: /appelements/d/:[did]/[:wvm]/[:wvimid]/resolvereferences
  • Updated all translation endpoints with new optional request property evaluateExportRule
  • Updated all translation endpoints with new optional request property excludeHiddenEntities
  • Updated all translation endpoints with new optional response property exportRuleFileName
  • Removed from all translation endpoints the request property invisibleEntitiesExportFilter
  • Removed from POST : /documents/d/[:did]/[:wv]/[:wvid]/e/[:eid]/export the request property excludeSuppressedEntities

rel-1.187 - released 2024-09-20

  • New assembly display states endpoint GET: /assemblies/d/[did]/[wvm]/[wvmid]/e/[eid]/displaystates
  • Updated drawings translation endpoint for the formate DRAWING_JSON to include the field isDangling on callouts, centerlines, GD&T and notes
  • Increase allowed size for POST to /featurestudio endpoint

rel-1.186 - released 2024-08-29

  • Added new V9 version to the api (https://cad.onshape.com/api/versions), returning deterministicIds in query responses for GET : ‘/features’.
  • New list tasks endpoint GET : /tasks
  • New create task endpoint POST : /tasks
  • New list tasks endpoint GET : /tasks/[:tid]
  • New update task endpoint POST : /tasks/[:tid]
  • New transition task endpoint POST : /tasks/[:tid]/[:transition]
  • Updated modify drawings endpoint POST : /drawings/d/[:did]/w/[:wid]/e/[:eid]/modify to support editing annotations (messageName = onshapeEditAnnotations)

rel-1.185 - released 2024-08-12

  • Updated all endpoints that return a user summary (createdBy, modifiedBy) have a new boolean property isOnshapeSupport for use to separate Onshape support employee activities.
  • Updated all bodyDetails, tessellatededged, and tessellatedfaces endpionts (parts and Part Studios) to include errorEnum vales for detecting new mate position, curve pattern and Simulation material checks.

rel-1.184 - released 2024-07-19

  • Updated API version to V8, (https://cad.onshape.com/api/versions), A new microversion will not be created when a document restore operation results in a no-op.
  • Remove inconsistencies in assembly definition endpoint (/assemblies/d/[did]/[wvm]/[wvmid]/e/[eid]) related to configuration parameters
  • Update all translation endpoints (POST : ../translations) to include new request property useFileNameToSetSinglePartName
  • Update all revision endpoints (GET : /revisions/..) to include response property canChangeType (supporting new admin option to change type part, assembly, file, etc)
  • Update GET : /users/[:uid]/settings endpoint to include responses for highlightLaminarEdges and perspectiveModeOn for default status

rel-1.183 - released 2024-06-28

  • Added new V7 version to the api (https://cad.onshape.com/api/versions)
  • Updated GET : V7/partstudios/d/[did]/[wvm]/[wvmid]/e/[eid]/sketches to return fully defined status (UNDERDEFINED, WELL_DEFINED, OVERDEFINED, UNKNOWN)
  • Updated GET : V7/partstudios/d/[did]/[wvm]/[wvmid]/e/[eid]/sketches vectors are now maps instead of arrays, and may be BTVector2d or BTVector3d depending on the output3D parameter
  • Updated GET : V7/partstudios/d/[did]/[wvm]/[wvmid]/e/[eid]/sketches to use more consistent naming:
Fields
sketch -> name
sketchId -> featureId
transformMatrix -> sketchMatrix
featuresUsed -> featuresUsingSketch
geomEntities -> entities
  • Updated GET : /variables endpoint to return variable description when variable is set through custom feature
  • Updated POST : /webhooks endpoint to default to isTransient = true if not specified (auto cleanup)
  • Updated descriptions for Assembly, Documents, Metadata, Parts, Part Studios, Revisions, Variables and Versions enddpoints

rel-1.182 - released 2024-06-07

  • Updated descriptions for webhooks endpoints

rel-1.181 - released 2024-05-17

  • Update Document, Assembly, Blob, Drawing and Part Studio translation POST endpoints to have a new request body property occurancesToExport
  • Update to /elements endpoint summary and descriptions in Glassworks
  • Updated documentation for webhooks (https://onshape-public.github.io/docs/app-dev/webhook/)

rel-1.180 - released 2024-04-26

rel-1.179 - released 2024-04-05

  • New drawing views list endpoint GET : /appelements/[:did]/[:wvm]/[:wvmid]/e/[:eid]/views
  • New drawing view endpoint GET : /appelements/[:did]/[:wvm]/[:wvmid]/e/[:eid]/views/[:viewid]/jsongeometry
  • New updated features endpoint documentation
  • Updated glassworks for all metadata endpoints to reference developer documentation
  • Added description of output to schema for Metadata APIs
  • Updated translation endpoints with new request property specifyMaterialData

rel-1.178 - released 2024-03-15

  • Update Part Studio translation POST endpoint to have a new request body property importMaterialDensity
  • Update active workflow endpost GET: /workflow/active to have a new response property hasInactiveCustomWorkflows
  • Updated authorization (OAuth2 and BasicAuth) for publication endpoints
  • Various updates to descriptions of data types and query parameters
  • Fixed delete publication endpoint (HTTP::200 now removes publication)

rel-1.177 - released 2024-02-23

  • Updated translation endpoints with new request property useIGESImportPostProcessing
  • Updated translation endpoints with modified request property stepParasolidPreprocessingOption
  • Updated descriptions for metadata | releasepackages for property propertyOverrideStatus

rel-1.176 - released 2024-02-02

  • New create publication endpoint POST : /publications
  • New update publication endpoint POST: /publications/[:pid]
  • New delete publication endpoint DELETE: /publications/[:pid]
  • New create publication item endpoint POST : /publications/item
  • New update publication item endpoint POST: /publications/item/[:iid]
  • New delete publication item endpoint DELETE: /publications/item/[:iid]

rel-1.175 - released 2024-01-12

  • Exclude suppressed sub assemblies from rootAssembly occurrences for GET: /assemblies/d/[did]/[wvm]/[wvmid]/e/[eid]

rel-1.174 - released 2023-12-15

  • Add microversion id the extension url [$microversionId]
  • Updated translation endpoints with new request property pdfVersion
  • Fixed issue with bodydetails endpoints always returning isInner and isOuter the same
  • Update all endpoints for bodydetails | tessellatededges | tessellatedfaces | featurescript to include new response body errorEnum:
errorEnum
BODY_DRAFT_STRAY_NONMITER_EDGES
MASS_PROPERTY_FACES_NOT_COPLANAR
PARAMETER_VALUE_INVALID
SHEET_METAL_CHAMFER_NO_TANGENT_BASED
CHAMFER_DIRECTION_OVERRIDE_NO_EFFECT
FILLET_CHAMFER_UNSUPPORTED
CHAMFER_HELD_BACK
SWEEP_BAD_LOCK_DIRECTION
SHEET_METAL_COUNTER_HOLE_UNSUPPORTED
SWEEP_SELECT_DIRECTION
  • Update all endpoints for bodydetails | tessellatededges | tessellatedfaces | featurescript to include new property imageForeignId
  • Support sending a list of emails to POST : /classrooms/[cid]/members

rel-1.173 - released 2023-11-28

  • Update all classroom endpoints (/classrooms/) to support OAuth
  • Add description of output to schema for getAssemblyShadedViews API

rel-1.172 - released 2023-11-06

  • Update all endpoints for bodydetails | tessellatededges | tessellatedfaces | featurescript to include new response body errorEnum:
errorEnum
FIT_TOLERANCE_LIMITS_NOT_FOUND
FIT_TOLERANCE_SIZE_TOO_LARGE_ISO
FIT_TOLERANCE_SIZE_TOO_LARGE_ANSI
OFFSET_WIRE_SHEET_CREATION_FAILED
REPLACE_FACE_SHEET_SMALL
REPLACE_FACES_NOT_ADJACENT
SHEET_METAL_HOLE_REBUILD_FAILED
CPLANE_TANGENT_INPUT
CPLANE_TANGENT_SELECT_REFERENCE
CNE_TANGENT_PLANE_INVALID
CPLANE_TANGENT_POINT_INVALID
REPLACE_FACES_NOT_SAME_BODY
MUST_USE_DEFAULT_RADIUS_WITH_FACE_BEND
CANNOT_RIP_A_FACE_BEND
CANNOT_MAKE_A_FACE_BEND_TANGENT
  • References to API Guide for endpoint descriptions in Glassworks

rel-1.171 - released 2023-10-13

  • Update all translation POST endpoints to have a new request body properties hideInspectionItems and textOption
  • Replaced GET : /releasepackages/companyreleaseworkflow | /workflow/active property canCurrentUserSyncVersionsToArena with canCurrentUserSyncStandardContentToArena
  • Updated GET and POST : /tabletemplates endpoint with new response property valueType
  • Comprehensive update to remaining endpoint summary and descriptions in Glassworks

rel-1.170 - released 2023-09-22

  • New appelements delete subelement endpoint DELETE : /appelements/d/[did]/[wvm]/[wvmid]/e/[eid]/content/subelements
  • New company add new user endoint POST : /companies/[cid]/users
  • New company update user endoint POST : /companies/[cid]/users/[uid]
  • New company delete user endoint DELETE : /companies/[cid]/users/[uid]
  • Comprehensive update to remaining endpoint summary and descriptions in Glassworks

rel-1.169 - released 2023-09-01

  • Comprehensive update to most endpoint summary and descriptions in Glassworks
  • Update all translation endpoints to include new property importAppearances
  • Update POST : /partstudios/d/[did]/[wvm]/[wvmid]/e/[eid]/featurescript has a new property expressionErrorInfo
  • Update GET and POST : /releasepackages/[rpid] property workflow/actions has a new enum value REASSIGN_TASK

rel-1.168 - released 2023-08-11

  • Deprecated POST : /api/drawings/create -> Replaced with POST : /api/drawings/d/[did]/w/w/[wid]/create
  • Update GET : /api/documents endpoint has a new property publishedVersion
  • Update GET and POST : /api/releasepackages/[rpid] has a new property syncedWithPLM

rel-1.167 - released 2023-07-21

  • Update glTF translation endpoints to use new field useGltfCompression (bool)
  • Update STEP translation endpoints to use new field stepParasolidPreprocessingOption (0-None, 1-Advanced, 2-Automatic, 3-Basic)
  • Update GET : /api/documents | /api/documents/[did] | /api/companies/[cid]/documentsbyname to include new field forceExportRules

rel-1.165 - released 2023-06-12

  • Support partId array string for GET : /api/partstudios/bodydetails endpoint for the option of getting a subset of parts from a partstudio (empty = all parts)

rel-1.163 - released 2023-04-28

  • Update documentation for the Documents endpoint (/api/documents)
  • Update Releasepackage endpoint GET : /api/releasepackage to include type to understand action (ie. Approve vs Reject)
  • Update API to V6 - Fix a bug in how updating the JSON tree of an app element in a transaction returns the diff

rel-1.162 - released 2023-04-12

  • New Assembly modify endpoint POST : /api/assemblies/d/{did}/w/{wid}/e/{eid}/modify for bulk deletion and suppression of instances and features

rel-1.161 - released 2023-03-20

  • New BOM templates endpoint (/api/tabletemplates)
  • Support POST /api/webhooks parameter isTransient = true to specify auto cleanup after a set number of days

rel-1.160 - released 2023-02-24

  • Support configuratons for GET : /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features
  • Remove deprecated GET : /api/elements/:emid
  • Remove deprecated GET and POST : /api/elements/d/:did/[wvm]/:wvmid/e/:eid/metadata
  • Deprecated GET and POST : /api/parts/standardcontent/d/:did/v/:vid/e/:eid/[cu]/:cuid/partid/:pid/metadata
  • Deprecated GET and POST : /api/parts/d/:did/[wvm]/:wmvid/e/:eid/partid/:pid/metadata

rel-1.158 - released 2023-01-11

  • New example values in Glassworks API documentation

rel-1.155 - released 2022-11-01

  • Support Parasolid binary (x_b) exports

rel-1.154 - released 2022-10-10

  • Add face color, hidden state and type of composite to body details endpoint

rel-1.152 - released 2022-08-30

  • Support more parameters to filter the partstudio endpoint

rel-1.147 - released 2022-05-16

  • Support global tree node endpoint for impacting recently opened filter

rel-1.146 - released 2022-04-25

  • Support API versioning
  • Return ‘nodeId’ when adding or updating an AppElement

rel-1.145 - released 2022-04-05

  • Fixed issue where assembly feature errors were missing

rel-1.140 - released 2021-12-15

  • Add mass properties for assemblies

rel-1.139 - released 2021-11-15

  • Relax casing search in Glassworks (Swagger client)
  • BOM and Metadata API endpoint responses now matched

rel-1.138 - released 2021-10-25

  • Updated webhook documentation

rel-1.135 - released 2021-8-20

  • Webhook events for Enterprise SSO configuration changes

rel-1.134 - released 2021-07-30

  • Support comment events (add, update, delete) for the web-hook endpoint

rel-1.131 - released 2021-06-01

  • Add synchronous glTF/gLB endpoint for assemblies

rel-1.128 - released 2021-03-29

  • Support face color for export of glTF/gLB
  • Add document API endpoint for comments

rel-1.127 - released 2021-03-08

  • Add translation option dtkPeriodicFacesPolicy=3 for CATIA parts

rel-1.126 - released 2021-02-12

  • Add GLTF and GLB accepts option to the tessellation APIs

rel-1.125 - released 2021-01-25

  • Add ‘good/better/best’ quality query parameters to tessellation endpoint

rel-1.122 - released 2020-11-18

  • Enforce OAuth endpoint rate limiting
  • Add release package action/transition based webhooks

rel-1.119 - released 2020-09-15

  • Add rollback bar to EvalFeatureScript endpoint

rel-1.118 - released 2020-08-25

  • PartStudio GET support for sketch constraints in features endpoint

rel-1.116 - released 2020-07-15

  • Specify starting elements to create document endpoint

rel-1.114 - released 2020-06-03

  • Project endpoints

rel-1.113 - released 2020-05-11

  • Output GLTF files for an element (tab)

rel-1.111 - released 2020-03-31

  • Support ownership transfer for teams

rel-1.110 - released 2020-03-09

  • Add support for exploded views

rel-1.108 - released 2020-01-29

  • Drawings endpoints for create 4 view, get view geometry and view definition

rel-1.102 - released 2019-09-11

  • Added webhook events for release management
  • Added webhook event for document version creation

rel-1.99 - released 2019-07-08

  • Assembly BOM API support for items

rel-1.96 - released 2019-05-03

  • Part Studio compare endpoint

rel-1.93 - released 2019-03-01

  • Webhook subscriptions for a company

rel-1.86 - released 2018-09-28

  • Export Drawings to DXF, DWG and PDF