Share

Add items to a change request

POST /api/cr/v1/crs/{id}/items adds items to an existing change request (CR) that is in a Draft state. The following conditions apply:

  • The CR workflow has not been started ie. the CR is in a Draft state.
  • The CR and the item belong to the same project.
  • The item you want to add to the CR cannot be Obsolete.
  • The item you want to add to the CR cannot be a part of another CR in-progress.

Request schema

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

Request header

*indicates required parameters

Field Value Type Description
*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

Field Value Type Description
No field label Array Items listed by their item version ID numbers. To get an item ID number:
  1. In the Upchain web app, open the BOM section of the project.
  2. Select the item in the BOM table to open its details pane.
The item's ID number is the value shown beside previewItem= in the URL.

Response schema

Response body

A successful request returns an empty 204-HTTP response.

Was this information helpful?