onshape-clients

{ "openapi": "3.0.1", "info": { "title": "Onshape REST API", "description": "The Onshape REST API consumed by all clients.", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "api-support@onshape.zendesk.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.111", "x-logo": { "backgroundColor": "#ffffff", "altText": "Onshape", "href": "https://www.onshape.com/", "url": "http://localhost.dev.onshape.com:8084/images/onshape_logo_medium.png" } }, "servers": [ { "url": "https://cad.onshape.com", "description": "Production" } ], "tags": [ { "name": "Applications", "description": "Manage application settings." }, { "name": "Accounts", "description": "Modify and access account information." }, { "name": "App Elements", "description": "Save and manage application state." }, { "name": "Assemblies", "description": "Access and manipulate assembly elements." }, { "name": "Billing", "description": "Access billing plans for clients." }, { "name": "BlobElements", "description": "Save and access Blob Elements." }, { "name": "Companies", "description": "Access company information." }, { "name": "Documents", "description": "Manage documents." }, { "name": "Drawings", "description": "Access drawing translations." }, { "name": "Elements", "description": "Access and manipulate Elements." }, { "name": "FeatureStudios", "description": "Access and write to Feature Studio Elements." }, { "name": "Folders", "description": "Access Folders." }, { "name": "Metadata", "description": "Manipulate and access metadata." }, { "name": "OpenAPI", "description": "Endpoints for getting the OpenAPI specification for the Onshape API." }, { "name": "Parts", "description": "Get details about specific parts." }, { "name": "PartStudios", "description": "Modify, change, and get PartStudios." }, { "name": "ReleaseManagement", "description": "Manage Release Management workflows." }, { "name": "Revisions", "description": "Access revisions." }, { "name": "Teams", "description": "Access team details." }, { "name": "Translations", "description": "Create and manage translations." }, { "name": "Users", "description": "Get details about users." }, { "name": "Versions", "description": "Example of API version management." }, { "name": "Webhooks", "description": "Create and manage webhooks." }, { "name": "Workflow", "description": "Access Release Management workflows." } ], "paths": { "/api/accounts/plans/{planId}/purchases": { "get": { "tags": [ "Accounts" ], "summary": "Get Plan Purchases", "operationId": "getPlanPurchases", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTListResponseBTPurchaseInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTListResponseBTPurchaseInfo" } } } } }, "deprecated": false, "x-BTVisibility": "PRODUCTION" } }, "/api/accounts/purchases": { "get": { "tags": [ "Accounts" ], "summary": "Get User's Appstore Purchases.", "operationId": "getPurchases", "parameters": [ { "name": "all", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "ownPurchaseOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BTPurchaseInfo" } } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BTPurchaseInfo" } } } } } }, "deprecated": false, "x-BTVisibility": "PRODUCTION" } }, "/api/accounts/purchases/{pid}/consume": { "post": { "tags": [ "Accounts" ], "summary": "Mark Purchase Consumed For User", "operationId": "consumePurchase", "parameters": [ { "name": "pid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTPurchaseUserParams" } } } }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTPurchaseInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTPurchaseInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Purchase" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/accounts/{aid}/purchases/{pid}": { "delete": { "tags": [ "Accounts" ], "summary": "Cancel Recurring Subscription", "operationId": "cancelPurchaseNew", "parameters": [ { "name": "aid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cancelImmediately", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": {}, "application/json;charset=UTF-8; qs=0.09": {} } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Purchase" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/w/{wid}": { "post": { "tags": [ "App Elements" ], "summary": "Create Element.", "operationId": "createElement", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementParams" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/w/{wid}/e/{eid}/transactions": { "post": { "tags": [ "App Elements" ], "summary": "Start Transaction", "operationId": "startTransaction", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementStartTransactionParams" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/w/{wid}/e/{eid}/transactions/{tid}": { "post": { "tags": [ "App Elements" ], "summary": "Commit Transaction", "operationId": "commitTransaction", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementCommitTransactionParams" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/associativedata": { "get": { "operationId": "getAssociativeData", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "changeId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "associativeDataId", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "elementId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "viewId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "microversionId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "documentMicroversion", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "deterministicId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "featureId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "entityId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "occurrenceId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "returnIdTags", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppAssociativeDataInfoArray" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppAssociativeDataInfoArray" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" }, "post": { "operationId": "postAssociativeData", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppAssociativeDataInfoArray" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppAssociativeDataInfoArray" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read", "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" }, "delete": { "operationId": "deleteAssociativeData", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "parentChangeId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "associativeDataId", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "elementId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "viewId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "microversionId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "documentMicroversion", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "deterministicId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "featureId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "entityId", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "occurrenceId", "in": "query", "schema": { "type": "string", "default": "" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementBasicInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementBasicInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content": { "get": { "tags": [ "App Elements" ], "summary": "Get Content", "operationId": "getSubElementContent", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "changeId", "in": "query", "schema": { "type": "string" } }, { "name": "baseChangeId", "in": "query", "schema": { "type": "string" } }, { "name": "subelementId", "in": "query", "schema": { "type": "string" } }, { "name": "linkDocumentId", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementContentInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementContentInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" }, "post": { "tags": [ "App Elements" ], "summary": "Update Element", "operationId": "updateAppElement", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementUpdateParams" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read", "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/history": { "get": { "tags": [ "App Elements" ], "summary": "Get History", "operationId": "getAppElementHistory", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementHistoryInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementHistoryInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/ids": { "get": { "tags": [ "App Elements" ], "summary": "Get Sub-element IDs", "operationId": "getSubelementIds", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "changeId", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements/{sid}": { "delete": { "tags": [ "App Elements" ], "summary": "Delete a Sub-element", "operationId": "deleteAppElementContent", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "parentChangeId", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementModifyInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references": { "post": { "tags": [ "App Elements" ], "summary": "Create Reference", "operationId": "createReference", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceParams" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write", "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid}": { "get": { "tags": [ "App Elements" ], "summary": "Resolve Reference", "operationId": "resolveReference", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "parentChangeId", "in": "query", "schema": { "type": "string" } }, { "name": "includeInternal", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "linkDocumentId", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceResolveInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceResolveInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" }, "post": { "tags": [ "App Elements" ], "summary": "Update Reference", "operationId": "updateReference", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceParams" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write", "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" }, "delete": { "tags": [ "App Elements" ], "summary": "Delete Reference", "operationId": "deleteReference", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "parentChangeId", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferenceInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Write" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/resolvereferences": { "get": { "tags": [ "App Elements" ], "summary": "Resolve references.", "operationId": "resolveReferences", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wvmid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "query", "schema": { "type": "string" } }, { "name": "parentChangeId", "in": "query", "schema": { "type": "string" } }, { "name": "includeInternal", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "linkDocumentId", "in": "query", "schema": { "type": "string" } }, { "name": "referenceIds", "in": "query", "schema": { "type": "string", "default": "" } } ], "responses": { "default": { "description": "default response", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTAppElementReferencesResolveInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTAppElementReferencesResolveInfo" } } } } }, "deprecated": false, "security": [ { "OAuth2": [ "OAuth2Read" ] } ], "x-BTVisibility": "PRODUCTION" } }, "/api/applications/clients/{cid}/settings/users/{uid}": { "get": { "tags": [ "Applications" ], "summary": "Get User Application Settings", "operationId": "getUserAppSettings", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success!", "content": { "application/vnd.onshape.v1+json;charset=UTF-8;qs=0.1": { "schema": { "$ref": "#/components/schemas/BTUserAppSettingsInfo" } }, "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTUserAppSettingsInfo" } } } } }, "deprecated": false, "x-BTVisibility": "PRODUCTION" }, "post": { "tags": [ "Applications" ], "summary": "Update Application Settings", "operationId": "updateAppSettings", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8; qs=0.09": { "schema": { "$ref": "#/components/schemas/BTUserAppSettingsParams" } } }, "required": true }, "responses": { "200": { "description": "Success!" } }, "deprecated": false, "x-BTVisibility": "PRODUCTION" }, "delete": { "tags": [ "Applications" ], "summary": "Delete Application Settings", "operationId": "deleteAppSettings", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success!" } }, "deprecated": false, "x-BTVisibility": "PRODUCTION" } }, "/api/assemblies/d/{did}/e/{eid}/namedViews": { "get": { "tags": [ "Assemblies" ], "operationId": "getNamedViews", "parameters": [ { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skipPerspective", "in": "query", "schema": { "type": "boolean",