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

ImageProperties

{
  "title": "ImageProperties",
  "required": ["_id", "imageName", "lastModified", "created"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "imageName": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "xOalPixel": {
      "type": "number"
    },
    "xOalRatio": {
      "type": "number"
    },
    "recordSource": {
      "type": "string"
    }
  }
}

ImageProperties

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
imageName	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
xOalPixel	number	false	none	none
xOalRatio	number	false	none	none
recordSource	string	false	none	none