{"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://cavatica-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: cavatica-ga4gh-api.sbgenomics.com\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --location --request GET 'https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info' \\\\\\n--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0'\",\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":["5f9aa302961513005fad3f0b"],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f8945f3fef883006bb22a76","createdAt":"2020-10-16T07:04:19.082Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"WES API","slug":"wes-api","order":25,"from_sync":false,"reference":false,"_id":"5f893e508c9862002d0614a9","createdAt":"2020-10-16T06:31:44.321Z","version":"5773dcfc255e820e00e1cd50","project":"5773dcfc255e820e00e1cd4d","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","__v":1,"parentDoc":null}

Get service information


This call returns information about the Workflow Execution Service on this platform. [block:code] { "codes": [ { "code": "https://cavatica-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: cavatica-ga4gh-api.sbgenomics.com", "language": "http", "name": null }, { "code": "curl --location --request GET 'https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info' \\\n--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0'", "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]