Smokeball · Schema

Smokeball Folder

LegalLaw FirmPractice ManagementMattersContactsDocumentsBillingTrust AccountingTime Tracking

Properties

Name	Type	Description
href	string
relation	string
method	string
self	object
id	string	Unique identifier of the folder
parentId	string	Unique identifier of the parent folder
name	string	Name of the folder

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/smokeball/json-schema/smokeball-folder.json",
  "title": "Smokeball Folder",
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "nullable": true
    },
    "relation": {
      "type": "string",
      "nullable": true
    },
    "method": {
      "type": "string",
      "default": "GET",
      "nullable": true
    },
    "self": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Link"
        }
      ],
      "nullable": true
    },
    "id": {
      "type": "string",
      "description": "Unique identifier of the folder",
      "nullable": true,
      "example": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"
    },
    "parentId": {
      "type": "string",
      "description": "Unique identifier of the parent folder",
      "nullable": true,
      "example": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
    },
    "name": {
      "type": "string",
      "description": "Name of the folder",
      "nullable": true,
      "example": "Property Documents"
    }
  },
  "additionalProperties": false
}