ChangeOrder

Finds a change order by id.

Securitybearer
Request
query Parameters
id
required
string <uuid>

The change order id

Responses
get/api/v1/changeOrder
Request samples 
Response samples 
application/json
{
  • "changeOrderNumber": 0,
  • "subject": "string",
  • "description": "string",
  • "ownerNumber": "string",
  • "subSupplierNumber": "string",
  • "showInMobile": true,
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "roughOrderOfMagnitude": 0,
  • "costImpactEvaluation": "no",
  • "costImpactDescription": "string",
  • "scheduleImpactEvaluation": "no",
  • "scheduleImpactDescription": "string",
  • "actualCost": 0,
  • "productionQuantityChange": 0,
  • "otherDrawings": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "createdByUser": {
    },
  • "managedByUser": {
    },
  • "lastUpdatedByUser": {
    },
  • "status": {
    },
  • "linkedCostCodes": [
    ],
  • "job": {
    },
  • "createdOnDate": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "auditEventType": "created"
}
Deletes a change order by id.
Securitybearer 
Request 
query Parameters
id
required
string <uuid> 
The change order id


 
Responses 
delete/api/v1/changeOrder
Request samples 
Creates a change order.
Securitybearer 
Request 
Request Body schema: 
changeOrderNumber
required
integer <int32> 
The change order number


 
subject
required
string  [ 1 .. 100 ] characters 
The subject


 
description
string or null  <= 4000 characters 
The change order description


 
ownerNumber
string or null  <= 200 characters 
The owner Number


 
subSupplierNumber
string or null  <= 200 characters 
The sub/supplier number


 
showInMobile
boolean
Is the change order shown on mobile devices?


 
statusId
string or null <uuid> 
The StatusId


 
roughOrderOfMagnitude
number or null <double> 
The estimated ROM of how impactful this change will be


 
costImpactEvaluation
string (ChangeOrderImpactEvaluation) 
 Enum: "no" "yes" "potential"  
costImpactDescription
string or null  <= 200 characters 
The description of this change's impact on cost


 
scheduleImpactEvaluation
string (ChangeOrderImpactEvaluation) 
 Enum: "no" "yes" "potential"  
scheduleImpactDescription
string or null  <= 200 characters 
The description of this change's impact on schedule


 
actualCost
number or null <double> 
The change order actual cost


 
productionQuantityChange
number or null <double> 
The change order Production Quantity Change


 
otherDrawings
Array of strings or null
Other Drawings associated with the change order


 
jobId
required
string <uuid> 
The change order job ID


 
managedByUserId
string or null <uuid> 
The ID of the user managing change order


 
Responses 
post/api/v1/changeOrder
Request samples 
{
  • "changeOrderNumber": 0,
  • "subject": "string",
  • "description": "string",
  • "ownerNumber": "string",
  • "subSupplierNumber": "string",
  • "showInMobile": true,
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "roughOrderOfMagnitude": 0,
  • "costImpactEvaluation": "no",
  • "costImpactDescription": "string",
  • "scheduleImpactEvaluation": "no",
  • "scheduleImpactDescription": "string",
  • "actualCost": 0,
  • "productionQuantityChange": 0,
  • "otherDrawings": [
    ],
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "managedByUserId": "7788bda7-71cb-40d8-87c2-81331300baa9"
}
Response samples 
application/json
{
  • "changeOrderNumber": 0,
  • "subject": "string",
  • "description": "string",
  • "ownerNumber": "string",
  • "subSupplierNumber": "string",
  • "showInMobile": true,
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "roughOrderOfMagnitude": 0,
  • "costImpactEvaluation": "no",
  • "costImpactDescription": "string",
  • "scheduleImpactEvaluation": "no",
  • "scheduleImpactDescription": "string",
  • "actualCost": 0,
  • "productionQuantityChange": 0,
  • "otherDrawings": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "createdByUser": {
    },
  • "managedByUser": {
    },
  • "lastUpdatedByUser": {
    },
  • "status": {
    },
  • "linkedCostCodes": [
    ],
  • "job": {
    },
  • "createdOnDate": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "auditEventType": "created"
}
Updates a change order.
Securitybearer 
Request 
Request Body schema: 
changeOrderNumber
required
integer or null <int32> 
The change order number


 
description
string or null  <= 4000 characters 
The change order description


 
ownerNumber
string or null  <= 200 characters 
The owner Number


 
subSupplierNumber
string or null  <= 200 characters 
The sub/supplier number


 
showInMobile
boolean
Is the change order shown on mobile devices?


 
statusId
string or null <uuid> 
The StatusId


 
roughOrderOfMagnitude
number or null <double> 
The estimated ROM of how impactful this change will be


 
costImpactEvaluation
string (ChangeOrderImpactEvaluation) 
 Enum: "no" "yes" "potential"  
costImpactDescription
string or null  <= 200 characters 
The description of this change's impact on cost


 
scheduleImpactEvaluation
string (ChangeOrderImpactEvaluation) 
 Enum: "no" "yes" "potential"  
scheduleImpactDescription
string or null  <= 200 characters 
The description of this change's impact on schedule


 
actualCost
number or null <double> 
The change order actual cost


 
productionQuantityChange
number or null <double> 
The change order Production Quantity Change


 
otherDrawings
Array of strings or null
Other Drawings associated with the change order


 
id
required
string <uuid> 
The ID


 
subject
string or null  <= 100 characters 
The subject


 
managedByUserId
string or null <uuid> 
The ID of the user managing change order


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


patch/api/v1/changeOrder
Request samples 
{
  • "changeOrderNumber": 0,
  • "description": "string",
  • "ownerNumber": "string",
  • "subSupplierNumber": "string",
  • "showInMobile": true,
  • "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  • "roughOrderOfMagnitude": 0,
  • "costImpactEvaluation": "no",
  • "costImpactDescription": "string",
  • "scheduleImpactEvaluation": "no",
  • "scheduleImpactDescription": "string",
  • "actualCost": 0,
  • "productionQuantityChange": 0,
  • "otherDrawings": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "subject": "string",
  • "managedByUserId": "7788bda7-71cb-40d8-87c2-81331300baa9"
}
Finds all change orders by job id.
Securitybearer 
Request 
query Parameters
id
required
string <uuid> 
The job id


 
Responses 
get/api/v1/changeOrdersByJob
Request samples 
Response samples 
application/json
[
  • {
    }
]
Finds all change orders by business unit id.
Securitybearer 
Request 
query Parameters
id
required
string <uuid> 
The business unit id


 
Responses 
get/api/v1/changeOrdersByBU
Request samples 
Response samples 
application/json
[
  • {
    }
]
Finds all change orders by business unit id that have been updated since a given timestamp.
Securitybearer 
Request 
query Parameters
id
required
string <uuid> 
The business unit id


 
lastSyncTime
string <date-time> 
The last timestamp used when this data was requested


 
Responses 
get/api/v1/changeOrderChangesByBU
Request samples 
Response samples 
application/json
[
  • {
    }
]
Finds the change order incrementor data by business unit id.
Securitybearer 
Request 
query Parameters
id
required
string <uuid> 
The business unit id


 
Responses 
get/api/v1/changeOrderIncrementor
Request samples 
Response samples 
application/json
[
  • {
    }
]