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

Ferrule

{
  "title": "Ferrule",
  "required": ["partNumber", "brand", "size", "lastModified", "created"],
  "properties": {
    "partNumber": {
      "type": "string"
    },
    "brand": {
      "type": "string"
    },
    "size": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "material": {
      "type": "string"
    },
    "series": {
      "type": "string"
    },
    "weightLbs": {
      "type": "number"
    },
    "spec": {
      "type": "string"
    },
    "imageName": {
      "type": "string"
    },
    "diametermm": {
      "type": "number"
    },
    "lengthmm": {
      "type": "number"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "type": "string"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "recordSource": {
      "type": "string"
    },
    "_id": {
      "type": "string"
    }
  }
}

Ferrule

Properties

Name	Type	Required	Restrictions	Description
partNumber	string	true	none	none
brand	string	true	none	none
size	string	true	none	none
description	string	false	none	none
material	string	false	none	none
series	string	false	none	none
weightLbs	number	false	none	none
spec	string	false	none	none
imageName	string	false	none	none
diametermm	number	false	none	none
lengthmm	number	false	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
createdBy	string	false	none	none
lastModifiedBy	string	false	none	none
recordSource	string	false	none	none
_id	string	false	none	none