Skip to main content
POST
Create a work order

Autorisations

X-API-KEY
string
header
requis
OW-KEY
string
header
requis

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Corps

application/json
title
string
requis
locationId
integer
requis
problemTypeId
integer
requis
buyerFacilityId
integer
requis
buyerCompanyId
integer
requis
createdBy
string
requis

Email of the creating contact.

id
integer | null

Present only when upserting an existing work order.

woNumber
string | null
poNumber
string | null
buyerProjectIds
integer[] | null
isPM
boolean | null
isCapex
boolean | null
isStale
boolean | null
isSupplierInitiated
boolean | null
isCustomerInitiated
boolean | null
isWarranty
boolean | null
status
string | null

Requested WorkOrderStatus name; the effective status is still resolved against company configuration. Omit to use the computed initial status.

description
string | null
assetId
integer | null
subAssetIds
integer[] | null
isAssetDown
boolean | null
areaId
integer | null
workCategoryId
integer | null
woPriorityId
integer | null
needApproval
boolean | null

Note the field name: needApproval, not needsApproval.

requiresSignature
boolean | null
approvalRequiredFrom
object[] | null
images
string[] | null
parts
integer[] | null

Part ids.

skipSupplier
boolean | null
supplierFacilityId
integer | null
supplierPrimaryContactEmail
string | null
contractorDetails
object | null
assignmentChanges
object[] | null
scheduledAt
string<date-time> | null
estimatedCompletionDate
string<date-time> | null
dueDate
string<date-time> | null
price
number | null
currencyId
string | null
terms
string | null
nte
number | null
nteInLocationCurrency
number | null
locationCurrencyId
string | null
currencyExchangeRateLocationToSupplier
number | null
currencyExchangeRateBuyerToLocation
number | null
statusChanges
object[] | null
submittedByName
string | null
hasBuyerArchived
boolean | null
hasSupplierArchived
boolean | null
buyerAttachments
object[] | null
supplierAttachments
object[] | null
fromRequestPortal
boolean | null
fromClientPortal
boolean | null
forcePendingStatusOnCreateFromPortal
boolean | null
resolutionTypeId
integer | null
plannedMaintenanceScheduleId
integer | null
taskCompletionMandatory
boolean | null
isPrivate
boolean | null
walkThroughId
integer | null
siteSurveyTaskTitleId
string | null
includeWalkthroughTaskList
boolean | null

Réponse

Success.

type
string
requis

Entity type marker, e.g. "WorkOrder".

data
object
requis

Work order. ABRIDGED: the full case class has 150+ fields (hydrated approval hierarchies, budgets, troubleshooting answers, contractor/sub-contractor details, internal workspaces, labels, stars, etc.); only the commonly used fields are listed here and additional properties may appear in responses.

status
enum<string>
requis
Options disponibles:
ok