{ "opencollection": "1.0.0", "info": { "name": "Onshape REST Account Document API", "version": "1.218.84032-34acba44be17" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Document", "type": "folder" }, "items": [ { "info": { "name": "Get a list of documents that meet the criteria you specify.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents", "params": [ { "name": "q", "value": "", "type": "query", "description": "Search for documents that contain the given string in the name. Search is not case-sensitive." }, { "name": "filter", "value": "", "type": "query", "description": "Type of documents to search: `0: My Documents | 1: Created | 2: Shared | 3: Trash | 4: Public | 5: Recent | 6: By Owner | 7: By Company | 9: By Team`" }, { "name": "owner", "value": "", "type": "query", "description": "Owner ID. Can be a user ID, company ID, or team ID, depending on `ownerType`." }, { "name": "ownerType", "value": "", "type": "query", "description": "Type of owner. `0: User | 1: Company | 2: Onshape`. If the owner is a teamId, leave this unspecified." }, { "name": "sortColumn", "value": "", "type": "query", "description": "Column by which to sort search results. `name | modifiedAt | createdAt (default) | email | modifiedBy | promotedAt`" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order. `desc` (descending, default), or `asc` (ascending)." }, { "name": "label", "value": "", "type": "query", "description": "Label" }, { "name": "project", "value": "", "type": "query", "description": "Project" }, { "name": "parentId", "value": "", "type": "query", "description": "Parent Id" }, { "name": "offset", "value": "", "type": "query", "description": "Offset. Determines where search results begin. Default value is 0." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page. Default value is 20 (also the maximum). Number of results returned can be less than this value. Use the `next` URL in the response to fetch the next page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a list of documents that meet the criteria you specify." }, { "info": { "name": "Create and upload a document.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The `name` field is required in the `BTDocumentParams` schema when creating a new document." }, { "info": { "name": "Download external data file(s) associated with the document.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/externaldata/:fid", "headers": [ { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "fid", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "* See [API Guide: Model Translation](https://onshape-public.github.io/docs/api-adv/translation/) for more details.\n* If downloading an exported file, poll the `requestState` in the translation response and wait for a result of `DONE` before attempting to download the file. \n* Use the `resultExternalDataIds` from the translation response as the foreign id (`{fid}`) in this API." }, { "info": { "name": "Retrieve versions by document ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/versions", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve versions by document ID." }, { "info": { "name": "Create version by document ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/versions", "params": [ { "name": "did", "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": "Create version by document ID." }, { "info": { "name": "Retrieve version by document ID and version ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/versions/:vid", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "vid", "value": "", "type": "path" }, { "name": "parents", "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": "Retrieve version by document ID and version ID." }, { "info": { "name": "Update external references to latest by document ID, workspace ID, and tab ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/w/:wid/e/:eid/latestdocumentreferences", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wid", "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": "Update external references to latest by document ID, workspace ID, and tab ID." }, { "info": { "name": "Move tab by document ID and workspace ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/w/:wid/moveelement", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wid", "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": "Move tab by document ID and workspace ID." }, { "info": { "name": "revertUnchangedToRevisions", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/w/:wid/revertunchangedtorevisions", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "syncAppElements", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/w/:wid/syncAppElements", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Retrieve workspaces by document ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/workspaces", "params": [ { "name": "did", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve workspaces by document ID." }, { "info": { "name": "Create workspace by document ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/workspaces", "params": [ { "name": "did", "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": "Create workspace by document ID." }, { "info": { "name": "Delete workspace by document ID and workspace ID.", "type": "http" }, "http": { "method": "DELETE", "url": "https://cad.onshape.com/api/v16/documents/d/:did/workspaces/:wid", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wid", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete workspace by document ID and workspace ID." }, { "info": { "name": "Retrieve document history by document ID and workspace or microversion ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wm/:wmid/documenthistory", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wm", "value": "", "type": "path" }, { "name": "wmid", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve document history by document ID and workspace or microversion ID." }, { "info": { "name": "Retrieve tabs and folders by document ID and workspace or version or microversion ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wvm/:wvmid/contents", "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": "elementType", "value": "", "type": "query", "description": "If specified, information for elements of this type are returned. Note, the folder structure is not affected by this filter." }, { "name": "elementId", "value": "", "type": "query", "description": "If specified, only the element with this id is returned. Note, the folder structure is not affected by this filter." }, { "name": "withZipContents", "value": "", "type": "query", "description": "When true, returns the names of the files inside each zip file tab. Ignored if the document contains more than 10 zip files." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns information on tabs and folders in the document." }, { "info": { "name": "Retrieve tabs by document ID and workspace or version or microversion ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wvm/:wvmid/elements", "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": "elementType", "value": "", "type": "query" }, { "name": "elementId", "value": "", "type": "query" }, { "name": "withThumbnails", "value": "", "type": "query" }, { "name": "withZipContents", "value": "", "type": "query", "description": "When true, returns the names of the files inside each zip file tab. Ignored if the document contains more than 10 zip files." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint only returns the tabs and not folders in the document. Use the [getDocumentContents](#/Document/getDocumentContents) endpoint to get information about folders and tabs." }, { "info": { "name": "Get the selected units and precision by document ID and workspace or version or microversion ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wvm/:wvmid/unitinfo", "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." } ] }, "docs": "Get the selected units and precision by document ID and workspace or version or microversion ID." }, { "info": { "name": "Retrieve current microversion by document ID and workspace or version ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wv/:wvid/currentmicroversion", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wv", "value": "", "type": "path" }, { "name": "wvid", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve current microversion by document ID and workspace or version ID." }, { "info": { "name": "Export document by document ID, workspace or version ID, and tab ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wv/:wvid/e/:eid/export", "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": "wv", "value": "", "type": "path", "description": "Indicates which of workspace (w) or version (v) id is specified below." }, { "name": "wvid", "value": "", "type": "path", "description": "The id of the workspace, version in which the operation should be performed." }, { "name": "eid", "value": "", "type": "path", "description": "The id of the element in which to perform the operation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Export document by document ID, workspace or version ID, and tab ID." }, { "info": { "name": "Retrieve insertables by document ID and workspace or version ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/d/:did/:wv/:wvid/insertables", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wv", "value": "", "type": "path" }, { "name": "wvid", "value": "", "type": "path" }, { "name": "elementId", "value": "", "type": "query" }, { "name": "configuration", "value": "", "type": "query" }, { "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": "includeParts", "value": "", "type": "query" }, { "name": "includeSurfaces", "value": "", "type": "query" }, { "name": "includeSketches", "value": "", "type": "query" }, { "name": "includeReferenceFeatures", "value": "", "type": "query" }, { "name": "includeAssemblies", "value": "", "type": "query" }, { "name": "includeFeatureStudios", "value": "", "type": "query" }, { "name": "includeBlobs", "value": "", "type": "query" }, { "name": "allowedBlobMimeTypes", "value": "", "type": "query" }, { "name": "excludeNewerFSVersions", "value": "", "type": "query" }, { "name": "maxFeatureScriptVersion", "value": "", "type": "query" }, { "name": "includePartStudios", "value": "", "type": "query" }, { "name": "includeFeatures", "value": "", "type": "query" }, { "name": "includeMeshes", "value": "", "type": "query" }, { "name": "includeWires", "value": "", "type": "query" }, { "name": "includeFlattenedBodies", "value": "", "type": "query" }, { "name": "includeApplications", "value": "", "type": "query" }, { "name": "allowedApplicationMimeTypes", "value": "", "type": "query" }, { "name": "includeCompositeParts", "value": "", "type": "query" }, { "name": "includeFSTables", "value": "", "type": "query" }, { "name": "includeFSComputedPartPropertyFunctions", "value": "", "type": "query" }, { "name": "includeVariables", "value": "", "type": "query" }, { "name": "includeVariableStudios", "value": "", "type": "query" }, { "name": "allowedBlobExtensions", "value": "", "type": "query" }, { "name": "isObsoletion", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve insertables by document ID and workspace or version ID." }, { "info": { "name": "Search document.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This returns list of documents based on search parameters." }, { "info": { "name": "Retrieve document by document ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/:did", "params": [ { "name": "did", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve document by document ID." }, { "info": { "name": "Update document attributes by document ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did", "params": [ { "name": "did", "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": "Use [updateDocumentNotes](#/Document/updateDocumentNotes) to update document notes." }, { "info": { "name": "Delete document by document ID.", "type": "http" }, "http": { "method": "DELETE", "url": "https://cad.onshape.com/api/v16/documents/:did", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "forever", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete document by document ID." }, { "info": { "name": "Retrieve access control list by document ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/:did/acl", "params": [ { "name": "did", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve access control list by document ID." }, { "info": { "name": "Allow or deny anonymous access to a document or publication.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/acl/anonymousAccess", "params": [ { "name": "did", "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": "If anonymous access is allowed, you can allow or deny anonymous users the ability to export the document or publication. If `anonymousAccessAllowed=false` and `anonymousAllowsExport=true`, the call will throw an error." }, { "info": { "name": "Make a document public or private.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/acl/public", "params": [ { "name": "did", "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": " * Set `public=true` in the request body to make the document public. Set to `false` to make it private. Free users cannot make documents private. \n * The `documentId` provided in the URL must match the one provided in the request body exactly. " }, { "info": { "name": "Update document notes by document ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/notes", "params": [ { "name": "did", "value": "", "type": "path", "description": "ID of the document to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Use this endpoint to update documents notes. Use [updateDocumentAttributes](#/Document/updateDocumentAttributes) to update other document attributes." }, { "info": { "name": "Retrieve Document permissions by document ID.", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/:did/permissionset", "params": [ { "name": "did", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve Document permissions by document ID." }, { "info": { "name": "Share document by document ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/share", "params": [ { "name": "did", "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": "Share document by document ID." }, { "info": { "name": "Remove document View permissions from a user or other entity.", "type": "http" }, "http": { "method": "DELETE", "url": "https://cad.onshape.com/api/v16/documents/:did/share/:eid", "params": [ { "name": "did", "value": "", "type": "path", "description": "ID of the document to unshare." }, { "name": "eid", "value": "", "type": "path", "description": "ID of the entity to remove permissions for. Uses `userId`, `companyId`, `teamId`, `documentId`, or `applicationId`, depending on the `entryType` value." }, { "name": "entryType", "value": "", "type": "query", "description": "`0` (user) | `1` (company) | `2` (team) | `3` (document) | `4` (application) | `5` (connection_user)" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Specify the ID of the entity to unshare with in the `eid` field, and specify the type of entity being identified in the `entryType` field. For example, to unshare a document with a company, you would use `1` as the `entryType` value and the `companyId` as the `entityId`." }, { "info": { "name": "Share document by document ID with Onshape support.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/shareWithSupport", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Share document by document ID with Onshape support." }, { "info": { "name": "Unshare document with support.", "type": "http" }, "http": { "method": "DELETE", "url": "https://cad.onshape.com/api/v16/documents/:did/shareWithSupport", "params": [ { "name": "did", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Unshare document with support." }, { "info": { "name": "Merge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID", "type": "http" }, "http": { "method": "GET", "url": "https://cad.onshape.com/api/v16/documents/:did/w/:wid/mergePreview", "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": "wid", "value": "", "type": "path", "description": "The id of the workspace in which to perform the operation." }, { "name": "sourceType", "value": "", "type": "query" }, { "name": "sourceId", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Merge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID" }, { "info": { "name": "Restore version or microversion to workspace by document ID, workspace ID, and version or microversion ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/w/:wid/restore/:vm/:vmid", "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": "wid", "value": "", "type": "path", "description": "The id of the workspace in which to perform the operation." }, { "name": "vm", "value": "", "type": "path" }, { "name": "vmid", "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": "Restore version or microversion to workspace by document ID, workspace ID, and version or microversion ID." }, { "info": { "name": "Copy workspace by document ID and workspace ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/workspaces/:wid/copy", "params": [ { "name": "did", "value": "", "type": "path", "description": "ID of the document to copy." }, { "name": "wid", "value": "", "type": "path", "description": "ID of the workspace to copy." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Copy workspace by document ID and workspace ID." }, { "info": { "name": "Merge into workspace by document ID and workspace ID.", "type": "http" }, "http": { "method": "POST", "url": "https://cad.onshape.com/api/v16/documents/:did/workspaces/:wid/merge", "params": [ { "name": "did", "value": "", "type": "path" }, { "name": "wid", "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": "Merge into workspace by document ID and workspace ID." } ] } ], "bundled": true }