Get service information

This call returns information about the Workflow Execution Service on this platform.

https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info

Request

Example request

GET /ga4gh/wes/v1/service-info HTTP/1.1
Host: cavatica-ga4gh-api.sbgenomics.com
curl --location --request GET 'https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/service-info' \
--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0'

Response

See a list of response codes that may be contained in the body of the response.

Response body

NameData typeDescription
idstringUnique ID of this service.
namestringHuman readable name of this service.
typeobject (ServiceType)Type of a GA4GH service.

group - Namespace in reverse domain name format.

artifact - Name of the API or GA4GH specification implemented.

version - Version of the API or specification.
descriptionstringHuman readable description of the service.
organizationobjectOrganization providing the service.

name - Name of the organization responsible for the service.

url- URL of the website of the organization.
documentationUrlstring 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.
versionstringVersion of the service being described. The versioning system used is <WES-version>.<SB-revision>. The version is changed whenever the service is updated.
workflow_type_versionsobjectAvailable workflow types and versions supported by this service.
supported_wes_versionsArray of stringsThe version(s) of the WES schema supported by this service.