Cofactr Platform API
  • BOMs
    • Gets Boms that user has read access toGET
    • Creates a Bom using Cofactr DataPOST
    • Creates a Bom using raw bomline data and performs searches to convert into Cofactr DataPOST
    • Gets a BomGET
    • Upsert BOM AsyncPUT
    • Updates a BomPATCH
    • Deletes a Bom if still unapproved. Archives a bom if approved.DELETE
    • Approves an unapproved Bom.POST
    • Gets Bom Lines on a Bom.GET
    • Creates a new bomline on a Bom using Cofactr data. If a bomline with the provided part exists it will sum the quants instead of duplicating lines.POST
    • Gets a BomLineGET
    • Updates a BomLinePATCH
    • Removes a Bomline from a Bom.DELETE
    • Attempts to create a new Bomline using raw data and performs searches to convert into Cofactr Data. If a Bomline with the same part and refdes exists it will sum the quants instead of duplicating lines.POST
  • Programs
  • Account
  • Reporting
  • Email
  • Auth
  • Async Jobs
  • Stock Documents
  • Suppliers
  • Parts
  • Purchases
  • Teams
  • Custom Properties
  • Stock Lots
logoPowered by Apidog
  1. BOMs

Updates a BomLine

PATCH/v1/boms/{bom_id}/lines/{bom_line_id}/

Request

Authorization: API Key
Add parameter in header
Authorization
Example
Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379
Path Params
bom_id
string 
required
bom_line_id
string 
required
Body Params application/json
part
string 
Part
optional
>= 1 characters<= 12 characters
approved_alternative_parts
array[string]
optional
quantity
integer 
Quantity
optional
do_not_place
boolean 
Do not place
optional
ignore
boolean 
Ignore
optional
reference_designators
array[string]
optional
reference_designators_string
string 
Reference designators string
optional
>= 1 characters
notes
string  | null 
Notes
optional
>= 1 characters
metadata
object 
Metadata
optional
Example
{
  "part": "string",
  "approved_alternative_parts": [
    "string"
  ],
  "quantity": 0,
  "do_not_place": true,
  "ignore": true,
  "reference_designators": [
    "string"
  ],
  "reference_designators_string": "string",
  "notes": "string",
  "metadata": {}
}

Request samples

Responses

Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
id
string <uuid>
Id
read-onlyoptional
bom_id
string 
Bom id
read-onlyoptional
part
object (PartCore) 
required
id
string 
Id
required
>= 1 characters<= 12 characters
custom_id
string  | null 
Custom id
optional
<= 255 characters
mpn
string  | null 
Mpn
optional
<= 255 characters
alt_mpns
array[string]
optional
classification
string  | null 
Classification
optional
<= 255 characters
description
string  | null 
Description
optional
lifecycle_status
enum<string>  | enum<null> 
Lifecycle status
optional
Allowed values:
NewProductionEOLNRFNDObsolete
hero_image
string  | null 
Hero image
optional
<= 255 characters
mfg
string  | null 
Mfg
optional
<= 255 characters
package
string  | null 
Package
optional
<= 255 characters
terminations
integer  | null 
Terminations
optional
>= -2147483648<= 2147483647
termination_type
string  | null 
Termination type
optional
<= 255 characters
deprecated_by
string  | null 
Deprecated by
optional
is_customized_info
string 
Is customized info
read-onlyoptional
approved_alternative_parts
string 
Approved alternative parts
read-onlyoptional
quantity
integer 
Quantity
required
do_not_place
boolean 
Do not place
required
ignore
boolean 
Ignore
optional
reference_designators
array[string | null]
required
reference_designators_string
string 
Reference designators string
read-onlyoptional
notes
string  | null 
Notes
required
>= 1 characters
metadata
object  | null 
Metadata
required
raw
object  | null 
Raw
optional
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "bom_id": "string",
  "part": {
    "id": "string",
    "custom_id": "string",
    "mpn": "string",
    "alt_mpns": [
      "string"
    ],
    "classification": "string",
    "description": "string",
    "lifecycle_status": "New",
    "hero_image": "string",
    "mfg": "string",
    "package": "string",
    "terminations": -2147483648,
    "termination_type": "string",
    "deprecated_by": "string",
    "is_customized_info": "string"
  },
  "approved_alternative_parts": "string",
  "quantity": 0,
  "do_not_place": true,
  "ignore": true,
  "reference_designators": [
    "string"
  ],
  "reference_designators_string": "string",
  "notes": "string",
  "metadata": {},
  "raw": {}
}
Last modified: a year ago