{"_id":"5536e7569f7f2d0d00b1cd5b","__v":11,"project":"55357364e02d480d0003c6d3","version":{"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z","releaseDate":"2015-04-20T23:54:53.134Z","categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5536e6bf7fe60f0d000fd1c0","__v":18,"pages":["5536e6ed9f7f2d0d00b1cd56","5536e736bbb4a70d00a53534","5536e73f9f7f2d0d00b1cd59","5536e74dbbb4a70d00a53536","5536e7569f7f2d0d00b1cd5b","5536e7609f7f2d0d00b1cd5d","5536e76b20d5ca0d0001580d","5536e78220d5ca0d0001580f","5536e797b91d030d004c3d91","5536e7a120d5ca0d00015811","5536e7b320d5ca0d00015813","5536e7bbbbb4a70d00a5353a","5536e7c99f7f2d0d00b1cd60","5536e7d29030530d0007f860","5536e7dbbbb4a70d00a5353c","5536e7e69f7f2d0d00b1cd62","5571ef581cd8283500a8b4de","55b80d6be89bbf25009f045b"],"project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-22T00:09:35.017Z","from_sync":false,"order":9,"slug":"form-fields","title":"Form Fields"},"user":"55356ede6040a20d00454508","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-22T00:12:06.262Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"The Sketch Field captures sketch data with the following properties:\n- `background` - A photo or image that represents the background of the drawing.  \n- `drawing` - An image that represents the drawing on top of the `background` image.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"Sketch 1\\\": {\\n      \\\"background\\\": null,\\n      \\\"drawing\\\": {\\n        \\\"id\\\": \\\"770486b6-39ed-4965-9766-7037416a7162\\\",\\n        \\\"link\\\": \\\"https://api.goformz.com/v2/files/770486b6-39ed-4965-9766-7037416a7162\\\"\\n      },\\n      \\\"raw\\\": \\\"{\\\\\\\"objects\\\\\\\":[ ... ]}\\\", //omitted for brevity\\n      \\\"version\\\": 2,\\n      \\\"id\\\": \\\"d61bfeeb-9db6-499d-8dec-a46c0108d3ca\\\",\\n      \\\"name\\\": \\\"Sketch 1\\\",\\n      \\\"type\\\": \\\"Sketch\\\"\\n    } \\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"NOTE:\",\n  \"body\": \"The id, name, and type are not necessary when setting or updating the Sketch Field. These properties are returned in the JSON of the request for readability.\"\n}\n[/block]\nThe `background` and `drawing` properties are `File` property types and each have the following properties:\n\n- `id` - The `id` of an image uploaded to the `Files` endpoint.\n- `link` - A downloadable `link` to that image or photo's location in storage.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"NOTE:\",\n  \"body\": \"The `link` property is read-only and will not be persisted if it is updated.\"\n}\n[/block]\nThe `background` file and the `drawing` file require uploading a `File` first and then assigning that uploaded file's `id` to that property's `id` property.  For more details see the section: \"[Uploading a file](doc:uploading-a-file)\".","excerpt":"","slug":"sketch-field","type":"basic","title":"Sketch Field"}
The Sketch Field captures sketch data with the following properties: - `background` - A photo or image that represents the background of the drawing. - `drawing` - An image that represents the drawing on top of the `background` image. [block:code] { "codes": [ { "code": "{\n \"Sketch 1\": {\n \"background\": null,\n \"drawing\": {\n \"id\": \"770486b6-39ed-4965-9766-7037416a7162\",\n \"link\": \"https://api.goformz.com/v2/files/770486b6-39ed-4965-9766-7037416a7162\"\n },\n \"raw\": \"{\\\"objects\\\":[ ... ]}\", //omitted for brevity\n \"version\": 2,\n \"id\": \"d61bfeeb-9db6-499d-8dec-a46c0108d3ca\",\n \"name\": \"Sketch 1\",\n \"type\": \"Sketch\"\n } \n}", "language": "json" } ] } [/block] [block:callout] { "type": "info", "title": "NOTE:", "body": "The id, name, and type are not necessary when setting or updating the Sketch Field. These properties are returned in the JSON of the request for readability." } [/block] The `background` and `drawing` properties are `File` property types and each have the following properties: - `id` - The `id` of an image uploaded to the `Files` endpoint. - `link` - A downloadable `link` to that image or photo's location in storage. [block:callout] { "type": "info", "title": "NOTE:", "body": "The `link` property is read-only and will not be persisted if it is updated." } [/block] The `background` file and the `drawing` file require uploading a `File` first and then assigning that uploaded file's `id` to that property's `id` property. For more details see the section: "[Uploading a file](doc:uploading-a-file)".