{"_id":"55fcb724342d1e0d000b21cc","parentDoc":null,"user":"5553d33065e8260d00244199","version":{"_id":"55fc9b793c21291900e7e0d7","__v":12,"project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"56394a6a2fc5520d001a4db5","pages":[],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T23:59:38.866Z","from_sync":false,"order":20,"slug":"api-workflows","title":"API: Workflows"},"__v":3,"project":"5553d36165e8260d0024419a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T01:15:16.847Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Workflows are a list of API Calls that are called one after each other.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"meta\",\n    \"0-1\": \"See below\",\n    \"0-2\": \"Y\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"1-0\": \"access\",\n    \"1-1\": \"See below\",\n    \"1-2\": \"N\",\n    \"2-0\": \"workflow\",\n    \"2-1\": \"See below\",\n    \"2-2\": \"Y\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"meta\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"0-1\": \"Name of call for your reference\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"Yes\",\n    \"1-0\": \"description\",\n    \"1-1\": \"Description of call for your reference\",\n    \"1-2\": \"No\",\n    \"2-0\": \"tags\",\n    \"2-1\": \"List of tags for the call for your reference\",\n    \"2-2\": \"No\",\n    \"3-0\": \"owner\",\n    \"3-1\": \"ID of owner of Call\",\n    \"3-2\": \"No - readonly\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"access\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"public\",\n    \"1-0\": \"org\",\n    \"2-0\": \"stats\",\n    \"3-0\": \"org\",\n    \"3-1\": \"Can other users in your organization view the API Call and it's stats and results?\",\n    \"0-1\": \"Is the workflow shared with the APImetrics community?\",\n    \"1-1\": \"Is the workflow shared with your organization?\",\n    \"2-1\": \"Is the call's stats shared with the APImetrics community?\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"N\",\n    \"1-2\": \"N\",\n    \"2-2\": \"N\",\n    \"3-2\": \"N\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"workflow\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-0\": \"call_ids\",\n    \"0-1\": \"List of API Call IDs, in order you want them called?\",\n    \"0-2\": \"N\",\n    \"1-0\": \"stop_on_failure\",\n    \"1-1\": \"Should the workflow stop if we get an error response from one of the APIs?\",\n    \"1-2\": \"N\",\n    \"2-0\": \"handle_cookies\",\n    \"2-1\": \"Should cookies be handled and passed between API calls?\",\n    \"2-2\": \"N\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"JSON object that describes a Workflow","slug":"workflow-object","type":"basic","title":"Workflow Object"}

Workflow Object

JSON object that describes a Workflow

Workflows are a list of API Calls that are called one after each other. [block:parameters] { "data": { "0-0": "meta", "0-1": "See below", "0-2": "Y", "h-0": "Name", "h-1": "Description", "h-2": "Required?", "1-0": "access", "1-1": "See below", "1-2": "N", "2-0": "workflow", "2-1": "See below", "2-2": "Y" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "meta" } [/block] [block:parameters] { "data": { "0-0": "name", "0-1": "Name of call for your reference", "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-2": "Yes", "1-0": "description", "1-1": "Description of call for your reference", "1-2": "No", "2-0": "tags", "2-1": "List of tags for the call for your reference", "2-2": "No", "3-0": "owner", "3-1": "ID of owner of Call", "3-2": "No - readonly" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "access" } [/block] [block:parameters] { "data": { "0-0": "public", "1-0": "org", "2-0": "stats", "3-0": "org", "3-1": "Can other users in your organization view the API Call and it's stats and results?", "0-1": "Is the workflow shared with the APImetrics community?", "1-1": "Is the workflow shared with your organization?", "2-1": "Is the call's stats shared with the APImetrics community?", "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-2": "N", "1-2": "N", "2-2": "N", "3-2": "N" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "workflow" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-0": "call_ids", "0-1": "List of API Call IDs, in order you want them called?", "0-2": "N", "1-0": "stop_on_failure", "1-1": "Should the workflow stop if we get an error response from one of the APIs?", "1-2": "N", "2-0": "handle_cookies", "2-1": "Should cookies be handled and passed between API calls?", "2-2": "N" }, "cols": 3, "rows": 3 } [/block]