fbpx
API Documentation
Get BOMs

Returns a list of the user added BOMs with the option to filter by project name. List of nested subproject is returned as a result.

URL format: ProductAPI/search/GetBOMs?

Inputs

Mandatory parameters

  • None.

Optional parameters

  • projectName: Filters the result with the given project name, if no project name is provided will return all BOMs under all projects.
  • bomCreationDateFrom: The start date of the BOM creation. This parameter will match all BOMs created on this date or after it.
  • bomCreationDateTo: The end date of the BOM creation. This parameter will match all BOMs created on this date or before it.
  • bomModificationDateFrom: The start date of the BOM modification. This parameter will match all BOMs modified on this date or after it.
  • bomModificationDateTo: The end date of the BOM modification. This parameter will match all BOMs modified on this date or before it.
  • fmt: Format of the response (JSON or XML) default is JSON.

Outputs

  • <span class="Kotbpmh2">Projects</span>: Wrapper of user’s projects.
  • Project: List of user’s projects.
  • ProjectName: Name of the project.
  • SubProjects: List of children projects under a parent project.
  • BOMs: List of BOMs.
  • BOMName: Name of the BOM.
  • PartsCount: Count of parts in this BOM.
  • CreationDate: BOM creation date.
  • ModificationDate: BOM modification date.

Sample requests

<a href="https://api.siliconexpert.com/ProductAPI/search/GetBOMs">https://api.siliconexpert.com/ProductAPI/search/GetBOMs</a>

 

<a href="https://api.siliconexpert.com/ProductAPI/search/GetBOMs?projectName=my-project">https://api.siliconexpert.com/ProductAPI/search/GetBOMs?projectName=my-project</a>

 

<a href="https://api.siliconexpert.com/ProductAPI/search/GetBOMs?projectName=my-project&fmt=xml">https://api.siliconexpert.com/ProductAPI/search/GetBOMs?projectName=my-project&fmt=xml</a>
There is no snippet for this language. Please select another.
Back to Main