Share

Attach a file to a change request

POST /api/cr/v1/crs/{id}/files attaches a file to a CR that has not completed its workflow. When viewing the CR in Upchain, the attached file is listed in Business Processes > select the CR > Documents tab > General documents category.

Request schema

Method URLs
POST /api/cr/v1/crs/{id}/files

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
*file String In Swagger, use Choose File to attach a file to the CR.

Response schema

A successful request returns an 201-HTTP Created response.

Was this information helpful?