onshape-clients/dynamic-html/docs/operations/PartsApi.html

The meta package for creating the various Onshape clients

<div class="main-content">
  <h2><a name=""></a></h2>
  <p>This is the  API</p>

  <h2><a name="getPartsWMV"></a>getPartsWMV</h2>
  <hr>
  <p></p>
  
  <h3 class="section">URL</h3>
  <code>http://localhost/api/parts/d/{did}/{wvm}/{wvmid}</code>
  <h3 class="section">HTTP Method</h3>
  <code>GET</code>
  <h3 class="section">Response Type</h3>
  <div class="model" data-model="BTPartMetadataInfo"><a href="">List</a></div>
  <h3 class="section">Parameters</h3>
  <ul>
	  <li class="parameter">
      
      
      <span class="param-in">Path: </span>
      
      
      <span class="param-name">did</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Document ID.</p>
	  </li>
	  <li class="parameter">
      
      
      <span class="param-in">Path: </span>
      
      
      <span class="param-name">wvm</span>
      <span class="param-type">String</span>
      
      <p class="param-description">One of w or v or m corresponding to whether a workspace or version or microversion was entered.</p>
	  </li>
	  <li class="parameter">
      
      
      <span class="param-in">Path: </span>
      
      
      <span class="param-name">wvmid</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Workspace (w), Version (v) or Microversion (m) ID.</p>
	  </li>
	  <li class="parameter">
      
      <span class="param-in">Query: </span>
      
      
      
      <span class="param-name">elementId</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Element ID</p>
	  </li>
	  <li class="parameter">
      
      <span class="param-in">Query: </span>
      
      
      
      <span class="param-name">withThumbnails</span>
      <span class="param-type">Boolean</span>
      
      <p class="param-description">Whether or not to include thumbnails (not supported for microversion)</p>
	  </li>
	  <li class="parameter">
      
      <span class="param-in">Query: </span>
      
      
      
      <span class="param-name">includePropertyDefaults</span>
      <span class="param-type">Boolean</span>
      
      <p class="param-description">If true, include metadata schema property defaults in response</p>
	  </li>
	  <li class="parameter">
      
      <span class="param-in">Query: </span>
      
      
      
      <span class="param-name">linkDocumentId</span>
      <span class="param-type">String</span>
      
      <p class="param-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.</p>
	  </li>
	  <li class="parameter">
      
      <span class="param-in">Query: </span>
      
      
      
      <span class="param-name">configuration</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Configuration string.</p>
	  </li>
  </ul>
  <h2><a name="updatePartsWMV"></a>updatePartsWMV</h2>
  <hr>
  <p></p>
  
  <h3 class="section">URL</h3>
  <code>http://localhost/api/parts/d/{did}/{wvm}/{wvmid}</code>
  <h3 class="section">HTTP Method</h3>
  <code>POST</code>
  <h3 class="section">Response Type</h3>
  <div class="model" data-model=""><a href=""></a></div>
  <h3 class="section">Parameters</h3>
  <ul>
	  <li class="parameter">
      
      
      <span class="param-in">Path: </span>
      
      
      <span class="param-name">did</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Document ID.</p>
	  </li>
	  <li class="parameter">
      
      
      <span class="param-in">Path: </span>
      
      
      <span class="param-name">wvm</span>
      <span class="param-type">String</span>
      
      <p class="param-description">One of w or v or m corresponding to whether a workspace or version or microversion was entered.</p>
	  </li>
	  <li class="parameter">
      
      
      <span class="param-in">Path: </span>
      
      
      <span class="param-name">wvmid</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Workspace (w), Version (v) or Microversion (m) ID.</p>
	  </li>
	  <li class="parameter">
      
      <span class="param-in">Query: </span>
      
      
      
      <span class="param-name">editDescription</span>
      <span class="param-type">String</span>
      
      <p class="param-description">Description of the update (as appear in document history)</p>
	  </li>
	  <li class="parameter">
      
      
      
      
      <span class="param-in">Body: </span>
      <span class="param-name">body</span>
      <span class="param-type">String(string)</span>
      
      <p class="param-description"></p>
	  </li>
  </ul>
</div>