Schema Reference API 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

Schemas

HoseAssembly

{
  "title": "HoseAssembly",
  "required": ["_id", "partNumber", "revision", "hose", "length", "lastModified", "created", "deleted"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "partNumber": {
      "type": "string"
    },
    "revision": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "modelCode": {
      "type": "string"
    },
    "tag": {
      "type": "string"
    },
    "manualDescription": {
      "type": "boolean"
    },
    "WeightLbs": {
      "type": "number"
    },
    "minPressurePsi": {
      "type": "number"
    },
    "hose": {
      "type": "string"
    },
    "end1": {
      "type": "string"
    },
    "end2": {
      "type": "string"
    },
    "ferrule1": {
      "type": "string"
    },
    "ferrule2": {
      "type": "string"
    },
    "wrap": {
      "type": "string"
    },
    "extraItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "unitOfMeasure": {
            "type": "string"
          },
          "order": {
            "type": "number"
          },
          "comments": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "item": {
            "type": "string"
          },
          "itemType": {
            "type": "string"
          }
        },
        "required": ["item", "itemType"]
      }
    },
    "length": {
      "type": "number"
    },
    "definedByCutLength": {
      "type": "boolean"
    },
    "cutLengthEntered": {
      "type": "number"
    },
    "lengthUnit": {
      "type": "string"
    },
    "lengthTolerance": {
      "type": "string"
    },
    "wrapStyle": {
      "type": "object",
      "properties": {
        "wrapType": {
          "type": "string"
        },
        "colour": {
          "type": "string"
        },
        "imageName": {
          "type": "string"
        },
        "coverage": {
          "type": "object",
          "properties": {
            "coverageType": {
              "type": "string"
            },
            "imageName": {
              "type": "string"
            },
            "length": {
              "type": "number"
            },
            "length2": {
              "type": "number"
            },
            "offset": {
              "type": "number"
            }
          }
        }
      }
    },
    "orientation": {
      "type": "number"
    },
    "comments": {
      "type": "string"
    },
    "productionNotes": {
      "type": "string"
    },
    "printText": {
      "type": "string"
    },
    "vendorPartNumber": {
      "type": "string"
    },
    "customerPartNumber": {
      "type": "string"
    },
    "customerRevision": {
      "type": "string"
    },
    "customerName": {
      "type": "string"
    },
    "customerOrgId": {
      "type": "string"
    },
    "customerOrgIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "customerDeleted": {
      "type": "boolean"
    },
    "proofTest": {
      "type": "boolean"
    },
    "proofTestPressureMultiplier": {
      "type": "number"
    },
    "proofTestTimeMinutes": {
      "type": "number"
    },
    "burstTest": {
      "type": "boolean"
    },
    "burstTestPressureMultiplier": {
      "type": "number"
    },
    "burstTestTimeMinutes": {
      "type": "number"
    },
    "hoseBrand": {
      "type": "string"
    },
    "hosePartNumber": {
      "type": "string"
    },
    "end1PartNumber": {
      "type": "string"
    },
    "end2PartNumber": {
      "type": "string"
    },
    "hoseOrgPartNumber": {
      "type": "string"
    },
    "end1OrgPartNumber": {
      "type": "string"
    },
    "end2OrgPartNumber": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "deleted": {
      "type": "boolean"
    },
    "deletedDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "deletedBy": {
      "type": "string"
    }
  }
}

HoseAssembly

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
partNumber	string	true	none	none
revision	string	true	none	none
description	string	false	none	none
modelCode	string	false	none	none
tag	string	false	none	none
manualDescription	boolean	false	none	none
WeightLbs	number	false	none	none
minPressurePsi	number	false	none	none
hose	string	true	none	none
end1	string	false	none	none
end2	string	false	none	none
ferrule1	string	false	none	none
ferrule2	string	false	none	none
wrap	string	false	none	none
extraItems	[object]	false	none	none
» number	string	false	none	none
» quantity	number	false	none	none
» unitOfMeasure	string	false	none	none
» order	number	false	none	none
» comments	string	false	none	none
» location	string	false	none	none
» item	string	true	none	none
» itemType	string	true	none	none
length	number	true	none	none
definedByCutLength	boolean	false	none	none
cutLengthEntered	number	false	none	none
lengthUnit	string	false	none	none
lengthTolerance	string	false	none	none
wrapStyle	object	false	none	none
» wrapType	string	false	none	none
» colour	string	false	none	none
» imageName	string	false	none	none
» coverage	object	false	none	none
»» coverageType	string	false	none	none
»» imageName	string	false	none	none
»» length	number	false	none	none
»» length2	number	false	none	none
»» offset	number	false	none	none
orientation	number	false	none	none
comments	string	false	none	none
productionNotes	string	false	none	none
printText	string	false	none	none
vendorPartNumber	string	false	none	none
customerPartNumber	string	false	none	none
customerRevision	string	false	none	none
customerName	string	false	none	none
customerOrgId	string	false	none	none
customerOrgIds	[string]	false	none	none
customerDeleted	boolean	false	none	none
proofTest	boolean	false	none	none
proofTestPressureMultiplier	number	false	none	none
proofTestTimeMinutes	number	false	none	none
burstTest	boolean	false	none	none
burstTestPressureMultiplier	number	false	none	none
burstTestTimeMinutes	number	false	none	none
hoseBrand	string	false	none	none
hosePartNumber	string	false	none	none
end1PartNumber	string	false	none	none
end2PartNumber	string	false	none	none
hoseOrgPartNumber	string	false	none	none
end1OrgPartNumber	string	false	none	none
end2OrgPartNumber	string	false	none	none
status	string	false	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
deleted	boolean	true	none	none
deletedDate	string(date-time)	false	none	none
lastModifiedBy	string	false	none	none
createdBy	string	false	none	none
deletedBy	string	false	none	none