Share

Update a change request's details

POST /api/cr/v1/crs/{id} modifies the following information for a CR in a Draft state:

  • Change the CR workflow.
  • Add or modify a description.
  • Add or modify a priority.
  • Add or modify the printzone.
  • Add or modify an item's maturity level.

Request schema

Modify only the fields that you want to update.

Method URL
POST /api/cr/v1/crs/{id}

Request header

*indicates mandatory fields.

Field Value Type Description of values
*Authorization String Enter: Bearer access token.
*id Integer CR’s unique ID number. This is not the same as the number in the CR's name. To get the CR ID:
  1. In the Upchain web app, open the Business Processes > Change Requests section of the project.
  2. Single-click the desired CR to open its detail pane.
The CR's ID number is the value shown beside preview<workflowname>= in the URL. Alternatively, you may obtain the ID when the CR is created using POST /api/cr/v1/crs.
*Upc-Selected-Company Integer Company’s ID. Use the value returned in the id field received in response to the following request: GET /api/auth/v1/companies.
X-User-Id Text Enter the email address of the user being impersonated. This value is required if you are using a two-legged token. If you are using a three-legged token, then this field is not required.

Request body

The request is only required to have fields with updates.

Field Value Type Description of values
wfDefinitionId Integer Workflow’s ID number. Use GET /api/workflow/v1/workflows and note the value for content.id.

You can only use active workflows.
description String CR's description.
priority String CR’s priority status. Expected values are:
  • Low
  • Medium
  • High
  • Critical
printZoneId Integer Print zone’s ID. Enter 0 if not applicable.
releaseMaturity String Set the items' maturity level when the CR concludes.

Sample request

{

"wfDefinitionId": 5009,
"description": "Release drone's camera assembly",
"priority": "High",
"printZoneId": 0,
"releaseMaturity": "Beta"
}

Response schema

Response body

HTTP 200 Response:

Field Value Type Description of values
id Integer CR's ID used in the request.
num String CR’s unique identifier as recorded in Upchain Web.
status String CR’s initial status is always Draft.
wfDefinitionId Integer Workflow’s ID used in the request.
description String Description provided in the request.
priority String The status provided in the request.
printZoneId Integer Print zone’s ID number provided in the request. Returns null if not applicable.
releaseMaturity String Item's maturity level provided in the request.

Sample response

{
"id": 16123,
"num": "CR11802-10004",
"status": "Draft",
"wfDefinitionId": 5009,
"description": "Release drone's camera assembly",
"priority": "High",
"printZoneId": 0,
"releaseMaturity": "string"
}

Was this information helpful?