Welcome to the Onshape forum! Ask questions and join in the discussions about everything Onshape.

First time visiting? Here are some places to start:
  1. Looking for a certain topic? Check out the categories filter or use Search (upper right).
  2. Need support? Ask a question to our Community Support category.
  3. Please submit support tickets for bugs but you can request improvements in the Product Feedback category.
  4. Be respectful, on topic and if you see a problem, Flag it.

If you would like to contact our Community Manager personally, feel free to send a private message or an email.

Looking for some help with release packages in the API

Jon_Byars
Jon_Byars Member Posts: 9 ✭✭
in Community Support
I've been digging into the API to manage our CAD data and I've been fairly successful in building a client that can access assembly BOMs, read/edit metadata, export files, etc.  I've run into a roadblock with trying to generate release packages.  This section of the API does not seem well documented.  I have several questions on the POST/releasepackages/release/

wfid : is this just a string that names the release package?

changeOrderId : I'm assuming this is just some random string that I can assign to any value

What is the "id" value in the items list?

Where can I find a list of valid properties to use in the properties list?

What is the general workflow through the API?  I'd like users to be able to kick off a release candidate based on parts in an assembly through my client.  I can generate a list of valid part/drawings in the document and fill in most of the items in the request body but I have no idea how to assign people to approve, set revisions, etc. 

Does anyone have an example of a successful request body?

Tagged:

Answers

  • Andries_Koorzen
    Andries_Koorzen Member Posts: 2 PRO

    Hi Jon, not sure if you still need this, but for anyone else coming across this post:

    wfid here is the workflowId.

    You can get this using /GET https://cad.onshape.com/api/companies/{yourcompanyid}/policies

    Look for the key releaseWorkflowId

  • matthew_matte
    matthew_matte Member Posts: 4 ✭

    Hello, I think I can answer your questions.

    1. wfid = workflowId, a unique ID for your company’s configured release workflow in Onshape.
    2. changeOrderId is a string you assign to identify the release/change order internally.
    3. The "id" is the Onshape element ID of the part, assembly, drawing, or other document object you want to include in the release.
    4. Valid property IDs are defined in your release workflow configuration inside Onshape. These include custom properties you or your admin defined (e.g., reviewers, revision letters, approval flags). To get these, you can:
    • Export the release workflow JSON from the Onshape admin panel, or
    • Inspect an existing release package via API (GET /releasepackages/{rpid}) to see used properties.

    The properties must match your workflow’s schema and data types.

Categories