Skip to content

Latest commit

 

History

History
618 lines (599 loc) · 44.7 KB

README.md

File metadata and controls

618 lines (599 loc) · 44.7 KB

Rust API client for openapi

The Onshape REST API consumed by all clients.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.104
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

    openapi = { path = "./generated" }

Documentation for API Endpoints

All URIs are relative to https://cad.onshape.com

Class Method HTTP request Description
AccountsApi cancel_purchase_new Delete /api/accounts/{aid}/purchases/{pid} Cancel Recurring Subscription
AccountsApi consume_purchase Post /api/accounts/purchases/{pid}/consume Mark Purchase Consumed For User
AccountsApi get_plan_purchases Get /api/accounts/plans/{planId}/purchases Get Plan Purchases
AccountsApi get_purchases Get /api/accounts/purchases Get User's Appstore Purchases.
AppElementsApi commit_transaction Post /api/appelements/d/{did}/w/{wid}/e/{eid}/transactions/{tid} Commit Transaction
AppElementsApi create4 Post /api/appelements/d/{did}/w/{wid} Create Element.
AppElementsApi create_reference Post /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references Create Reference
AppElementsApi delete_content Delete /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements/{sid} Delete a Sub-element
AppElementsApi delete_reference Delete /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} Delete Reference
AppElementsApi get_history Get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/history Get History
AppElementsApi get_sub_element_content Get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content Get Content
AppElementsApi get_subelement_ids Get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/ids Get Sub-element IDs
AppElementsApi resolve_reference Get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} Resolve Reference
AppElementsApi resolve_references Get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/resolvereferences
AppElementsApi start_transaction Post /api/appelements/d/{did}/w/{wid}/e/{eid}/transactions Start Transaction
AppElementsApi update4 Post /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content Update Element
AppElementsApi update_reference Post /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} Update Reference
AssembliesApi add_feature Post /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/features
AssembliesApi create_assembly Post /api/assemblies/d/{did}/w/{wid}
AssembliesApi create_instance Post /api/assemblies/d/{did}/w/{wid}/e/{eid}/instances
AssembliesApi delete_feature Delete /api/assemblies/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid}
AssembliesApi delete_instance Delete /api/assemblies/d/{did}/w/{wid}/e/{eid}/instance/nodeid/{nid}
AssembliesApi get_assembly_definition Get /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}
AssembliesApi get_bill_of_materials Get /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/bom
AssembliesApi get_bounding_boxes Get /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes
AssembliesApi get_feature_specs Get /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/featurespecs
AssembliesApi get_features Get /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/features
AssembliesApi get_named_views Get /api/assemblies/d/{did}/e/{eid}/namedViews
AssembliesApi get_or_create_bill_of_materials_element Post /api/assemblies/d/{did}/w/{wid}/e/{eid}/bomelement
AssembliesApi get_shaded_views Get /api/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews
AssembliesApi get_translator_formats Get /api/assemblies/d/{did}/w/{wid}/e/{eid}/translationformats
AssembliesApi insert_transformed_instances Post /api/assemblies/d/{did}/w/{wid}/e/{eid}/transformedinstances
AssembliesApi transform_occurrences Post /api/assemblies/d/{did}/w/{wid}/e/{eid}/occurrencetransforms
AssembliesApi translate_format Post /api/assemblies/d/{did}/{wv}/{wvid}/e/{eid}/translations
AssembliesApi update_feature Post /api/assemblies/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid}
BlobElementsApi download_file_workspace Get /api/blobelements/d/{did}/w/{wid}/e/{eid}
BlobElementsApi upload_file_create_element Post /api/blobelements/d/{did}/w/{wid}
DocumentsApi copy_workspace Post /api/documents/{did}/workspaces/{wid}/copy
DocumentsApi create_document Post /api/documents Create document.
DocumentsApi create_version Post /api/documents/d/{did}/versions
DocumentsApi create_workspace Post /api/documents/d/{did}/workspaces
DocumentsApi delete7 Delete /api/documents/{did}
DocumentsApi delete_workspace Delete /api/documents/d/{did}/workspaces/{wid}
DocumentsApi download_external_data Get /api/documents/d/{did}/externaldata/{fid} Download External Data
DocumentsApi export2_json Post /api/documents/d/{did}/{wv}/{wvid}/e/{eid}/export
DocumentsApi get_acl Get /api/documents/{did}/acl
DocumentsApi get_current_microversion Get /api/documents/d/{did}/{wv}/{wvid}/currentmicroversion Get Current Document Microversion
DocumentsApi get_document Get /api/documents/{did} Get Document
DocumentsApi get_document_permission_set Get /api/documents/{did}/permissionset
DocumentsApi get_documents Get /api/documents Get Documents
DocumentsApi get_elements1 Get /api/documents/d/{did}/{wvm}/{wvmid}/elements Get a list of elements in the workspace, version, or microversion of the document.
DocumentsApi get_insertables Get /api/documents/d/{did}/{wvm}/{wvmid}/insertables
DocumentsApi get_version Get /api/documents/d/{did}/versions/{vid} Get Version
DocumentsApi get_versions1 Get /api/documents/d/{did}/versions Get Versions
DocumentsApi get_workspaces1 Get /api/documents/d/{did}/workspaces Get Workspaces
DocumentsApi merge_into_workspace Post /api/documents/{did}/workspaces/{wid}/merge Merge into workspace
DocumentsApi restore_rendition Post /api/documents/{did}/workspaces/{wid}/restore/{mvid}
DocumentsApi sync_application_elements Post /api/documents/d/{did}/w/{wid}/syncApplicationElements
DocumentsApi update_external_references_to_latest_documents Post /api/documents/d/{did}/w/{wid}/e/{eid}/latestdocumentreferences
DrawingsApi get_translator_formats2 Get /api/drawings/d/{did}/w/{wid}/e/{eid}/translationformats
DrawingsApi translate_format4 Post /api/drawings/d/{did}/{wv}/{wvid}/e/{eid}/translations Create Drawing translation
ElementsApi copy_element_from_source_document Post /api/elements/copyelement/{did}/workspace/{wid}
ElementsApi decode_configuration Get /api/elements/d/{did}/{wvm}/{wvmid}/e/{eid}/configurationencodings/{cid}
ElementsApi delete8 Delete /api/elements/d/{did}/w/{wid}/e/{eid}
ElementsApi encode_configuration_map Post /api/elements/d/{did}/e/{eid}/configurationencodings
ElementsApi get_configuration Get /api/elements/d/{did}/{wvm}/{wvmid}/e/{eid}/configuration
ElementsApi get_element_by_version_deprecated Get /api/elements/{did}/version/{vid}
ElementsApi get_element_by_workspace_deprecated Get /api/elements/{did}/workspace/{wid}
ElementsApi get_element_metadata Get /api/elements/d/{did}/{wv}/{wvid}/e/{eid}/metadata
ElementsApi get_element_metadata_deprecated Get /api/elements/{emid}
ElementsApi get_element_translator_formats Get /api/elements/translatorFormats/{did}/{wid}/{eid}
ElementsApi get_translator_formats3 Get /api/elements/translatorFormats
ElementsApi update_configuration Post /api/elements/d/{did}/{wvm}/{wvmid}/e/{eid}/configuration
ElementsApi update_element_metadata Post /api/elements/d/{did}/{wv}/{wvid}/e/{eid}/metadata
ElementsApi update_references Post /api/elements/d/{did}/w/{wid}/e/{eid}/updatereferences
ElementsApi upload_file1 Post /api/elements/upload/{did}
FeatureStudiosApi create_feature_studio Post /api/featurestudios/d/{did}/w/{wid}
FeatureStudiosApi get_feature_studio_contents Get /api/featurestudios/d/{did}/{wvm}/{wvmid}/e/{eid} Get Feature Studio Contents.
FeatureStudiosApi get_feature_studio_specs Get /api/featurestudios/d/{did}/{wvm}/{wvmid}/e/{eid}/featurespecs
FeatureStudiosApi update_feature_studio_contents Post /api/featurestudios/d/{did}/{wvm}/{wvmid}/e/{eid}
MetadataApi get_veop_standard_content_metadata Get /api/metadata/standardcontent/d/{did}/v/{vid}/e/{eid}/{otype}/{oid}/p/{pid}
MetadataApi get_wmve_ps_metadata Get /api/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/p
MetadataApi get_wmvep_metadata Get /api/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/p/{pid}
MetadataApi get_wv_es_metadata Get /api/metadata/d/{did}/{wv}/{wvid}/e
MetadataApi get_wv_metadata Get /api/metadata/d/{did}/{wv}/{wvid}
MetadataApi get_wve_metadata Get /api/metadata/d/{did}/{wv}/{wvid}/e/{eid}
MetadataApi update_veop_standard_content_part_metadata Post /api/metadata/standardcontent/d/{did}/v/{vid}/e/{eid}/{otype}/{oid}/p/{pid}
MetadataApi update_wv_metadata Post /api/metadata/d/{did}/{wv}/{wvid}
MetadataApi update_wve_metadata Post /api/metadata/d/{did}/{wv}/{wvid}/e/{eid}
MetadataApi update_wvep_metadata Post /api/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/p/{pid}
OpenAPIApi get_open_api Get /api/openapi OpenAPI spec documentation for the Onshape REST API.
PartStudiosApi add_feature1 Post /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features Add Feature
PartStudiosApi compare_part_studios Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/compare Compare Part Studios
PartStudiosApi create_part_studio Post /api/partstudios/d/{did}/w/{wid} Create Part Studio
PartStudiosApi delete_feature1 Delete /api/partstudios/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid} Delete Feature
PartStudiosApi eval_feature_script Post /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/featurescript Evaluate FeatureScript
PartStudiosApi export_ps1 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/parasolid Export Part Studio to Parasolid
PartStudiosApi export_stl1 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/stl Export Part Studio to STL
PartStudiosApi get_body_details2 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/bodydetails Array of body information
PartStudiosApi get_bounding_boxes2 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes Mass properties of parts or a PartStudio.
PartStudiosApi get_configuration1 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/configuration Get Configuration
PartStudiosApi get_edges2 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatededges Tesselated edges from a PartStudio.
PartStudiosApi get_faces2 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatedfaces Tesselated faces of the parts in the Part Studio.
PartStudiosApi get_feature_specs1 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/featurespecs Get Feature Specs
PartStudiosApi get_features1 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features Get Feature List
PartStudiosApi get_mass_properties1 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties Mass properties of parts or a PartStudio.
PartStudiosApi get_named_views1 Get /api/partstudios/d/{did}/e/{eid}/namedViews Get Named Views
PartStudiosApi get_shaded_views2 Get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews Get Shaded Views
PartStudiosApi get_translator_formats4 Get /api/partstudios/d/{did}/w/{wid}/e/{eid}/translationformats Get Translation Formats
PartStudiosApi translate_format5 Post /api/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/translations Create Part Studio translation
PartStudiosApi translate_ids Post /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/idtranslations Id Translations
PartStudiosApi update_configuration1 Post /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/configuration Update Configuration
PartStudiosApi update_feature1 Post /api/partstudios/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid} Update Feature
PartStudiosApi update_features Post /api/partstudios/d/{did}/w/{wid}/e/{eid}/features/updates Update Features
PartStudiosApi update_rollback Post /api/partstudios/d/{did}/w/{wid}/e/{eid}/features/rollback Update Feature Rollback
PartsApi get_parts_wmv Get /api/parts/d/{did}/{wvm}/{wvmid} Get list of parts
PartsApi get_parts_wmve Get /api/parts/d/{did}/{wvm}/{wvmid}/e/{eid} Get parts from an element.
PartsApi update_parts_wmv Post /api/parts/d/{did}/{wvm}/{wvmid} Part metadata batch update.
TranslationsApi create_translation Post /api/translations/d/{did}/w/{wid}
TranslationsApi delete_translation Delete /api/translations/{tid}
TranslationsApi get_document_translations Get /api/translations/d/{did}
TranslationsApi get_translation Get /api/translations/{tid}
TranslationsApi get_translator_formats5 Get /api/translations/translationformats

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

[email protected]