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

Creates a Bom using raw bomline data and performs searches to convert into Cofactr Data

POST/v1/parse_raw_bom/

Request

Authorization: API Key
Add parameter in header
Authorization
Example
Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379
Body Params application/json
name
string 
Name
required
>= 1 characters<= 255 characters
version
string  | null 
Version
optional
>= 1 characters<= 255 characters
part_number
string  | null 
Part number
optional
>= 1 characters<= 255 characters
data_source
string  | null 
Data source
optional
>= 1 characters<= 255 characters
approved
boolean 
Approved
optional
Default:
false
metadata
object 
Metadata
optional
Default:
{}
raw_lines
array[object (CreateRawBomLine) {17}] 
optional
custom_id
string  | null 
Custom id
optional
>= 1 characters<= 255 characters
mpn
string  | null 
Mpn
optional
>= 1 characters<= 255 characters
alternative_mpns
array[string]
optional
manufacturer_name
string  | null 
Manufacturer name
optional
>= 1 characters<= 255 characters
quantity
integer 
Quantity
optional
Default:
0
reference_designators_string
string 
Reference designators string
optional
>= 1 characters<= 255 characters
reference_designators
array[string]
optional
description
string  | null 
Description
optional
>= 1 characters<= 255 characters
link
string  | null 
Link
optional
>= 1 characters<= 255 characters
comments
string  | null 
Comments
optional
>= 1 characters<= 255 characters
do_not_place
boolean 
Do not place
optional
Default:
false
line_number
string  | null 
Line number
optional
>= 1 characters<= 255 characters
value
string  | null 
Value
optional
>= 1 characters<= 255 characters
package
string  | null 
Package
optional
>= 1 characters<= 255 characters
mount_type
string  | null 
Mount type
optional
>= 1 characters<= 255 characters
metadata
object 
Metadata
optional
Default:
{}
is_custom_part
boolean 
optional
Default:
false
synced_from_integration
boolean 
optional
Default:
false
integration_source_name
string  | null 
optional
integration_record_id
string  | null 
optional
synced_from_integration_at
string  | null 
optional
Example
{
  "name": "string",
  "version": "string",
  "part_number": "string",
  "data_source": "string",
  "approved": false,
  "metadata": {},
  "raw_lines": [],
  "synced_from_integration": false,
  "integration_source_name": "string",
  "integration_record_id": "string",
  "synced_from_integration_at": "string"
}

Request samples

Responses

Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
id
string <uuid>
Id
read-onlyoptional
name
string  | null 
Name
optional
<= 255 characters
version
string  | null 
Version
optional
<= 255 characters
part_number
string  | null 
Part number
required
>= 1 characters<= 255 characters
approved
string 
Approved
read-onlyoptional
metadata
object  | null 
Metadata
required
org_id
string 
Org id
read-onlyoptional
data_source
string  | null 
Data source
optional

Where this record originated from. Null indicates normal Flagship operation, otherwise refers to input integration source.

<= 255 characters
lines
array[object (BomLine) {12}] 
read-onlyoptional
id
string <uuid>
Id
read-onlyoptional
bom_id
string 
Bom id
read-onlyoptional
part
object (PartCore) 
required
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
raw_lines
array[object (RawBomLine) {14}] 
read-onlyoptional
mpn
string 
Mpn
read-onlyoptional
alternative_mpns
string 
Alternative mpns
read-onlyoptional
manufacturer_name
string 
Manufacturer name
read-onlyoptional
quantity
string 
Quantity
read-onlyoptional
reference_designators_string
string 
Reference designators string
read-onlyoptional
reference_designators
string 
Reference designators
read-onlyoptional
description
string 
Description
read-onlyoptional
link
string 
Link
read-onlyoptional
comments
string 
Comments
read-onlyoptional
do_not_place
string 
Do not place
read-onlyoptional
line_number
string 
Line number
read-onlyoptional
value
string 
Value
read-onlyoptional
package
string 
Package
read-onlyoptional
mount_type
string 
Mount type
read-onlyoptional
synced_from_integration
boolean 
optional
Default:
false
synced_from_integration_at
string <date-time> | null 
optional
integration_source_name
string  | null 
optional
integration_record_id
string  | null 
optional
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "version": "string",
  "part_number": "string",
  "approved": "string",
  "metadata": {},
  "org_id": "string",
  "data_source": "string",
  "lines": [
    {
      "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": {}
    }
  ],
  "raw_lines": [
    {
      "mpn": "string",
      "alternative_mpns": "string",
      "manufacturer_name": "string",
      "quantity": "string",
      "reference_designators_string": "string",
      "reference_designators": "string",
      "description": "string",
      "link": "string",
      "comments": "string",
      "do_not_place": "string",
      "line_number": "string",
      "value": "string",
      "package": "string",
      "mount_type": "string"
    }
  ],
  "synced_from_integration": false,
  "synced_from_integration_at": "2019-08-24T14:15:22.123Z",
  "integration_source_name": "string",
  "integration_record_id": "string"
}
Last modified: a year ago