{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Get service information","type":"basic","slug":"get-service-information","excerpt":"","body":"This call returns information about the Workflow Execution Service on this platform.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /ga4gh/wes/v1/service-info HTTP/1.1\\nHost: cgc-ga4gh-api.sbgenomics.com\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --location --request GET 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info' \\\\\\n--header 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74'\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\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###Response body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"1-0\": \"`name`\",\n    \"2-0\": \"`type`\",\n    \"3-0\": \"`description`\",\n    \"4-0\": \"`organization`\",\n    \"5-0\": \"`documentationUrl`\",\n    \"6-0\": \"`version`\",\n    \"7-0\": \"`workflow_type_versions`\",\n    \"8-0\": \"`supported_wes_versions`\",\n    \"0-2\": \"Unique ID of this service.\",\n    \"1-2\": \"Human readable name of this service.\",\n    \"2-2\": \"Type of a GA4GH service.\\n\\n`group` - Namespace in reverse domain name format.\\n\\n`artifact` - Name of the API or GA4GH specification implemented. \\n\\n`version` - Version of the API or specification.\",\n    \"3-2\": \"Human readable description of the service.\",\n    \"4-2\": \"Organization providing the service.\\n\\n`name` - Name of the organization responsible for the service.\\n\\n`url`- URL of the website of the organization.\",\n    \"5-2\": \"URL of the documentation of this service. This documentation will help user learn how to use the service, including specifics of the implementation and information on authentication and authorization.\",\n    \"6-2\": \"Version of the service being described. The versioning system used is `<WES-version>.<SB-revision>`. The version is changed whenever the service is updated.\",\n    \"7-2\": \"Available workflow types and versions supported by this service.\",\n    \"8-2\": \"The version(s) of the WES schema supported by this service.\",\n    \"8-1\": \"Array of strings\",\n    \"7-1\": \"object\",\n    \"6-1\": \"string\",\n    \"5-1\": \"string <uri>\",\n    \"4-1\": \"object\",\n    \"3-1\": \"string\",\n    \"2-1\": \"object (ServiceType)\",\n    \"1-1\": \"string\",\n    \"0-1\": \"string\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","updates":["5f9aa2f81144c3001273009e"],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f8952a55a9841006d382e62","createdAt":"2020-10-16T07:58:29.116Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"WES API","slug":"wes-api","order":40,"from_sync":false,"reference":false,"_id":"5f894c7d3b0894006477ca01","createdAt":"2020-10-16T07:32:13.051Z","version":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"project":"55faf11ba62ba1170021a9a7","__v":1,"parentDoc":null}

GET STARTED

TUTORIALS

GUIDES

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING DATA TO THE CGC

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

BRING YOUR TOOLS

DOCKER

DESCRIBE YOUR TOOL (LEGACY)

TOOL WRAPPING TIPS AND TRICKS

EDIT AN APP (LEGACY)

ARCHIVE APPS

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

VIEW ANALYSIS RESULTS

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API CLIENTS

SB Command Line Interface

API Reference

EDIT AN APP

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

DATA STUDIO

SBFS (Beta)

SBFS Command Reference

Get service information

This call returns information about the Workflow Execution Service on this platform. [block:code] { "codes": [ { "code": "https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /ga4gh/wes/v1/service-info HTTP/1.1\nHost: cgc-ga4gh-api.sbgenomics.com", "language": "http", "name": null }, { "code": "curl --location --request GET 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info' \\\n--header 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74'", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Response body [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`id`", "1-0": "`name`", "2-0": "`type`", "3-0": "`description`", "4-0": "`organization`", "5-0": "`documentationUrl`", "6-0": "`version`", "7-0": "`workflow_type_versions`", "8-0": "`supported_wes_versions`", "0-2": "Unique ID of this service.", "1-2": "Human readable name of this service.", "2-2": "Type of a GA4GH service.\n\n`group` - Namespace in reverse domain name format.\n\n`artifact` - Name of the API or GA4GH specification implemented. \n\n`version` - Version of the API or specification.", "3-2": "Human readable description of the service.", "4-2": "Organization providing the service.\n\n`name` - Name of the organization responsible for the service.\n\n`url`- URL of the website of the organization.", "5-2": "URL of the documentation of this service. This documentation will help user learn how to use the service, including specifics of the implementation and information on authentication and authorization.", "6-2": "Version of the service being described. The versioning system used is `<WES-version>.<SB-revision>`. The version is changed whenever the service is updated.", "7-2": "Available workflow types and versions supported by this service.", "8-2": "The version(s) of the WES schema supported by this service.", "8-1": "Array of strings", "7-1": "object", "6-1": "string", "5-1": "string <uri>", "4-1": "object", "3-1": "string", "2-1": "object (ServiceType)", "1-1": "string", "0-1": "string" }, "cols": 3, "rows": 9 } [/block]