{"_id":"5b0e13ffc4664e0003c75bd1","parentDoc":null,"__v":0,"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"},"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"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T12:35:13.213Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":true,"order":56,"body":"This call returns information about the specified app revision, as raw CWL. The call differs from the call to [ `GET` a specific revision of an app](doc:get-a-specific-revision-of-an-app) by returning a JSON object that is the CWL description of the app revision. \n\nThe app should be one in a project that you can access; this could be an app that has been uploaded to the Platform by a project member, or a publicly available app that has been copied to the project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/apps/{app_id}/raw\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Recall from the [API Overview](doc:the-api#section-identifying-projects-users-apps-files-and-tasks) that the `app_id` has the form `{project_owner}\\\\{project}\\\\{app_short_name}\\\\{revision_number}`\\n\\nYou can get the `app_id` for an app by making the call to [list all apps available to you](doc:list-all-apps-available-to-you)\",\n  \"title\": \"app_ids\"\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/apps/RFranklin/my-project/bamtools-merge-2-4-0/0/raw 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  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/apps/RFranklin/my-project/bamtools-merge-2-4-0/0/raw\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\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\": \"Your [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\": \"`app_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID for the app you are querying. It can be obtained by making the call to [list all apps available to you](doc:list-all-apps-available-to-you)\",\n    \"1-0\": \"`revision number`\",\n    \"1-1\": \"The integer that is the revision number of the app\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\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 response body\nNote that this call returns the full CWL description of the app.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"successCodes\\\": [],\\n  \\\"sbg:homepage\\\": \\\"https://github.com/pezmaster31/bamtools/wiki\\\",\\n  \\\"sbg:validationErrors\\\": [],\\n  \\\"sbg:sbgMaintained\\\": false,\\n  \\\"temporaryFailCodes\\\": [],\\n  \\\"requirements\\\": [],\\n  \\\"sbg:latestRevision\\\": 0,\\n  \\\"description\\\": \\\"BamTools Merge merges multiple BAM files into a single file.\\\",\\n  \\\"sbg:job\\\": {\\n    \\\"inputs\\\": {\\n      \\\"region\\\": \\\"chr1\\\",\\n      \\\"input_bam_files\\\": [\\n        {\\n          \\\"path\\\": \\\"1.bam\\\"\\n        },\\n        {\\n          \\\"path\\\": \\\"2.bam\\\"\\n        }\\n      ]\\n    },\\n    \\\"allocatedResources\\\": {\\n      \\\"cpu\\\": 1,\\n      \\\"mem\\\": 1000\\n    }\\n  },\\n  \\\"sbg:toolAuthor\\\": \\\"Derek Barnett, Erik Garrison, Gabor Marth, and Michael Stromberg\\\",\\n  \\\"hints\\\": [\\n    {\\n      \\\"dockerImageId\\\": \\\"f808163d4cd3\\\",\\n      \\\"class\\\": \\\"DockerRequirement\\\",\\n      \\\"dockerPull\\\": \\\"images.sbgenomics.com/markop/bamtools:2.4.0\\\"\\n    },\\n    {\\n      \\\"value\\\": 1,\\n      \\\"class\\\": \\\"sbg:CPURequirement\\\"\\n    },\\n    {\\n      \\\"value\\\": 1000,\\n      \\\"class\\\": \\\"sbg:MemRequirement\\\"\\n    }\\n  ],\\n  \\\"sbg:copyOf\\\": \\\"djordje_klisic/public-apps-by-seven-bridges/bamtools-merge-2-4-0/0\\\",\\n  \\\"sbg:createdOn\\\": 1452181866,\\n  \\\"arguments\\\": [\\n    {\\n      \\\"position\\\": 1,\\n      \\\"prefix\\\": \\\"-out\\\",\\n      \\\"separate\\\": true,\\n      \\\"valueFrom\\\": \\\"merged.bam\\\"\\n    }\\n  ],\\n  \\\"outputs\\\": [\\n    {\\n      \\\"sbg:fileTypes\\\": \\\"BAM\\\",\\n      \\\"id\\\": \\\"#output_bam_file\\\",\\n      \\\"outputBinding\\\": {\\n        \\\"glob\\\": \\\"merged.bam\\\",\\n        \\\"sbg:metadata\\\": {},\\n        \\\"sbg:inheritMetadataFrom\\\": \\\"#input_bams\\\"\\n      },\\n      \\\"description\\\": \\\"Output BAM file.\\\",\\n      \\\"type\\\": [\\n        \\\"File\\\"\\n      ],\\n      \\\"label\\\": \\\"Output BAM file\\\"\\n    }\\n  ],\\n  \\\"sbg:categories\\\": [\\n    \\\"SAM/BAM-Processing\\\"\\n  ],\\n  \\\"sbg:contributors\\\": [\\n    \\\"RFranklin\\\"\\n  ],\\n  \\\"sbg:links\\\": [\\n    {\\n      \\\"id\\\": \\\"https://github.com/pezmaster31/bamtools\\\",\\n      \\\"label\\\": \\\"Homepage\\\"\\n    },\\n    {\\n      \\\"id\\\": \\\"https://github.com/pezmaster31/bamtools/wiki\\\",\\n      \\\"label\\\": \\\"Wiki\\\"\\n    }\\n  ],\\n  \\\"stdout\\\": \\\"\\\",\\n  \\\"stdin\\\": \\\"\\\",\\n  \\\"sbg:project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"inputs\\\": [\\n    {\\n      \\\"sbg:fileTypes\\\": \\\"BAM\\\",\\n      \\\"id\\\": \\\"#input_bam_files\\\",\\n      \\\"inputBinding\\\": {\\n        \\\"sbg:cmdInclude\\\": true,\\n        \\\"prefix\\\": \\\"-in\\\",\\n        \\\"separate\\\": true,\\n        \\\"itemSeparator\\\": null,\\n        \\\"position\\\": 0\\n      },\\n      \\\"description\\\": \\\"The input BAM files.\\\",\\n      \\\"label\\\": \\\"Input BAM files\\\",\\n      \\\"type\\\": [\\n        {\\n          \\\"type\\\": \\\"array\\\",\\n          \\\"items\\\": \\\"File\\\"\\n        }\\n      ],\\n      \\\"sbg:category\\\": \\\"Input & Output\\\"\\n    },\\n    {\\n      \\\"id\\\": \\\"#region\\\",\\n      \\\"inputBinding\\\": {\\n        \\\"sbg:cmdInclude\\\": true,\\n        \\\"position\\\": 2,\\n        \\\"separate\\\": true,\\n        \\\"prefix\\\": \\\"-region\\\"\\n      },\\n      \\\"description\\\": \\\"A region of interest (e.g. \\\\\\\"chr1:500..chr3:1500\\\\\\\"). See the documentation for more info.\\\",\\n      \\\"label\\\": \\\"Region of interest\\\",\\n      \\\"type\\\": [\\n        \\\"null\\\",\\n        \\\"string\\\"\\n      ],\\n      \\\"sbg:category\\\": \\\"Input & Output\\\"\\n    }\\n  ],\\n  \\\"label\\\": \\\"BamTools Merge\\\",\\n  \\\"sbg:createdBy\\\": \\\"RFranklin\\\",\\n  \\\"baseCommand\\\": [\\n    \\\"/opt/bamtools/bin/bamtools\\\",\\n    \\\"merge\\\"\\n  ],\\n  \\\"sbg:toolkitVersion\\\": \\\"2.4.0\\\",\\n  \\\"sbg:id\\\": \\\"RFranklin/my-project/bamtools-merge-2-4-0/0\\\",\\n  \\\"sbg:license\\\": \\\"The MIT License\\\",\\n  \\\"sbg:revision\\\": 0,\\n  \\\"sbg:cmdPreview\\\": \\\"/opt/bamtools/bin/bamtools merge -in 1.bam -in 2.bam -out merged.bam -region chr1\\\",\\n  \\\"sbg:modifiedOn\\\": 1452181866,\\n  \\\"id\\\": \\\"https://f4c-api.sbgenomics.com/RFranklin/my-project/bamtools-merge-2-4-0/0/raw/\\\",\\n  \\\"class\\\": \\\"CommandLineTool\\\",\\n  \\\"sbg:modifiedBy\\\": \\\"RFranklin\\\",\\n  \\\"sbg:revisionsInfo\\\": [\\n    {\\n      \\\"sbg:modifiedBy\\\": \\\"RFranklin\\\",\\n      \\\"sbg:modifiedOn\\\": 1452181866,\\n      \\\"sbg:revision\\\": 0\\n    }\\n  ],\\n  \\\"sbg:toolkit\\\": \\\"BamTools\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/apps/{app_id}/{revision_number}/raw","slug":"get-raw-cwl-for-an-app-revision","type":"endpoint","title":"Get raw CWL for an app revision"}

GET STARTED

ACCESS THE PLATFORM

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC GALLERY

PUBLIC PROJECTS

BRING YOUR PRIVATE DATA

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

BRING YOUR TOOLS

EDIT AN APP

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API Reference

FOLDERS API (Advance Access)

BULK API ACTIONS

DATA CRUNCHER

getGet raw CWL for an app revision

/apps/{app_id}/{revision_number}/raw
This call returns information about the specified app revision, as raw CWL. The call differs from the call to [ `GET` a specific revision of an app](doc:get-a-specific-revision-of-an-app) by returning a JSON object that is the CWL description of the app revision. The app should be one in a project that you can access; this could be an app that has been uploaded to the Platform by a project member, or a publicly available app that has been copied to the project. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/apps/{app_id}/raw", "language": "text", "name": "Path" } ] } [/block] [block:callout] { "type": "success", "body": "Recall from the [API Overview](doc:the-api#section-identifying-projects-users-apps-files-and-tasks) that the `app_id` has the form `{project_owner}\\{project}\\{app_short_name}\\{revision_number}`\n\nYou can get the `app_id` for an app by making the call to [list all apps available to you](doc:list-all-apps-available-to-you)", "title": "app_ids" } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/apps/RFranklin/my-project/bamtools-merge-2-4-0/0/raw HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/apps/RFranklin/my-project/bamtools-merge-2-4-0/0/raw\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`app_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID for the app you are querying. It can be obtained by making the call to [list all apps available to you](doc:list-all-apps-available-to-you)", "1-0": "`revision number`", "1-1": "The integer that is the revision number of the app" }, "cols": 2, "rows": 2 } [/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 response body Note that this call returns the full CWL description of the app. [block:code] { "codes": [ { "code": "{\n \"successCodes\": [],\n \"sbg:homepage\": \"https://github.com/pezmaster31/bamtools/wiki\",\n \"sbg:validationErrors\": [],\n \"sbg:sbgMaintained\": false,\n \"temporaryFailCodes\": [],\n \"requirements\": [],\n \"sbg:latestRevision\": 0,\n \"description\": \"BamTools Merge merges multiple BAM files into a single file.\",\n \"sbg:job\": {\n \"inputs\": {\n \"region\": \"chr1\",\n \"input_bam_files\": [\n {\n \"path\": \"1.bam\"\n },\n {\n \"path\": \"2.bam\"\n }\n ]\n },\n \"allocatedResources\": {\n \"cpu\": 1,\n \"mem\": 1000\n }\n },\n \"sbg:toolAuthor\": \"Derek Barnett, Erik Garrison, Gabor Marth, and Michael Stromberg\",\n \"hints\": [\n {\n \"dockerImageId\": \"f808163d4cd3\",\n \"class\": \"DockerRequirement\",\n \"dockerPull\": \"images.sbgenomics.com/markop/bamtools:2.4.0\"\n },\n {\n \"value\": 1,\n \"class\": \"sbg:CPURequirement\"\n },\n {\n \"value\": 1000,\n \"class\": \"sbg:MemRequirement\"\n }\n ],\n \"sbg:copyOf\": \"djordje_klisic/public-apps-by-seven-bridges/bamtools-merge-2-4-0/0\",\n \"sbg:createdOn\": 1452181866,\n \"arguments\": [\n {\n \"position\": 1,\n \"prefix\": \"-out\",\n \"separate\": true,\n \"valueFrom\": \"merged.bam\"\n }\n ],\n \"outputs\": [\n {\n \"sbg:fileTypes\": \"BAM\",\n \"id\": \"#output_bam_file\",\n \"outputBinding\": {\n \"glob\": \"merged.bam\",\n \"sbg:metadata\": {},\n \"sbg:inheritMetadataFrom\": \"#input_bams\"\n },\n \"description\": \"Output BAM file.\",\n \"type\": [\n \"File\"\n ],\n \"label\": \"Output BAM file\"\n }\n ],\n \"sbg:categories\": [\n \"SAM/BAM-Processing\"\n ],\n \"sbg:contributors\": [\n \"RFranklin\"\n ],\n \"sbg:links\": [\n {\n \"id\": \"https://github.com/pezmaster31/bamtools\",\n \"label\": \"Homepage\"\n },\n {\n \"id\": \"https://github.com/pezmaster31/bamtools/wiki\",\n \"label\": \"Wiki\"\n }\n ],\n \"stdout\": \"\",\n \"stdin\": \"\",\n \"sbg:project\": \"RFranklin/my-project\",\n \"inputs\": [\n {\n \"sbg:fileTypes\": \"BAM\",\n \"id\": \"#input_bam_files\",\n \"inputBinding\": {\n \"sbg:cmdInclude\": true,\n \"prefix\": \"-in\",\n \"separate\": true,\n \"itemSeparator\": null,\n \"position\": 0\n },\n \"description\": \"The input BAM files.\",\n \"label\": \"Input BAM files\",\n \"type\": [\n {\n \"type\": \"array\",\n \"items\": \"File\"\n }\n ],\n \"sbg:category\": \"Input & Output\"\n },\n {\n \"id\": \"#region\",\n \"inputBinding\": {\n \"sbg:cmdInclude\": true,\n \"position\": 2,\n \"separate\": true,\n \"prefix\": \"-region\"\n },\n \"description\": \"A region of interest (e.g. \\\"chr1:500..chr3:1500\\\"). See the documentation for more info.\",\n \"label\": \"Region of interest\",\n \"type\": [\n \"null\",\n \"string\"\n ],\n \"sbg:category\": \"Input & Output\"\n }\n ],\n \"label\": \"BamTools Merge\",\n \"sbg:createdBy\": \"RFranklin\",\n \"baseCommand\": [\n \"/opt/bamtools/bin/bamtools\",\n \"merge\"\n ],\n \"sbg:toolkitVersion\": \"2.4.0\",\n \"sbg:id\": \"RFranklin/my-project/bamtools-merge-2-4-0/0\",\n \"sbg:license\": \"The MIT License\",\n \"sbg:revision\": 0,\n \"sbg:cmdPreview\": \"/opt/bamtools/bin/bamtools merge -in 1.bam -in 2.bam -out merged.bam -region chr1\",\n \"sbg:modifiedOn\": 1452181866,\n \"id\": \"https://f4c-api.sbgenomics.com/RFranklin/my-project/bamtools-merge-2-4-0/0/raw/\",\n \"class\": \"CommandLineTool\",\n \"sbg:modifiedBy\": \"RFranklin\",\n \"sbg:revisionsInfo\": [\n {\n \"sbg:modifiedBy\": \"RFranklin\",\n \"sbg:modifiedOn\": 1452181866,\n \"sbg:revision\": 0\n }\n ],\n \"sbg:toolkit\": \"BamTools\"\n}", "language": "json" } ], "sidebar": true } [/block]