Skip to main content
PATCH
Update matching BOM lines

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json
isArchived
boolean
name
string
identifier
string
itemId
string<uuid>
routeDeliverableId
string<uuid> | null
orderDeliverableId
string<uuid> | null
projectId
string<uuid> | null
mode
enum<string>
Available options:
ratio,
total
scaling
enum<string>
Available options:
per_unit,
per_order
outputPerUnit
number | null
Required range: x > 0
quantity
number | null
Required range: x > 0
quantityActual
number
unitMeasureId
string<uuid> | null
poNumber
string | null
subOrderRef
string | null
source
enum<string>
Available options:
manual,
import,
route_template,
adhoc
sortOrder
number
notes
string | null
metadata
object

Response

Successful response.

values
object[]