Functional coverage and programmer references
CRUD Operations by Entity
Functional coverage using classic Create, Retrieve, Update, Delete model is described in the table below to indicate the appropriate endpoint and operation to use.
Base DELETE GET POSt/BASE PUT
Query Post/query
Command POST/COMMAND
Functional Objects |
API Entity |
Create |
Retrieve |
Update |
Delete/Cancel |
Work Order, Service Requests |
WorkOrder |
||||
Work Order Type |
WorkOrderType |
|
|||
Assignee, Assignment |
WOActionType.Assign |
|
|
||
Status Change |
WOActionType.Pickup |
|
|
||
Status Change |
WOActionType.Start |
|
|
||
Status Change |
WOActionType.Stop |
|
|
||
Status Change |
WOActionType.OnHold |
|
|
||
Status Change |
WOActionType.Complete |
|
|
||
Status Change |
WOActionType.Cancel |
|
|
||
Status Change |
WOActionType.Reopen |
|
|
||
Status Change |
WOActionType.CostStatus |
|
|
||
Status Change |
WOActionType.APInvStatus |
|
|
||
Status Change |
WOActionType.Verified |
|
|
||
SLA Info, Appointment |
WoOnSite |
|
|||
Priority |
WoPriority |
|
|||
Flags, Conditions |
WoFlag |
||||
Notes |
WoNote |
||||
Building, Property, Campus |
WorkZone |
||||
Photos / Documents |
Document |
||||
Lease, Occupancy |
Customer |
||||
Reservation, Occupancy |
Space |
||||
Occupant, Personal Identity |
Contact |
||||
Varies by system use |
CustomField2 |
||||
Procedures,Troubleshooting,Punch Lists |
ProcedureTemplate |
||||
Assets |
Location |
||||
Vendor Invoice |
WorkOrderCost |
|
|
Entities Don't Support Delete Operation
The following entities don't support delete operation: WorkOrder, WorkZone, MaterialTransaction, Portfolio, WoVerification, WorkOrderCost, AssetTree
Document Operation Note
When a Document is created on the live/production Corrigo instance, it creates the storage in AWS and serializes AWS reference to the Corrigo Database. When the live/production Corrigo instance is copied into the Stage instance at a later date, that reference to AWS is no longer valid. that document won't be accessible in the Stage instance. This is by design.
The work-around is simple - prepare Documents for your testing directly in the Stage instance using Corrigo back office application. This will ensure the reference to AWS is valid and you will be able to avoid this error.