{"_id":"588f722bbcace50f0052b9f4","parentDoc":null,"project":"565f5fa26bafd40d0030a064","user":"565f5f29de5dc50d00acfe9f","__v":0,"category":{"_id":"588f722bbcace50f0052b9e3","version":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-09T21:22:52.427Z","from_sync":false,"order":1,"slug":"user-guide","title":"Reference"},"version":{"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","__v":1,"createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-08T18:08:09.641Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Scratch Pads allow you to define and execute arbitrary code against a Remote Endpoint's Environment configuration. This will allow you to exercise connection logic on the fly without first having to define a Proxy Endpoint. You can save these and re-execute them later. These are portable and are included in API exports/imports.\n \nThe Scratch Pads view shows a list of Scratch Pads and enables you to create a new one and edit or delete an existing one.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/BP9mKFxnThKAErX6Cvbi_scratch-pad.png\",\n        \"scratch-pad.png\",\n        \"1449\",\n        \"622\",\n        \"#5e84af\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Scratch Pad Creation\n\nA Scratch Pad is pretty simple. It just requires a name and a code block. The code can be anything you want that will execute against your currently chosen Remote Endpoint.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9i2v0ih6TiW8QTWYcBCr_new-scratch-pad.png\",\n        \"new-scratch-pad.png\",\n        \"1451\",\n        \"622\",\n        \"#5484bc\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/DQITDFDSAWbORwclRB3V_scratch-pad-list.png\",\n        \"scratch-pad-list.png\",\n        \"1449\",\n        \"620\",\n        \"#5e85b1\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Scratch Pad Execution\n\nScratch Pads can be executed once created. This will exercise the code you have defined against the actual Remote Endpoint Environment configuration. The request and response params will be presented to you.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/AjCGuQRCI8kUhPhgtwC1_scratch-pad-execution.png\",\n        \"scratch-pad-execution.png\",\n        \"1450\",\n        \"1297\",\n        \"#e8e8e8\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Scratch Pad Properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"1-0\": \"**Code**\",\n    \"1-1\": \"Request code to execute against the Remote Endpoint's Environment configuration.\",\n    \"0-0\": \"**Name**\",\n    \"0-1\": \"A logical name for this code block.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"","slug":"scratch-pads","type":"basic","title":"Scratch Pads"}
Scratch Pads allow you to define and execute arbitrary code against a Remote Endpoint's Environment configuration. This will allow you to exercise connection logic on the fly without first having to define a Proxy Endpoint. You can save these and re-execute them later. These are portable and are included in API exports/imports. The Scratch Pads view shows a list of Scratch Pads and enables you to create a new one and edit or delete an existing one. [block:image] { "images": [ { "image": [ "https://files.readme.io/BP9mKFxnThKAErX6Cvbi_scratch-pad.png", "scratch-pad.png", "1449", "622", "#5e84af", "" ] } ] } [/block] ## Scratch Pad Creation A Scratch Pad is pretty simple. It just requires a name and a code block. The code can be anything you want that will execute against your currently chosen Remote Endpoint. [block:image] { "images": [ { "image": [ "https://files.readme.io/9i2v0ih6TiW8QTWYcBCr_new-scratch-pad.png", "new-scratch-pad.png", "1451", "622", "#5484bc", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/DQITDFDSAWbORwclRB3V_scratch-pad-list.png", "scratch-pad-list.png", "1449", "620", "#5e85b1", "" ] } ] } [/block] ## Scratch Pad Execution Scratch Pads can be executed once created. This will exercise the code you have defined against the actual Remote Endpoint Environment configuration. The request and response params will be presented to you. [block:image] { "images": [ { "image": [ "https://files.readme.io/AjCGuQRCI8kUhPhgtwC1_scratch-pad-execution.png", "scratch-pad-execution.png", "1450", "1297", "#e8e8e8", "" ] } ] } [/block] ## Scratch Pad Properties [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "1-0": "**Code**", "1-1": "Request code to execute against the Remote Endpoint's Environment configuration.", "0-0": "**Name**", "0-1": "A logical name for this code block." }, "cols": 2, "rows": 2 } [/block]