Release Management

This page describes the APIs Onshape provides for working with revisions and part numbers.

Examples

Get the next available part number

Endpoint

POST /partnumber/nextnumbers

Query Params

{
  "cid": "{cid}",
  "did": "{did}"
}

You must provide either the company ID or the ID of a document owned by the company.

Request Body

{
  "itemPartNumbers": [
    {
      "documentId": "{did}",
      "elementId": "{eid}",
      "elementType": 0,
      "numberSchemeResourceTypeId": "8c96700620f77935a0b2cddc",
      "partId": "{partId}",
      "partNumber": "{partNumber}",
      "workspaceId": "{wid}"
    }
  ]
}

See the API Explorer for a full list for allowed values and additional parameter options.

Example

1. Call findCompany to get your company ID.
   • Use id from the response (NOT address.id or ownerId) as the cid in Step 3.
2. Call getPartsWMV or getPartsWMVE to get the part’s partNumber and partId.
3. Call updateNextNumbers:
   • cURL
   • python

   curl -X 'POST' \
     'https://{baseUrl}.onshape.com/api/v10/partnumber/nextnumbers?cid={cid}' \
     -H 'Accept: application/json;charset=UTF-8; qs=0.09' \
     -H 'Authorization: Basic {credentials}' \
     -H 'Content-Type: application/json;charset=UTF-8; qs=0.09' \
     -d '{
         "itemPartNumbers": [
           {
             "documentId": "{did}",
             "elementId": "{eid}",
             "elementType": 0,
             "numberSchemeResourceTypeId": "8c96700620f77935a0b2cddc",
             "partId": "{partId}",
             "partNumber": "{partNumber}",
             "workspaceId": "{wid}"
           }
         ]
       }'
   

   import requests 
   import json
   
   auth = (access_key, secret_key) # See Authentication guide
   headers = {
     'Accept': 'application/json;charset=UTF-8;qs=0.09',
     'Content-Type': 'application/json;charset=UTF-8; qs=0.09'
   }
   
   api_url = "https://{baseUrl}.onshape.com/api/v10/partnumber/nextnumbers"
   queryParams = {
     "cid": "{cid}"
   }
   
   body = {
     "itemPartNumbers": [
       {
         "documentId": "{did}",
         "elementId": "{eid}",
         "elementType": 0,
         "numberSchemeResourceTypeId": "8c96700620f77935a0b2cddc",
         "partId": "{partId}",
         "partNumber": "{partNumber}",
         "workspaceId": "{wid}"
       }
     ]
   }
   
   response = requests.post( api_url, 
                             params=queryParams,  
                             json=body,
                             auth=auth, 
                             headers=headers )
   print(json.dumps(response.json(), indent=4))
   

4. The next available partNumber is listed in the response. See Metadata: Update a part number for steps on updating the part with this new information.

Get latest revision info

Endpoint

GET /revisions/{cd}/{cdid}/p/{pnum}/latest

Query Params

{
  "et": 0
}

See the API Explorer for a full list for allowed values and additional parameter options.

Example

1. Call getPartsWMVE to get the part’s partNumber.
2. Call getLatestInDocumentOrCompany, using the partNumber as the pnum param.
   • cURL
   • python

   curl -X 'POST' \
     'https://{basUrl}.onshape.com/api/v10/revisions/d/{did}/p/{pnum}/latest?et=0' \
     -H 'Accept: application/json;charset=UTF-8; qs=0.09' \
     -H 'Authorization: Basic {credentials}' \
     -H 'Content-Type: application/json;charset=UTF-8; qs=0.09'  
   

   import requests 
   import json
   
   auth = (access_key, secret_key) # See Authentication guide
   headers = {
     'Accept': 'application/json;charset=UTF-8;qs=0.09',
     'Content-Type': 'application/json;charset=UTF-8; qs=0.09'
   }
   
   api_url = "https://{baseUrl}.onshape.com/api/v10/revisions/d/{did}/p/{pnum}/latest"
   queryParams = {
     "et": 0
   }
   
   response = requests.get( api_url, 
                             params=queryParams,  
                             auth=auth, 
                             headers=headers )
   print(json.dumps(response.json(), indent=4))
   

   • Note that you could also use /c/{cid} to submit a company ID instead of a document ID. Either is acceptable.
3. From the response, locate the releaseName and revision fields.

Get all revisions

The following endpoints all return revision information for the specified items:

Query Params

{
  "elementType": 0
}

See the API Explorer for a full list for allowed values and additional parameter options.

Example

1. Call findCompany to get your company ID.
   • Use id from the response (NOT address.id or ownerId) as the cid in Step 4.
2. Call getPartsWMVE to get the part’s partNumber. Use this value as the pnum param in Step 4.
3. Call getRevisionByPartNumber.
   • cURL
   • python

   curl -X 'POST' \
     'https://{basUrl}.onshape.com/api/v10/revisions/c/{cid}/partnumber/{pnum}/?elementType=0' \
     -H 'Accept: application/json;charset=UTF-8; qs=0.09' \
     -H 'Authorization: Basic {credentials}' \
     -H 'Content-Type: application/json;charset=UTF-8; qs=0.09'  
   

   import requests 
   import json
   
   auth = (access_key, secret_key) # See Authentication guide
   headers = {
     'Accept': 'application/json;charset=UTF-8;qs=0.09',
     'Content-Type': 'application/json;charset=UTF-8; qs=0.09'
   }
   
   api_url = "https://{baseUrl}.onshape.com/api/v10/revisions/c/{cid}/partnumber/{pnum}/"
   queryParams = {
     "elementType": 0
   }
   
   response = requests.get( api_url, 
                             params=queryParams,  
                             auth=auth, 
                             headers=headers )
   print(json.dumps(response.json(), indent=4))
   

4. Review the response, which includes information for each revision. Each item in the list includes the releaseName and revision fields.

Additional Resources

• API Explorer: Revision Endpoints
• API Explorer: Release Package Endpoints
• API Explorer: Part Number Endpoints
• API Guide: Using the API Explorer
• Onshape Help: Release Management