Sign in
latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

ReleasePackage

Update the release/obsoletion candidate/item properties.

Use this endpoint to submit the release. Release candidates must first be created with the createReleasePackage endpoint.

This endpoint can perform the following actions on release or obsoletion candidates:

  • Update candidate properties
  • Update properties of items in the candidate
  • Add items to the candidate
  • Remove items from the candidate
  • Transition the package to a new state with the wfaction query param

See Onshape Help: Release Management for more information on Onshape releases, and see API Guide: Release Management for API examples.

post/releasepackages/{rpid}

Path parameters

rpidstring required

Release candidate package ID, as returned by createReleasePackage.

Query parameters

actionstring

UPDATE | ADD_ITEMS | REMOVE_ITEMS | SAVE_DRAFT

wfactionstring

Workflow action to perform on the release candidate. When using the Onshape default release or obsoletion workflows, allowed values are:

SUBMIT | CREATE_AND_RELEASE | RELEASE | REJECT | OBSOLETE | DISCARD | CREATE_AND_OBSOLETE

  • DISCARD can only be performed by the creator of the release candidate and is the only transition that can be performed even if items have errors.

  • CREATE_AND_RELEASE and CREATE_AND_OBSOLETE can only be performed by creator if the Release management settings for the company allow release without approvers. If Release management settings restrict the approver list to a subset of company users, only those users can perform transitions.

When using a custom workflow, allowed values are determined by the workflow definition. See getActiveWorkflow to get the list of active workflows and their transitions.

Response

default response