Corrigo: Work order schemas
1 Corrigo schema with complete fields and constraints.
← Work order operations · All schemas
Update work order — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
access | string | Optional | One of: Unknown, PTE, Appointment, CallFirst, NotApplicable Format: int32 |
acknowledgeByUtc | JSON | Optional | |
acknowledgeByUtc (anyOf 1) | string | Alternative | Format: date-time |
acknowledgeByUtc (anyOf 2) | null | Alternative | |
actionLogRecords | JSON | Optional | |
actionLogRecords (anyOf 1) | array | Alternative | |
actionLogRecords (anyOf 1)[] | JSON | Each item | |
actionLogRecords (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoActionLog. |
actionLogRecords (anyOf 1)[] (anyOf 2) | null | Alternative | |
actionLogRecords (anyOf 2) | null | Alternative | |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | A Corrigo Address2. |
address (anyOf 2) | null | Alternative | |
assignments | JSON | Optional | |
assignments (anyOf 1) | array | Alternative | |
assignments (anyOf 1)[] | JSON | Each item | |
assignments (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoAssignment. |
assignments (anyOf 1)[] (anyOf 2) | null | Alternative | |
assignments (anyOf 2) | null | Alternative | |
checkInOuts | JSON | Optional | |
checkInOuts (anyOf 1) | array | Alternative | |
checkInOuts (anyOf 1)[] | JSON | Each item | |
checkInOuts (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoOnSite. |
checkInOuts (anyOf 1)[] (anyOf 2) | null | Alternative | |
checkInOuts (anyOf 2) | null | Alternative | |
completionNote | JSON | Optional | |
completionNote (anyOf 1) | object | Alternative | A Corrigo WoNote. |
completionNote (anyOf 2) | null | Alternative | |
contactAddress | JSON | Optional | |
contactAddress (anyOf 1) | object | Alternative | A Corrigo ContactInfo. |
contactAddress (anyOf 2) | null | Alternative | |
contactName | JSON | Optional | |
contactName (anyOf 1) | string | Alternative | |
contactName (anyOf 2) | null | Alternative | |
createdDateUtc | string | Optional | Format: date-time |
currencyTypeId | Model | Optional | Expand Create rcs action — request body — body entity money Id |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | JSON | Each item | |
customFields (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo CustomField2. |
customFields (anyOf 1)[] (anyOf 2) | null | Alternative | |
customFields (anyOf 2) | null | Alternative | |
customer | JSON | Optional | |
customer (anyOf 1) | object | Alternative | A Corrigo Customer. |
customer (anyOf 2) | null | Alternative | |
documents | JSON | Optional | |
documents (anyOf 1) | array | Alternative | |
documents (anyOf 1)[] | JSON | Each item | |
documents (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Document. |
documents (anyOf 1)[] (anyOf 2) | null | Alternative | |
documents (anyOf 2) | null | Alternative | |
dtAcknowledgeBy | JSON | Optional | |
dtAcknowledgeBy (anyOf 1) | string | Alternative | Format: date-time |
dtAcknowledgeBy (anyOf 2) | null | Alternative | |
dtCreated | string | Optional | Format: date-time |
dtDue | JSON | Optional | |
dtDue (anyOf 1) | string | Alternative | Format: date-time |
dtDue (anyOf 2) | null | Alternative | |
dtOnSiteBy | JSON | Optional | |
dtOnSiteBy (anyOf 1) | string | Alternative | Format: date-time |
dtOnSiteBy (anyOf 2) | null | Alternative | |
dtScheduledStart | JSON | Optional | |
dtScheduledStart (anyOf 1) | string | Alternative | Format: date-time |
dtScheduledStart (anyOf 2) | null | Alternative | |
dtUtcOnSiteBy | JSON | Optional | |
dtUtcOnSiteBy (anyOf 1) | string | Alternative | Format: date-time |
dtUtcOnSiteBy (anyOf 2) | null | Alternative | |
dueDateUtc | JSON | Optional | |
dueDateUtc (anyOf 1) | string | Alternative | Format: date-time |
dueDateUtc (anyOf 2) | null | Alternative | |
duration | integer | Optional | Format: int32 |
employee | JSON | Optional | |
employee (anyOf 1) | object | Alternative | A Corrigo Employee. |
employee (anyOf 2) | null | Alternative | |
equipmentWorkedOn | JSON | Optional | |
equipmentWorkedOn (anyOf 1) | array | Alternative | |
equipmentWorkedOn (anyOf 1)[] | JSON | Each item | |
equipmentWorkedOn (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoEquipment. |
equipmentWorkedOn (anyOf 1)[] (anyOf 2) | null | Alternative | |
equipmentWorkedOn (anyOf 2) | null | Alternative | |
estimate | JSON | Optional | |
estimate (anyOf 1) | object | Alternative | A Corrigo WoEstimate. |
estimate (anyOf 2) | null | Alternative | |
flag | JSON | Optional | |
flag (anyOf 1) | object | Alternative | A Corrigo WoActionReasonLookup. |
flag (anyOf 2) | null | Alternative | |
flagId | integer | Optional | Format: int32 |
flags | JSON | Optional | |
flags (anyOf 1) | array | Alternative | |
flags (anyOf 1)[] | JSON | Each item | |
flags (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoFlag. |
flags (anyOf 1)[] (anyOf 2) | null | Alternative | |
flags (anyOf 2) | null | Alternative | |
inductionAndSafetyStatusID | string | Optional | One of: NotApplicable, NotRequired, Passed, PassedManual, Waiting, Started Format: int32 |
isWarranty | boolean | Optional | |
items | JSON | Optional | |
items (anyOf 1) | array | Alternative | |
items (anyOf 1)[] | JSON | Each item | |
items (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoItem. |
items (anyOf 1)[] (anyOf 2) | null | Alternative | |
items (anyOf 2) | null | Alternative | |
lastAction | JSON | Optional | |
lastAction (anyOf 1) | object | Alternative | A Corrigo WoLastAction. |
lastAction (anyOf 2) | null | Alternative | |
lastActionDate | string | Optional | Format: date-time |
lastActionDateUtc | string | Optional | Format: date-time |
mainAsset | JSON | Optional | |
mainAsset (anyOf 1) | object | Alternative | A Corrigo Location. |
mainAsset (anyOf 2) | null | Alternative | |
notes | JSON | Optional | |
notes (anyOf 1) | array | Alternative | |
notes (anyOf 1)[] | JSON | Each item | |
notes (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoNote. |
notes (anyOf 1)[] (anyOf 2) | null | Alternative | |
notes (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | |
number (anyOf 2) | null | Alternative | |
owner | JSON | Optional | |
owner (anyOf 1) | object | Alternative | A Corrigo Employee. |
owner (anyOf 2) | null | Alternative | |
poNumber | JSON | Optional | |
poNumber (anyOf 1) | string | Alternative | |
poNumber (anyOf 2) | null | Alternative | |
priority | JSON | Optional | |
priority (anyOf 1) | object | Alternative | A Corrigo WoPriority. |
priority (anyOf 2) | null | Alternative | |
procedures | JSON | Optional | |
procedures (anyOf 1) | array | Alternative | |
procedures (anyOf 1)[] | JSON | Each item | |
procedures (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoProcedure. |
procedures (anyOf 1)[] (anyOf 2) | null | Alternative | |
procedures (anyOf 2) | null | Alternative | |
quote | JSON | Optional | |
quote (anyOf 1) | object | Alternative | A Corrigo WoQuote. |
quote (anyOf 2) | null | Alternative | |
repairCode | JSON | Optional | |
repairCode (anyOf 1) | object | Alternative | A Corrigo RepairCode. |
repairCode (anyOf 2) | null | Alternative | |
requestorContact | JSON | Optional | |
requestorContact (anyOf 1) | object | Alternative | A Corrigo Contact. |
requestorContact (anyOf 2) | null | Alternative | |
scheduledStartUtc | JSON | Optional | |
scheduledStartUtc (anyOf 1) | string | Alternative | Format: date-time |
scheduledStartUtc (anyOf 2) | null | Alternative | |
score | integer | Optional | Format: int32 |
shortLocation | JSON | Optional | |
shortLocation (anyOf 1) | string | Alternative | |
shortLocation (anyOf 2) | null | Alternative | |
specialty | JSON | Optional | |
specialty (anyOf 1) | object | Alternative | A Corrigo Specialty. |
specialty (anyOf 2) | null | Alternative | |
statusId | string | Optional | One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32 |
subType | JSON | Optional | |
subType (anyOf 1) | object | Alternative | A Corrigo WorkOrderType. |
subType (anyOf 2) | null | Alternative | |
taskRefinement | JSON | Optional | |
taskRefinement (anyOf 1) | string | Alternative | |
taskRefinement (anyOf 2) | null | Alternative | |
timeZone | integer | Optional | Format: int32 |
travelTimeFrom | integer | Optional | Format: int32 |
travelTimeTo | integer | Optional | Format: int32 |
typeCategory | string | Optional | One of: Unknown, Basic, PMRM, Turn, Request Format: int32 |
vendorNte | JSON | Optional | |
vendorNte (anyOf 1) | object | Alternative | A Corrigo MoneyValue. |
vendorNte (anyOf 2) | null | Alternative | |
verifications | JSON | Optional | |
verifications (anyOf 1) | array | Alternative | |
verifications (anyOf 1)[] | JSON | Each item | |
verifications (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoVerification. |
verifications (anyOf 1)[] (anyOf 2) | null | Alternative | |
verifications (anyOf 2) | null | Alternative | |
visitServices | JSON | Optional | |
visitServices (anyOf 1) | array | Alternative | |
visitServices (anyOf 1)[] | JSON | Each item | |
visitServices (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoVisitSvc. |
visitServices (anyOf 1)[] (anyOf 2) | null | Alternative | |
visitServices (anyOf 2) | null | Alternative | |
visits | JSON | Optional | |
visits (anyOf 1) | array | Alternative | |
visits (anyOf 1)[] | JSON | Each item | |
visits (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoVisit. |
visits (anyOf 1)[] (anyOf 2) | null | Alternative | |
visits (anyOf 2) | null | Alternative | |
woSecondarySchedules | JSON | Optional | |
woSecondarySchedules (anyOf 1) | array | Alternative | |
woSecondarySchedules (anyOf 1)[] | JSON | Each item | |
woSecondarySchedules (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoSchedule. |
woSecondarySchedules (anyOf 1)[] (anyOf 2) | null | Alternative | |
woSecondarySchedules (anyOf 2) | null | Alternative | |
woVisitCfgList | JSON | Optional | |
woVisitCfgList (anyOf 1) | array | Alternative | |
woVisitCfgList (anyOf 1)[] | JSON | Each item | |
woVisitCfgList (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo WoVisitCfg. |
woVisitCfgList (anyOf 1)[] (anyOf 2) | null | Alternative | |
woVisitCfgList (anyOf 2) | null | Alternative | |
wonId | integer | Optional | Format: int32 |
workOrderCost | JSON | Optional | |
workOrderCost (anyOf 1) | object | Alternative | A Corrigo WorkOrderCost. |
workOrderCost (anyOf 2) | null | Alternative | |
workZone | JSON | Optional | |
workZone (anyOf 1) | object | Alternative | A Corrigo WorkZone. |
workZone (anyOf 2) | null | Alternative |
Referenced models: Create rcs action — request body — body entity money Id