| Package | Description |
|---|---|
| com.onshape.api.requests |
Request object types.
|
| com.onshape.api.types |
Types used in Onshape API client.
|
| Modifier and Type | Method | Description |
|---|---|---|
AppElementsCompareAppElementJsonResponse |
AppElementsCompareAppElementJsonRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls compareAppElementJson method, Compare App Element JSON trees in different versions / workspaces of a Document.
|
AppElementsDeleteContentResponse |
AppElementsDeleteContentRequest.Builder.call(String sid,
String did,
WVM wvmType,
String wvm,
String eid) |
Calls deleteContent method, Deletes a sub-element of an application element
|
AppElementsDownloadBlobSubelementResponse |
AppElementsDownloadBlobSubelementRequest.Builder.call(String bid,
String did,
WVM wvmType,
String wvm,
String eid) |
Calls downloadBlobSubelement method, Download a blob subelement from an app element
|
AppElementsGetBlobSubelementIdsResponse |
AppElementsGetBlobSubelementIdsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getBlobSubelementIds method, Gets a list of all BLOB sub-element IDs of a workspace/microversion/version
|
AppElementsGetHistoryByWorkspaceResponse |
AppElementsGetHistoryByWorkspaceRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getHistoryByWorkspace method, Get change history
|
AppElementsGetJsonPathsResponse |
AppElementsGetJsonPathsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getJsonPaths method, Gets the portions of a JSON tree at a workspace/microversion/version, as specified by JsonPaths
|
AppElementsGetJsonResponse |
AppElementsGetJsonRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getJson method, Gets the JSON tree at a workspace/microversion/version
|
AppElementsGetSubElementContentResponse |
AppElementsGetSubElementContentRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getSubElementContent method, Get content of sub-elements in a workspace
|
AppElementsGetSubElementIdsResponse |
AppElementsGetSubElementIdsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getSubElementIds method, Gets a list of all sub-element IDs of a workspace/microversion/version
|
AppElementsResolveReferenceResponse |
AppElementsResolveReferenceRequest.Builder.call(String rid,
String did,
WVM wvmType,
String wvm,
String eid) |
Calls resolveReference method, Resolve an app element reference.
|
AppElementsResolveReferencesResponse |
AppElementsResolveReferencesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls resolveReferences method, Resolve references for an app element
|
AssembliesGetAssemblyDefinitionResponse |
AssembliesGetAssemblyDefinitionRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getAssemblyDefinition method, Get information about an Assembly.
|
AssembliesGetBillOfMaterialsResponse |
AssembliesGetBillOfMaterialsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getBillOfMaterials method, Get content of the bill of materials in json format matching the Onshape BOM Standard for the
specified assembly
|
AssembliesGetBoundingBoxesResponse |
AssembliesGetBoundingBoxesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getBoundingBoxes method, Get the bounding box of an Assembly, or an empty object if the Assembly is empty.
|
AssembliesGetFeatureSpecsResponse |
AssembliesGetFeatureSpecsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFeatureSpecs method, Get the definition of the feature specs for an assembly
|
AssembliesGetFeaturesResponse |
AssembliesGetFeaturesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFeatures method, Get the definition of the feature list for an assembly
|
AssembliesGetShadedViewsResponse |
AssembliesGetShadedViewsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getShadedViews method, Get a shaded image rendering of an Assembly
|
BlobElementsDownloadFileFromElementResponse |
BlobElementsDownloadFileFromElementRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls downloadFileFromElement method, Download a file from a blob element
|
DocumentsGetElementListResponse |
DocumentsGetElementListRequest.Builder.call(String did,
WVM wvmType,
String wvm) |
Calls getElementList method, Get a list of elements in the workspace, version, or microversion of the document.
|
ElementsDecodeConfigurationStringResponse |
ElementsDecodeConfigurationStringRequest.Builder.call(String cid,
String did,
WVM wvmType,
String wvm,
String eid) |
Calls decodeConfigurationString method, Converts a configuration string or configuration id into parameter map form.
|
ElementsGetConfigurationResponse |
ElementsGetConfigurationRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getConfiguration method, Get the configuration definition for a part studio or an assembly.
|
FeatureStudiosGetFeatureStudioContentsResponse |
FeatureStudiosGetFeatureStudioContentsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFeatureStudioContents method, Get the text inside a Feature Studio tab
|
FeatureStudiosGetFeatureStudioSpecsResponse |
FeatureStudiosGetFeatureStudioSpecsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFeatureStudioSpecs method, Get the feature specs for a Feature Studio tab
|
MetadataGetElementMetadataResponse |
MetadataGetElementMetadataRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getElementMetadata method, Get metadata of an element in a workspace / version
|
MetadataGetElementsMetadataResponse |
MetadataGetElementsMetadataRequest.Builder.call(String did,
WVM wvmType,
String wvm) |
Calls getElementsMetadata method, Get metadata of elements in a workspace / version
|
MetadataGetPartListMetadataResponse |
MetadataGetPartListMetadataRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getPartListMetadata method, Get metadata of parts of an element in a workspace / version / microversion
|
MetadataGetPartMetadataResponse |
MetadataGetPartMetadataRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String pid,
PPI ppi) |
Calls getPartMetadata method, Get metadata of a part in an element in a workspace / version / microversion
|
PartsExportGltfResponse |
PartsExportGltfRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls exportGltf method, Export glTF representation of a part.
|
PartsExportParasolidResponse |
PartsExportParasolidRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.
|
PartsExportStlResponse |
PartsExportStlRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls exportStl method, Export the part in text or binary STL format; returns a 307 redirect.
|
PartsGetBendTableResponse |
PartsGetBendTableRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getBendTable method, Get the bend table a sheet metal part.
|
PartsGetBodyDetailsResponse |
PartsGetBodyDetailsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getBodyDetails method, Get the body details of a part.
|
PartsGetBoundingBoxesResponse |
PartsGetBoundingBoxesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getBoundingBoxes method, Get the bounding box of a part.
|
PartsGetEdgesResponse |
PartsGetEdgesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getEdges method, Get the tessellated edges of a part.
|
PartsGetFacesResponse |
PartsGetFacesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getFaces method, Get the tessellated faces of a part.
|
PartsGetMassPropertiesResponse |
PartsGetMassPropertiesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getMassProperties method, Get the mass properties of a part; parts must have density in order to have mass.
|
PartsGetPartsInPartstudioResponse |
PartsGetPartsInPartstudioRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getPartsInPartstudio method, Get list of parts in a part studio.
|
PartsGetPartsResponse |
PartsGetPartsRequest.Builder.call(String did,
WVM wvmType,
String wvm) |
Calls getParts method, Get list of parts
|
PartsGetShadedViewsResponse |
PartsGetShadedViewsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls getShadedViews method, Get a shaded image rendering of a part
|
PartStudiosComparePartStudioResponse |
PartStudiosComparePartStudioRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls comparePartStudio method, Compare Part Studio in different versions / workspaces of a Document.
|
PartStudiosEvalFeatureScriptResponse |
PartStudiosEvalFeatureScriptRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls evalFeatureScript method, Evaluate featurescript in the context of a part studio.
|
PartStudiosExportGltfResponse |
PartStudiosExportGltfRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls exportGltf method, Export glTF representation of parts in a Part Studio.
|
PartStudiosExportParasolidResponse |
PartStudiosExportParasolidRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls exportParasolid method, Export the part studio in text Parasolid format; returns a 307 redirect.
|
PartStudiosExportStlResponse |
PartStudiosExportStlRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls exportStl method, Export the part studio in text or binary STL format; returns a 307 redirect.
|
PartStudiosGetBodyDetailsResponse |
PartStudiosGetBodyDetailsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getBodyDetails method, Get the body details of a Part Studio.
|
PartStudiosGetBoundingBoxesForSketchResponse |
PartStudiosGetBoundingBoxesForSketchRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String sid) |
Calls getBoundingBoxesForSketch method, Get the bounding box of a sketch.
|
PartStudiosGetBoundingBoxesResponse |
PartStudiosGetBoundingBoxesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getBoundingBoxes method, Get the bounding box of a Part Studio, or an empty object if the Part Studio is empty.
|
PartStudiosGetEdgesResponse |
PartStudiosGetEdgesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getEdges method, Get the tessellated edges of the parts in a Part Studio.
|
PartStudiosGetFacesResponse |
PartStudiosGetFacesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFaces method, Get the tessellated faces of the parts in a Part Studio.
|
PartStudiosGetFeatureScriptTableResponse |
PartStudiosGetFeatureScriptTableRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String tableType) |
Calls getFeatureScriptTable method, Compute and return a FeatureScript table for a given part studio (and possibly part).
|
PartStudiosGetFeatureSpecsResponse |
PartStudiosGetFeatureSpecsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFeatureSpecs method, Get the definition of the feature specs for a part studio.
|
PartStudiosGetFeaturesResponse |
PartStudiosGetFeaturesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getFeatures method, Get the definition of the feature list for a part studio.
|
PartStudiosGetMassPropertiesResponse |
PartStudiosGetMassPropertiesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getMassProperties method, Get the mass properties of a part studio or parts; parts must have density in order to have mass.
|
PartStudiosGetShadedViewsResponse |
PartStudiosGetShadedViewsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getShadedViews method, Get a shaded image rendering of a Part Studio
|
PartStudiosGetSketchInfoResponse |
PartStudiosGetSketchInfoRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls getSketchInfo method, Get information for sketches in a part studio
|
PartStudiosGetTessellatedEntitiesResponse |
PartStudiosGetTessellatedEntitiesRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid,
String sid) |
Calls getTessellatedEntities method, Get the tessellations of the sketch entities of a sketch in a part studio.
|
PartStudiosIdTranslationsResponse |
PartStudiosIdTranslationsRequest.Builder.call(String did,
WVM wvmType,
String wvm,
String eid) |
Calls idTranslations method, Translate a list of part, face, etc ids defined in a specific microversion of a document to a
corresponding list of ids in the current microversion of a workspace of the document or other
specific version/microversion.
|
InputStreamWithHeaders |
AppElementsDownloadBlobSubelementRequest.Builder.callToStream(String bid,
String did,
WVM wvmType,
String wvm,
String eid) |
Calls downloadBlobSubelement method, Download a blob subelement from an app element
|
InputStreamWithHeaders |
BlobElementsDownloadFileFromElementRequest.Builder.callToStream(String did,
WVM wvmType,
String wvm,
String eid) |
Calls downloadFileFromElement method, Download a file from a blob element
|
InputStreamWithHeaders |
PartsExportParasolidRequest.Builder.callToStream(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.
|
InputStreamWithHeaders |
PartsExportStlRequest.Builder.callToStream(String did,
WVM wvmType,
String wvm,
String eid,
String partid) |
Calls exportStl method, Export the part in text or binary STL format; returns a 307 redirect.
|
InputStreamWithHeaders |
PartStudiosExportParasolidRequest.Builder.callToStream(String did,
WVM wvmType,
String wvm,
String eid) |
Calls exportParasolid method, Export the part studio in text Parasolid format; returns a 307 redirect.
|
InputStreamWithHeaders |
PartStudiosExportStlRequest.Builder.callToStream(String did,
WVM wvmType,
String wvm,
String eid) |
Calls exportStl method, Export the part studio in text or binary STL format; returns a 307 redirect.
|
| Modifier and Type | Method | Description |
|---|---|---|
WVM |
OnshapeDocument.getWVM() |
Gets the choice of WVM (Workspace, Version, Microversion)
|
static WVM |
WVM.valueOf(String name) |
Returns the enum constant of this type with the specified name.
|
static WVM[] |
WVM.values() |
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Copyright © 2021. All rights reserved.