{ "opencollection": "1.0.0", "info": { "name": "Onshape REST Account PartStudio API", "version": "1.218.84032-34acba44be17" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "PartStudio", "type": "folder" }, "items": [ { "info": { "name": "Get a list of all named views that exist in the Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/e/:eid/namedViews", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "eid", "value": "", "type": "path" }, { "name": "skipPerspective", "value": "", "type": "query" }, { "name": "includeSectionCutViews", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a map from view name to view data for the given element. See the [Part Studios API Guide](https://onshape-public.github.io/docs/api-adv/partstudios/) for details and tutorials." }, { "info": { "name": "Create a new Part Studio in a document.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/w/:wid", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wid", "value": "", "type": "path", "description": "Workspace ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "See the [Part Studios API Guide](https://onshape-public.github.io/docs/api-adv/partstudios/) for details and tutorials." }, { "info": { "name": "Update the definition of a Part Studio feature.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/w/:wid/e/:eid/features/featureid/:fid", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wid", "value": "", "type": "path", "description": "Workspace ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "fid", "value": "", "type": "path", "description": "The id of the feature being updated. This id should be URL encoded and must match the featureId found in the serialized structure" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replaces an existing feature in the location of the existing feature. See the [Features API Guide](https://onshape-public.github.io/docs/api-adv/featureaccess/) for additional information." }, { "info": { "name": "Delete a Part Studio feature.", "type": "http" }, "http": { "method": "DELETE", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/w/:wid/e/:eid/features/featureid/:fid", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wid", "value": "", "type": "path", "description": "Workspace ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "fid", "value": "", "type": "path", "description": "The id of the feature being updated. This id should be URL encoded and must match the featureId found in the serialized structure" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "See the [Features API Guide](https://onshape-public.github.io/docs/api-adv/featureaccess/) for additional information." }, { "info": { "name": "Move the Feature List rollback bar in the Part Studio.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/w/:wid/e/:eid/features/rollback", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wid", "value": "", "type": "path", "description": "Workspace ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replace `\"string\"` in the request body with an object that specifies the new location for the rollback bar: \n `{ \"rollbackIndex\": integer }` \n\nFor example: `{ \"rollbackIndex\": 2 }` \n\nSet to `-1` to move the rollback bar to the end of the list. \n\nSee the [Part Studios API Guide](https://onshape-public.github.io/docs/api-adv/partstudios/) for details and tutorials." }, { "info": { "name": "Update multiple features in a Part Studio", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/w/:wid/e/:eid/features/updates", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wid", "value": "", "type": "path", "description": "Workspace ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API accepts a list of features (that must already exist in the Part Studio) to update. This call does not fully redefine the features; it updates only the parameters supplied in the top-level feature structure, and optionally can update feature suppression attributes. \nSee the [Features API Guide](https://onshape-public.github.io/docs/api-adv/featureaccess/) for additional information." }, { "info": { "name": "Get the body details for a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/bodydetails", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." }, { "name": "partIds", "value": "", "type": "query", "description": "If specified, the response will only include body details for the specific parts as indicated here by their corresponding Id" }, { "name": "includeSurfaces", "value": "", "type": "query", "description": "Whether or not surfaces should be included in the response." }, { "name": "includeCompositeParts", "value": "", "type": "query", "description": "Whether or not composite parts should be included in the response." }, { "name": "includeGeometricData", "value": "", "type": "query", "description": "Whether or not geometric data should be included in the response." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "See the [Part Studios API Guide](https://onshape-public.github.io/docs/api-adv/partstudios/) for details and tutorials." }, { "info": { "name": "Get the bounding boxes for a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/boundingboxes", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "includeHidden", "value": "", "type": "query", "description": "Whether or not to include bounding boxes for hidden parts." }, { "name": "includeWireBodies", "value": "", "type": "query", "description": "Whether to include wire bodies in the bounding box." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint does not result in a tight bounding box. The values returned are meant for graphics and visualization, and are approximate. \nTo calculate a tight bounding box, see the [FeatureScript API Guide](https://onshape-public.github.io/docs/api-adv/fs/#calculate-a-tight-bounding-box). " }, { "info": { "name": "Get the differences between two Part Studios in a single document.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/compare", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "workspaceId", "value": "", "type": "query" }, { "name": "versionId", "value": "", "type": "query" }, { "name": "microversionId", "value": "", "type": "query" }, { "name": "sourceConfiguration", "value": "", "type": "query" }, { "name": "targetConfiguration", "value": "", "type": "query" }, { "name": "linkDocumentId", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the differences between two Part Studios in a single document." }, { "info": { "name": "Get a list of features instantiated in the Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/features", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." }, { "name": "includeGeometryIds", "value": "", "type": "query", "description": "If true, include the underlying geometry IDs in the feature definition." }, { "name": "featureId", "value": "", "type": "query", "description": "ID of a feature; repeat query param to add more than one" }, { "name": "noSketchGeometry", "value": "", "type": "query", "description": "Whether or not to output simple sketch info without geometry" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "See the [Features API Guide](https://onshape-public.github.io/docs/api-adv/featureaccess/) for additional information." }, { "info": { "name": "Add a feature to the Part Studio's Feature List.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/features", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wvm", "value": "", "type": "path" }, { "name": "wvmid", "value": "", "type": "path" }, { "name": "eid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The feature is added immediately before the rollback bar. Any geometry IDs specified in the feature must be valid at that point in the feature tree. \n \nSee the [Features API Guide](https://onshape-public.github.io/docs/api-adv/featureaccess/) for additional information." }, { "info": { "name": "Evaluate the FeatureScript snippet for a Part Studio.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/featurescript", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "See [API Guide: Evaluating FeatureScript](https://onshape-public.github.io/docs/api-adv/fs/) for more details. \n \nNote that only lambda expressions can be evaulated with this endpoint." }, { "info": { "name": "Get the FeatureScript representation of a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/featurescriptrepresentation", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the FeatureScript representation of a Part Studio." }, { "info": { "name": "Get the specs for a Part Studio feature.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/featurespecs", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of feature specs available within the Part Studio. A feature spec provides a data description of the feature's interface to a feature." }, { "info": { "name": "Compute and return a FeatureScript table for a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/fstable", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "tableNamespace", "value": "", "type": "query", "description": "Namespace of the custom table in FS. Must be in the form of: \n* `e{eid}::m{mid}` if the FS and PS tabs are in the same workspace. \n* `d{did}::v{vid}::e{eid}::m{mid}` if the tabs are in different workspaces. \n\nObtain the microversion id (`{mid}`) with [this endpoint](#/Document/getElementsInDocument) called on the FS tab.\n\nLeave blank if using a standard table. Required if using a custom `tableType`." }, { "name": "tableType", "value": "", "type": "query", "description": "May be any standard table type (i.e., `holeTable` or `cutlistTable`) or custom table type name defined in FeatureScript.\n\nIf using a custom table type, `tableNamespace` must also be specified." }, { "name": "tableParameters", "value": "", "type": "query", "description": "Include all parameters for the table. i.e., `customBool=false`" }, { "name": "partId", "value": "", "type": "query", "description": "ID of the part to retrieve." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Compute and return a FeatureScript table for a Part Studio." }, { "info": { "name": "Synchronously export a Part Studio to a glTF file.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/gltf", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." }, { "name": "partId", "value": "", "type": "query" }, { "name": "angleTolerance", "value": "", "type": "query" }, { "name": "chordTolerance", "value": "", "type": "query" }, { "name": "precomputedLevelOfDetail", "value": "", "type": "query" }, { "name": "outputSeparateFaceNodes", "value": "", "type": "query" }, { "name": "faceId", "value": "", "type": "query" }, { "name": "outputFaceAppearances", "value": "", "type": "query" }, { "name": "maxFacetWidth", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a synchronous export of the Part Studio (with limited tessellation settings) to a glTF file. \n* Returns a 307 redirect from which to download the exported file. \n* Export is much faster than asynchronous endpoints at the expense of limited control on tessellation settings. \n* Use the [PartStudio/createPartStudioTranslation](#/PartStudio/createPartStudioTranslation) asynchronous export for greater control. \n \nSee [API Guide: Synchronous Exports](https://onshape-public.github.io/docs/api-a" }, { "info": { "name": "Find corresponding deterministic IDs from a source document microversion at the target version.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/idtranslations", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "* Deterministic IDs are only valid for one microversion. \n* This maps deterministic IDs between microversions in an attempt to find the corresponding entities in each version." }, { "info": { "name": "Get the mass properties for a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/massproperties", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." }, { "name": "partId", "value": "", "type": "query" }, { "name": "massAsGroup", "value": "", "type": "query", "description": "If true, specified parts will be evaluated as a single object instead of individually" }, { "name": "useMassPropertyOverrides", "value": "", "type": "query", "description": "If true, use the user mass property overrides when calculated mass properties" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Parts must have density. The returned schema includes the same information as in the Onshape [Mass Properties Tool](https://cad.onshape.com/help/Content/massprops-ps.htm). \n \nWhen three values are returned: \n * The first is the calculated value. \n * The second is the minimum possible value, considering tolerance. \n * The third is the maximum possible value, considering tolerance. \n \n See the [Part Studios API Guide](https://onshape-public.github.io/docs/api-adv/partstudios/) for details and tuto" }, { "info": { "name": "Synchronously export a Part Studio to a Parasolid file.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/parasolid", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "partIds", "value": "", "type": "query", "description": "IDs of the parts to retrieve. Use comma-separated IDs for multiple parts (example: partIds=JHK,JHD)." }, { "name": "version", "value": "", "type": "query", "description": "Parasolid version" }, { "name": "includeExportIds", "value": "", "type": "query", "description": "Whether topology ids should be exported as parasolid attributes" }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter." }, { "name": "binaryExport", "value": "", "type": "query", "description": "Whether to use binary parasolid format instead of text" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a synchronous export of the Part Studio (with limited tessellation settings) to a Parasolid file. \n* Returns a 307 redirect from which to download the exported file. \n* Export is much faster than asynchronous endpoints at the expense of limited control on tessellation settings. \n* Use the [PartStudio/createPartStudioTranslation](#/PartStudio/createPartStudioTranslation) asynchronous export for greater control. \n \nSee [API Guide: Synchronous Exports](https://onshape-public.github.io/docs/" }, { "info": { "name": "Get a list of shaded views for a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/shadedviews", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "viewMatrix", "value": "", "type": "query", "description": "12-number view matrix (comma-separated), or one of the following named views:\ntop, bottom, front, back, left, right\nThe 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself.\nThe matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters).\nThe view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up.\nFor example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view.\nThe first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined." }, { "name": "outputHeight", "value": "", "type": "query", "description": "Output image height (in pixels)" }, { "name": "outputWidth", "value": "", "type": "query", "description": "Output image width (in pixels)" }, { "name": "pixelSize", "value": "", "type": "query", "description": "Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions." }, { "name": "edges", "value": "", "type": "query", "description": "The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges." }, { "name": "showAllParts", "value": "", "type": "query", "description": "Whether or not all parts should be shown in the element,\nregardless of user setting. If false, the visibility setting made by the user will be reflected in the\nimage. If true, all parts will be shown." }, { "name": "includeSurfaces", "value": "", "type": "query", "description": "Whether or not surfaces should be shown in the element.\nIt is applicable only when showAllParts is true. If false, surfaces will be excluded.\nIf true, all surfaces will be shown." }, { "name": "useAntiAliasing", "value": "", "type": "query", "description": "If true, an anti-aliasing factor will be used to smooth\nmodel boundaries in the final image result. If false, the image will be rasterized at the given\nresolution. Setting to true can have negative performance implications with respect to rendering time\nand memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server\nmay not be able to fulfill the request." }, { "name": "includeWires", "value": "", "type": "query" }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a list of shaded views for a Part Studio." }, { "info": { "name": "Synchronously export a Part Studio to an STL file.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/stl", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wvm", "value": "", "type": "path", "description": "One of w or v or m corresponding to whether a workspace or version or microversion was entered." }, { "name": "wvmid", "value": "", "type": "path", "description": "Workspace (w), Version (v) or Microversion (m) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." }, { "name": "partIds", "value": "", "type": "query", "description": "IDs of the parts to retrieve. Use comma-separated IDs for multiple parts (example: partIds=JHK,JHD)." }, { "name": "mode", "value": "", "type": "query", "description": "Type of file: text, binary" }, { "name": "grouping", "value": "", "type": "query", "description": "Whether parts should be exported as a group or individually in a .zip file" }, { "name": "scale", "value": "", "type": "query", "description": "Scale for measurements." }, { "name": "units", "value": "", "type": "query", "description": "Units for the element: `METER` | `CENTIMETER` | `MILLIMETER` | `INCH` | `FOOT` | `YARD`" }, { "name": "angleTolerance", "value": "", "type": "query", "description": "Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated." }, { "name": "chordTolerance", "value": "", "type": "query", "description": "Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated." }, { "name": "maxFacetWidth", "value": "", "type": "query", "description": "Max facet width. This specifies the limit on the size of any side of a tessellation facet." }, { "name": "minFacetWidth", "value": "", "type": "query", "description": "Max facet width. This specifies the limit on the size of any side of a tessellation facet." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a synchronous export of the Part Studio (with limited tessellation settings) to an STL file. \n* Returns a 307 redirect from which to download the exported file. \n* Export is much faster than asynchronous endpoints at the expense of limited control on tessellation settings. \n* Use the [PartStudio/createPartStudioTranslation](#/PartStudio/createPartStudioTranslation) asynchronous export for greater control. \n \nSee [API Guide: Synchronous Exports](https://onshape-public.github.io/docs/api-a" }, { "info": { "name": "Get a list of all edges in a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/tessellatededges", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." }, { "name": "partId", "value": "", "type": "query" }, { "name": "angleTolerance", "value": "", "type": "query" }, { "name": "chordTolerance", "value": "", "type": "query" }, { "name": "precomputedLevelOfDetail", "value": "", "type": "query" }, { "name": "edgeId", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the edges as tessellated data and includes display data. \nCoordinates are in meters (m)." }, { "info": { "name": "Get a list of all faces in a Part Studio.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wvm/:wvmid/e/:eid/tessellatedfaces", "params": [ { "name": "did", "value": "", "type": "path", "description": "The id of the document in which to perform the operation." }, { "name": "linkDocumentId", "value": "", "type": "query", "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both." }, { "name": "wvm", "value": "", "type": "path", "description": "Indicates which of workspace (w), version (v), or document microversion (m) id is specified below." }, { "name": "wvmid", "value": "", "type": "path", "description": "The id of the workspace, version or document microversion in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." }, { "name": "configuration", "value": "", "type": "query", "description": "URL-encoded string of configuration values (separated by `;`). See the [Configurations API Guide](https://onshape-public.github.io/docs/api-adv/configs/) for details." }, { "name": "rollbackBarIndex", "value": "", "type": "query", "description": "Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist." }, { "name": "elementMicroversionId", "value": "", "type": "query", "description": "A specific element microversion in which to evaluate the request." }, { "name": "partId", "value": "", "type": "query" }, { "name": "angleTolerance", "value": "", "type": "query" }, { "name": "chordTolerance", "value": "", "type": "query" }, { "name": "precomputedLevelOfDetail", "value": "", "type": "query" }, { "name": "faceId", "value": "", "type": "query" }, { "name": "outputFaceAppearances", "value": "", "type": "query" }, { "name": "maxFacetWidth", "value": "", "type": "query" }, { "name": "outputVertexNormals", "value": "", "type": "query" }, { "name": "outputFacetNormals", "value": "", "type": "query" }, { "name": "outputTextureCoordinates", "value": "", "type": "query" }, { "name": "outputIndexTable", "value": "", "type": "query" }, { "name": "outputErrorFaces", "value": "", "type": "query" }, { "name": "combineCompositePartConstituents", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Coordinates are in meters (m)." }, { "info": { "name": "Asynchronously export a Part Studio to glTF.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wv/:wvid/e/:eid/export/gltf", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wv", "value": "", "type": "path", "description": "One of w or v corresponding to whether a workspace or version was specified." }, { "name": "wvid", "value": "", "type": "path", "description": "Workspace (w) or Version (v) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an asynchronous export of a Part Studio to glTF. See [API Guide: Asynchronous Exports](https://onshape-public.github.io/docs/api-adv/translation/#export-a-part-studio-to-gltf-obj-solidworks-or-step) for more details." }, { "info": { "name": "Asynchronously export a Part Studio to OBJ.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wv/:wvid/e/:eid/export/obj", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wv", "value": "", "type": "path", "description": "One of w or v corresponding to whether a workspace or version was specified." }, { "name": "wvid", "value": "", "type": "path", "description": "Workspace (w) or Version (v) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an asynchronous export of a Part Studio to OBJ. See [API Guide: Asynchronous Exports](https://onshape-public.github.io/docs/api-adv/translation/#export-a-part-studio-to-gltf-obj-solidworks-or-step) for more details." }, { "info": { "name": "Asynchronously export a Part Studio to STEP.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wv/:wvid/e/:eid/export/step", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wv", "value": "", "type": "path", "description": "One of w or v corresponding to whether a workspace or version was specified." }, { "name": "wvid", "value": "", "type": "path", "description": "Workspace (w) or Version (v) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an asynchronous export of a Part Studio to STEP. See [API Guide: Asynchronous Exports](https://onshape-public.github.io/docs/api-adv/translation/#export-a-part-studio-to-gltf-obj-solidworks-or-step) for more details." }, { "info": { "name": "Asynchronously export a Part Studio to another format.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/partstudios/d/:did/:wv/:wvid/e/:eid/translations", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." }, { "name": "wv", "value": "", "type": "path", "description": "One of w or v corresponding to whether a workspace or version was specified." }, { "name": "wvid", "value": "", "type": "path", "description": "Workspace (w) or Version (v) ID." }, { "name": "eid", "value": "", "type": "path", "description": "Element ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an asynchronous export of a Part Studio to another file format. \n* Can take longer than synchronous export options, but supports more formats and provides more control on tessellation and other settings. \n* Use `formatName` in the JSON request body to specify the export file type. Use [Translations/getAllTranslatorFormats](#/Translation/getAllTranslatorFormats) to get a list of valid export file formats. `\n* Set `storeInDocument` to `false` to export to a data file. Set to `true` to expo" } ] } ], "bundled": true }