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

Adaptor

{
  "title": "Adaptor",
  "required": ["partNumber", "brand", "shape", "lastModified", "created"],
  "properties": {
    "partNumber": {
      "type": "string"
    },
    "brand": {
      "type": "string"
    },
    "maxPressurePsi": {
      "type": "number"
    },
    "material": {
      "type": "string"
    },
    "crossReference": {
      "type": "number"
    },
    "familyCrossReference": {
      "type": "string"
    },
    "spec": {
      "type": "string"
    },
    "imageName": {
      "type": "string"
    },
    "shape": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "ends": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "style": {
            "type": "string"
          },
          "gender": {
            "type": "string"
          },
          "dashSize": {
            "type": "string"
          },
          "threadSize": {
            "type": "string"
          },
          "swivel": {
            "type": "string"
          },
          "bulkhead": {
            "type": "string"
          }
        },
        "required": []
      }
    },
    "extraFeatures": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "specMS": {
      "type": "string"
    },
    "specSAE": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "type": "string"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "recordSource": {
      "type": "string"
    },
    "_id": {
      "type": "string"
    }
  }
}

Adaptor

Properties

Name	Type	Required	Restrictions	Description
partNumber	string	true	none	none
brand	string	true	none	none
maxPressurePsi	number	false	none	none
material	string	false	none	none
crossReference	number	false	none	none
familyCrossReference	string	false	none	none
spec	string	false	none	none
imageName	string	false	none	none
shape	string	true	none	none
description	string	false	none	none
ends	[object]	false	none	none
» style	string	false	none	none
» gender	string	false	none	none
» dashSize	string	false	none	none
» threadSize	string	false	none	none
» swivel	string	false	none	none
» bulkhead	string	false	none	none
extraFeatures	[string]	false	none	none
specMS	string	false	none	none
specSAE	string	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