About the callback notifications
Callback notification for the CR workflow status update
When a CR workflow’s status is updated, a notification, similar to the one posted below, is sent:
{
"ecrId": 22419,
"ecrNumber": "CR14416-10004",
"projectId": 4706,
"eventType": "ecr.status.updated",
"triggeredAt": "2022-07-22T03:16:54Z",
"triggeredBy": "chuck.knott@autodesk.com",
"statusOld": "Draft",
"statusNew": "WorkInProgress"
}
Schema: Callback notification for the CR workflow status update
Field | Value Type | Description of values |
---|---|---|
ecrId |
Integer | CR workflow’s unique ID. |
ecrNumber |
String | CR’s name as recorded in Upchain > Business Processes > Change requests (CR). |
projectId |
String | Project’s unique number. This is the project to which the CR is associated. |
eventType |
String | Type of event notification. Possible values are:
|
triggeredAt |
String | Date and time stamp at which the CR workflow was initialized. Uses the following format: YYYY-MM-DD(Time)HH:MM:SS(world standard timezone). |
triggeredBy |
String | Individual who initiated the CR workflow. |
statusOld |
String | Status of the CR before reaching the Update primitive. |
statusNew |
String | Status of the CR after clearing the Update primitive. |
Callback notification for generation of translations
When a translation is required for the primary CAD files added to Upchain, a notification, similar to the one posted below, is sent:
{
"fileVersionId": 641972,
"companyId": 68,
"finishedTime": "03:16:54Z ",
"conversionSuccessful": true,
"conversionFile": ["stl", "png", "step"],
"eventType: "CONVERSION_FINISHED",
}
Schema: Callback notification for generation of translations
Field | Value Type | Description of values |
---|---|---|
fileVersionId |
Integer | File version id of the primary CAD that was converted. |
companyId |
Integer | Company ID. |
finishedTime |
String | Time at which the translations were generated. |
conversionSuccessful |
Boolean | true if the translations were successfully generated. false if the translations were not generated. |
conversionFile |
Array | List of translation types that were generated. Expected values are STEP, STL, and PNG. |
eventType |
String | Event that triggered the notification. Expected value: CONVERSION_FINISHED. |