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

ItemProperties

{
  "title": "ItemProperties",
  "required": ["_id", "item", "lastModified", "created", "itemType"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "item": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "orgPartNumber": {
      "type": "string"
    },
    "available": {
      "type": "boolean"
    },
    "priority": {
      "type": "string"
    },
    "cost": {
      "type": "number"
    },
    "costCurrency": {
      "type": "string"
    },
    "unitOfMeasure": {
      "type": "string"
    },
    "listPrice": {
      "type": "number"
    },
    "listPriceCurrency": {
      "type": "string"
    },
    "listPriceUnitOfMeasure": {
      "type": "string"
    },
    "itemType": {
      "type": "string"
    },
    "crimpSpecs": {
      "type": "array",
      "required": false,
      "items": {
        "type": "object",
        "properties": {
          "couplingSeries": {
            "type": "string"
          },
          "couplingSeriesBrand": {
            "type": "string"
          },
          "ferruleBrand": {
            "type": "string"
          },
          "dieSize": {
            "type": "string"
          },
          "spacerRing": {
            "type": "string"
          },
          "insertLength": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              }
            }
          },
          "crimpDiam": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "tolerance": {
                "type": "number"
              },
              "tolerancePlus": {
                "type": "number"
              },
              "toleranceMinus": {
                "type": "number"
              }
            }
          },
          "crimpStretchPerEnd": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              }
            }
          },
          "ferrulePartNumber": {
            "type": "string"
          },
          "skiveExternal": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "tolerance": {
                "type": "number"
              }
            }
          },
          "skiveInternal": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "tolerance": {
                "type": "number"
              }
            }
          },
          "interlock": {
            "type": "boolean"
          },
          "comments": {
            "type": "string"
          },
          "verifiedBy": {
            "type": "string"
          }
        },
        "required": ["couplingSeries"]
      }
    },
    "recordSource": {
      "type": "string"
    }
  }
}

ItemProperties

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
item	string	true	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
lastModifiedBy	string	false	none	none
createdBy	string	false	none	none
orgPartNumber	string	false	none	none
available	boolean	false	none	none
priority	string	false	none	none
cost	number	false	none	none
costCurrency	string	false	none	none
unitOfMeasure	string	false	none	none
listPrice	number	false	none	none
listPriceCurrency	string	false	none	none
listPriceUnitOfMeasure	string	false	none	none
itemType	string	true	none	none
crimpSpecs	[object]	false	none	none
» couplingSeries	string	true	none	none
» couplingSeriesBrand	string	false	none	none
» ferruleBrand	string	false	none	none
» dieSize	string	false	none	none
» spacerRing	string	false	none	none
» insertLength	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
» crimpDiam	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
»» tolerance	number	false	none	none
»» tolerancePlus	number	false	none	none
»» toleranceMinus	number	false	none	none
» crimpStretchPerEnd	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
» ferrulePartNumber	string	false	none	none
» skiveExternal	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
»» tolerance	number	false	none	none
» skiveInternal	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
»» tolerance	number	false	none	none
» interlock	boolean	false	none	none
» comments	string	false	none	none
» verifiedBy	string	false	none	none
recordSource	string	false	none	none