ReleasePackage

Create a new release candidate for one or more items.

This endpoint creates a release candidate with items added to it. It does <b>not</b> release the candidate. Once the release candidate is successfully created, use updateReleasePackage to update all desired item/candidate properties, and transition it to the desired release state. See API Guide: Release Management for examples.

To add items from other documents, you must select Allow adding items from other documents in your Release management settings.

post/releasepackages/release/{wfid}

Request

  • Base URL
    https://api.onshape.com/api/v17
  • URL
    https://api.onshape.com/api/v17/releasepackages/release/{wfid}
  • Auth
    OAuth 2 and HTTP basic
    Authorization code: /oauth/authorize
    Token URL: /oauth/token scopes: OAuth2Write

Path parameters

wfidstring required

Workflow ID. See getActiveWorkflow.

Query parameters

debugModeboolean

Request body

Response

default response

Changes

No recorded changes to this operation across all 12 revisions of this API.