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

HoseKit

{
  "title": "HoseKit",
  "required": [
    "_id",
    "partNumber",
    "revision",
    "description",
    "customerPartNumber",
    "customerRevision",
    "customerOrgId",
    "lastModified",
    "created",
    "deleted"
  ],
  "properties": {
    "_id": {
      "type": "string"
    },
    "partNumber": {
      "type": "string"
    },
    "revision": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "hoseAssemblies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "order": {
            "type": "number"
          },
          "comments": {
            "type": "string"
          },
          "item": {
            "type": "string"
          },
          "deleted": {
            "type": "boolean"
          },
          "deletedDate": {
            "type": "string",
            "format": "date-time"
          },
          "deletedBy": {
            "type": "string"
          }
        },
        "required": ["item"]
      }
    },
    "adaptors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "order": {
            "type": "number"
          },
          "comments": {
            "type": "string"
          },
          "item": {
            "type": "string"
          },
          "deleted": {
            "type": "boolean"
          },
          "deletedDate": {
            "type": "string",
            "format": "date-time"
          },
          "deletedBy": {
            "type": "string"
          }
        },
        "required": ["item"]
      }
    },
    "otherItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "order": {
            "type": "number"
          },
          "comments": {
            "type": "string"
          },
          "item": {
            "type": "string"
          },
          "deleted": {
            "type": "boolean"
          },
          "deletedDate": {
            "type": "string",
            "format": "date-time"
          },
          "deletedBy": {
            "type": "string"
          }
        },
        "required": ["item"]
      }
    },
    "comments": {
      "type": "string"
    },
    "customerName": {
      "type": "string"
    },
    "customerPartNumber": {
      "type": "string"
    },
    "customerRevision": {
      "type": "string"
    },
    "customerOrgId": {
      "type": "string"
    },
    "customerDeleted": {
      "type": "boolean"
    },
    "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"
    }
  }
}

HoseKit

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
partNumber	string	true	none	none
revision	string	true	none	none
description	string	true	none	none
status	string	false	none	none
hoseAssemblies	[object]	false	none	none
» number	string	false	none	none
» quantity	number	false	none	none
» order	number	false	none	none
» comments	string	false	none	none
» item	string	true	none	none
» deleted	boolean	false	none	none
» deletedDate	string(date-time)	false	none	none
» deletedBy	string	false	none	none
adaptors	[object]	false	none	none
» number	string	false	none	none
» quantity	number	false	none	none
» order	number	false	none	none
» comments	string	false	none	none
» item	string	true	none	none
» deleted	boolean	false	none	none
» deletedDate	string(date-time)	false	none	none
» deletedBy	string	false	none	none
otherItems	[object]	false	none	none
» number	string	false	none	none
» quantity	number	false	none	none
» order	number	false	none	none
» comments	string	false	none	none
» item	string	true	none	none
» deleted	boolean	false	none	none
» deletedDate	string(date-time)	false	none	none
» deletedBy	string	false	none	none
comments	string	false	none	none
customerName	string	false	none	none
customerPartNumber	string	true	none	none
customerRevision	string	true	none	none
customerOrgId	string	true	none	none
customerDeleted	boolean	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