/hoseassembly/{hoseAssemblyId}/getBillOfMaterials v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://goldleaf.app/api/v1

Hose Assembly

postHoseAssemblyIdGetBillOfMaterial

Code samples

const inputBody = '{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "The file format for the BOM output (e.g., 'pdf', 'xlsx')."
    }
  },
  "required": [
    "format"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://goldleaf.app/api/v1/hoseassembly/{hoseAssemblyId}/getBillOfMaterials',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /hoseassembly/{hoseAssemblyId}/getBillOfMaterials

Generate bill of materials (BOM) for a hose assembly

Generates a bill of materials file in the specified format (e.g., PDF, Excel) for the hose assembly identified by hoseAssemblyId.

Body parameter

{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "The file format for the BOM output (e.g., 'pdf', 'xlsx')."
    }
  },
  "required": ["format"]
}

Parameters

Name	In	Type	Required	Description
hoseAssemblyId	path	string	true	MongoDB ObjectId of the hose assembly.
body	body	object	true	none
» format	body	string	true	The file format for the BOM output (e.g., 'pdf', 'xlsx').

Example responses

500 Response

{
  "type": "string"
}

Responses

Status	Meaning	Description	Schema
500	Internal Server Error	Server error	string