Share

Get the status of change requests for specified items

GET /api/cr/v1/item-versions/cr-workflows gets the details of the latest change request (CR) and workflow used for a specified list of items.

Request schema

Method URL
GET /api/cr/v1/item-versions/cr-workflows

Request header

*indicates mandatory fields.

Field Value Type Description of values
*Authorization String Enter: Bearer access token.
*id Integer array The list of IDs of specific item versions. 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.
*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.

Response schema

If there are no items that meet the criteria in the request then an 200-HTTP response is returned with an empty list. Otherwise, the response returns a list of items that are specified in the id list. The CR returned is the most recent CR recorded against the item based on its creation date.

Response body

The following information about each item that meets the requirement is returned in the 200 HTTP response:

Field Value Type (max.char) Description of values
crID Integer ID of the CR.
crNumber String CR’s number as recorded in Upchain.
crStatus String Status of the CR.
crWorkflowId Integer ID of the workflow used in the CR.
crWorkflowName String Name of the workflow used in the CR.
releasedBy String Name of the person who approved the CR.
releasedDate Date Full date and time the CR was completed.

Sample response

{
    "additionalProp1": {
    "crId": "16141",
    "crNumber": "CR13013-10004",
    "crStatus": "Completed",  
    "crWorkflowId": "12345", 
    "crWorkflowName": "Quick Release",
    "releasedBy": "Mike Mech",
    "releasedDate": "2024-01-30T16:32:17.9992",
  },
    "additionalProp2": {
    "crId": "16142",
    "crNumber": "CR13013-10016",
    "crStatus": "Canceled",  
    "crWorkflowId": "12339", 
    "crWorkflowName": "Release",
    "releasedBy": "Peter Parkinson",
    "releasedDate": "2024-01-25T12:32:28.3364",
  },
  "additionalProp3": {
    "crId": "16141",
    "crNumber": "CR13013-10045",
    "crStatus": "Completed",  
    "crWorkflowId": "12345", 
    "crWorkflowName": "Quick Release",
    "releasedBy": "Mike Mech",
    "releasedDate": "2023-12-30T10:15:14.1625",
  }
}

Was this information helpful?