HomeRecipesAPI ReferenceChangelogDiscussions
Log In
API Reference

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

POST/COMMAND

GET

PUT

POST/COMMAND

Work Order Type

WorkOrderType

POST/BASE 

GET

PUT

 

Assignee, Assignment

WOActionType.Assign

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Pickup

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Start

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Stop

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.OnHold

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Complete

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Cancel

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Reopen

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.CostStatus

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.APInvStatus

 

POST/QUERY

POST/COMMAND

 

Status Change

WOActionType.Verified

 

POST/QUERY

POST/COMMAND

 

SLA Info, Appointment

WoOnSite

POST/COMMAND

POST/QUERY

PUT

 

Priority

WoPriority

POST/COMMAND

POST/QUERY

PUT

 

Flags, Conditions

WoFlag

POST/COMMAND

POST/QUERY

PUT

POST/COMMAND

Notes

WoNote

POST/COMMAND

POST/QUERY

PUT

DELETE

Building, Property, Campus

WorkZone

POST/COMMAND

GET

PUT

POST/COMMAND

Photos / Documents

Document

POST/BASE

GET

PUT

DELETE

Lease, Occupancy

Customer

POST/BASE

GET

PUT

DELETE

Reservation, Occupancy

Space

POST/COMMAND

GET

PUT

DELETE

Occupant, Personal Identity

Contact

POST/BASE

GET

PUT

DELETE

Varies by system use

CustomField2

POST/BASE

GET

PUT

DELETE

Procedures,Troubleshooting,Punch Lists

ProcedureTemplate

POST/BASE

GET

PUT

DELETE

Assets

Location

POST/BASE

GET

PUT

DELETE

Vendor Invoice

WorkOrderCost

 

POST/QUERY

POST/COMMAND

 

Entities Don't Support Delete Operation

The following entities don't support delete operation: WorkOrder, WorkZone, MaterialTransaction, Portfolio, WoVerification, WorkOrderCost, AssetTree