Table 2.
Endpoint | Description |
---|---|
/search.xml?q={query} | Search by keyword to retrieve relevant services, SOAP operations, service providers, users and registries. |
/services.xml | Services index. |
/services/filters.xml | Filter services based on categories, tags, countries, submitters and service providers. |
/services/{id}.xml | Details about a specific service. |
/services/{id}/monitoring.xml | Monitoring details for a specific service. |
/services/{id}/annotations.xml | Annotations on a specific service.a |
/service_providers.xml | Service providers index. |
/service_providers/{id}.xml | Details about a specific service provider. |
/users.xml | Users index. |
/users/{id}.xml | Details about a specific user (aka member). |
/users/{id}/annotations_by.xml | Annotations by a specific user.a |
/registries.xml | Registries index (lists registries from which BioCatalogue has sourced data). |
/annotations.xml | Annotations index.a |
/soap_services/{id}/operations.xml | SOAP operations on a specific SOAP service. |
/soap_operations.xml | SOAP operations index. |
/soap_operations/filters.xml | Filters that can be applied to the SOAP operations index. These include filters for tags on inputs and outputs. |
/soap_operations/{id}.xml | Details about a specific SOAP operation. |
/soap_operations/{id}/annotations.xml | Annotations on a specific SOAP operation.a |
/soap_inputs/{id}.xml | Details about a specific SOAP input. |
/soap_inputs/{id}/annotations.xml | Annotations on a specific SOAP input.a |
/soap_outputs/{id}/annotations.xml | Annotations on a specific SOAP output.a |
/rest_services/{id}.xml | Details about a specific REST service. |
/rest_services/{id}/annotations.xml | Annotations on a specific REST service.a |
/service_tests/{id}.xml | Details about a specific service test. |
/service_tests/{id}/results.xml | Monitoring test results for a specific service test. |
/test_results.xml | Monitoring test results index. |
/test_results/{id}.xml | Details about a specific monitoring test result. |
/categories.xml | Service categories index. |
/categories/{id}.xml | Details about a specific service category. |
aOutput also available in JSON format.
Parameters enclosed in braces should be replaced by the appropriate search term or identifier. For example http://www.biocatalogue.org/search.xml?q=protein returns the XML description of all services containing the keyword ‘protein’. A full list of methods, with documentation is available from http://apidocs.biocatalogue.org/.