{"_id":"5b0e13ffc4664e0003c75c02","__v":0,"project":"5b0e13ffc4664e0003c75a66","user":"554340dfb7f4540d00fcef1d","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":["564dc441631e1e0d00f12828"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:25:07.535Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","method":"post","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":64,"body":"This call allows you to upload an app to the Platform, using its Common Workflow Language (CWL) description. The CWL is specified as a JSON object in the request body.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/apps/{owner}/{project_id}/{app_name}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\nYou can also use this call to copy the CWL description of one app to another app, in the same or a different project. For instance, you may have a project containing command-line tools that you have developed, and specified descriptions of, using the [Tool Editor](doc:the-tool-editor), and a shared project containing final versions of these.\n\nThen, you can periodically update the final version of a tool for your collaborators to use, by copying the CWL from one of the tools in development.\n\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/rfranklin/my-project/my_app HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \" curl --data-binary \\\":::at:::new-app.json\\\" -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://f4c-api.sbgenomics.com/v2/apps/Kate/my-project/new\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n#Example Request Body\nThe body of the request should be a JSON object containing a CWL description of the app. See [an example](doc:get-the-latest-version-of-an-app).\n\nThe same JSON object will be returned by the call if it is made successfully.\n\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"You [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`project_id`\",\n    \"1-0\": \"`owner`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the project you want to install the app in.\",\n    \"1-1\": \"The owner of the project you want to install the app in.\",\n    \"2-0\": \"`app`\",\n    \"2-1\": \"The name of your new app.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example body response\n\nLike GET /apps/{owner}/{project_id}/{app_name} this call returns the full app specification in CWL. This is a large JSON object. See [an example](dox:get-the-latest-version-of-an-app).","excerpt":"/apps/{owner}/{project_id}/{app_name}","slug":"install-a-new-cwl-app","type":"endpoint","title":"Install a new CWL app"}

postInstall a new CWL app

/apps/{owner}/{project_id}/{app_name}

This call allows you to upload an app to the Platform, using its Common Workflow Language (CWL) description. The CWL is specified as a JSON object in the request body. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/apps/{owner}/{project_id}/{app_name}", "language": "text", "name": "Path" } ] } [/block] You can also use this call to copy the CWL description of one app to another app, in the same or a different project. For instance, you may have a project containing command-line tools that you have developed, and specified descriptions of, using the [Tool Editor](doc:the-tool-editor), and a shared project containing final versions of these. Then, you can periodically update the final version of a tool for your collaborators to use, by copying the CWL from one of the tools in development. ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/rfranklin/my-project/my_app HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": " curl --data-binary \"@new-app.json\" -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X POST \"https://f4c-api.sbgenomics.com/v2/apps/Kate/my-project/new\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] #Example Request Body The body of the request should be a JSON object containing a CWL description of the app. See [an example](doc:get-the-latest-version-of-an-app). The same JSON object will be returned by the call if it is made successfully. ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "You [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`project_id`", "1-0": "`owner`", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the project you want to install the app in.", "1-1": "The owner of the project you want to install the app in.", "2-0": "`app`", "2-1": "The name of your new app." }, "cols": 2, "rows": 3 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example body response Like GET /apps/{owner}/{project_id}/{app_name} this call returns the full app specification in CWL. This is a large JSON object. See [an example](dox:get-the-latest-version-of-an-app).