Web Services

{@ The Tripal Web Services API provides a set of functions for interacting with the Tripal Web Services.

Parent topics

Tripal API
Tripal provides an application programming interface (API) to support customizations and creation of new extensions. @

File

tripal_ws/api/tripal_ws.api.inc, line 9
This file provides the Tripal Web Services API: a set of functions for interacting with the Tripal Web Services.

Functions

Namesort descending Location Description
tripal_add_site tripal_ws/api/tripal_ws.api.inc Adds a new site to the web services table.
tripal_clear_remote_cache tripal_ws/api/tripal_ws.api.inc Clears the cached remote site documentation and context.
tripal_get_remote_API_doc tripal_ws/api/tripal_ws.api.inc Retrieves the API documentation for a remote Tripal web service.
tripal_get_remote_content tripal_ws/api/tripal_ws.api.inc Makes a request to the "content" service of a remote Tripal web site.
tripal_get_remote_content_context tripal_ws/api/tripal_ws.api.inc Retrieves the JSON-LD context for a bundle or field on a remote Tripal site.
tripal_get_remote_content_doc tripal_ws/api/tripal_ws.api.inc Retreive the content type information from a remote Tripal site.
tripal_get_remote_context tripal_ws/api/tripal_ws.api.inc Retrieves the JSON-LD context for any remote Tripal web service.
tripal_get_remote_field_doc tripal_ws/api/tripal_ws.api.inc Retrieves the field information for a content type from a remote Tripal site.
tripal_get_remote_field_formatters tripal_ws/api/tripal_ws.api.inc Retrieves the list of download formatters for a remote field.
tripal_get_remote_field_info tripal_ws/api/tripal_ws.api.inc Behaves similar to the field_info_field() function but for remote fields.
tripal_get_remote_field_instance_info tripal_ws/api/tripal_ws.api.inc Behaves similar to the field_info_instance() function but for remote fields.
tripal_get_web_services tripal_ws/api/tripal_ws.api.inc Retrieves a list of TripalWebService implementations.
tripal_load_include_web_service_class tripal_ws/api/tripal_ws.api.inc Loads the TripalWebService class file into scope.
tripal_load_remote_entities tripal_ws/api/tripal_ws.api.inc Queries a remote site for an array of bulk entity ids.
tripal_load_remote_entity tripal_ws/api/tripal_ws.api.inc Queries a remote site for an entity.
tripal_remove_site tripal_ws/api/tripal_ws.api.inc Remove a site from the web services table.
_tripal_update_remote_entity_field tripal_ws/api/tripal_ws.api.inc A helper function for the tripal_get_remote_entity() function.