GA4GH Search API (1.0.0)

Download OpenAPI specification:Download

GA4GH Search Team: ga4gh-discovery-search@ga4gh.org License: Apache 2.0

GA4GH Search is an API for searching biomedical data.

More information on GitHub.

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

tables

List Tables

Returns a list of Tables.

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"tables": [{"name": "string",
"description": "string",
"data_model": true,
"errors": [{"source": "string",
"title": "Internal server error",
"detail": "Internal server error"
}
]
}
],
"pagination": {"next_page_url": "http://example.com"
},
"errors": [{"source": "string",
"title": "Internal server error",
"detail": "Internal server error"
}
]
}

Get a Table

Returns the information about the Table identified by name.

Authorizations:

bearerAuth

path Parameters

table_name

required

string

Unique Table name, unique to this implementation

Responses

Response samples

200
500

Content type

application/json

{"name": "string",
"description": "string",
"data_model": true,
"errors": [{"source": "string",
"title": "Internal server error",
"detail": "Internal server error"
}
]
}

Fetch data from a Table

Optional operation that returns data from a Table

Authorizations:

bearerAuth

path Parameters

table_name

required

string

Unique Table name, unique to this implementation

Responses

Response samples

200
500

Content type

application/json

{"data_model": true,
"data": [{ }
],
"pagination": {"next_page_url": "http://example.com"
},
"errors": [{"source": "string",
"title": "Internal server error",
"detail": "Internal server error"
}
]
}

search

Perform a search on Tables

Optional operation that accepts a SearchRequest and returns a TableData

Authorizations:

bearerAuth

Request Body schema: application/json

Query to execute

query required	string Query in SQL. Supported SQL grammar, data types, and functions are described in the specification.
parameters	Array of any Positional parameters for the query in `query` property.

Responses

Request samples

Payload

Content type

application/json

{"query": "SELECT some_string, some_num FROM a_table WHERE some_string=? AND some_num=?",
"parameters": ["hello",
42
]
}

Response samples

200
400
500

Content type

application/json

{"data_model": true,
"data": [{ }
],
"pagination": {"next_page_url": "http://example.com"
},
"errors": [{"source": "string",
"title": "Internal server error",
"detail": "Internal server error"
}
]
}

service-info

Show information about the Search service

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"id": "org.ga4gh.myservice",
"name": "My project",
"type": {"group": "org.ga4gh",
"artifact": "beacon",
"version": "1.0.0"
},
"description": "This service provides...",
"organization": {"name": "My organization",
"url": "https://example.com"
},
"contactUrl": "mailto:support@example.com",
"documentationUrl": "https://docs.myservice.example.com",
"createdAt": "2019-06-04T12:58:19Z",
"updatedAt": "2019-06-04T12:58:19Z",
"environment": "test",
"version": "1.0.0"
}