Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Service Pipelines

SERVICE PIPELINES

Table of Contents
minLevel2
maxLevel3
stylenone
classtoc-style

Some data that is not stored in the models is available from services. The services use some of the same resource ids as the models. This allows them to be connected to model queries and other services connected to the API.

API-

...

CONNECTED SERVICES

Use the service axis to send a request to a service. The right hand side of the service step is the service id, for example, service::text_search. Pass parameters to the service using the filter syntax:

...

An API service query creates a response that is very similar to a query using models and associations. This similarity includes many of the actual models in the API. The specific parameters, behavior and result schema depends on the individual service.

...

PIPES CONNECT SERVICES AND THE API MODELS

The pipe axis is used to connect a service query stage to a model query stage. While the results of services are similar to the API data format, they are not identical. Also the services provide some associated data with the results, but not with the flexibility of RMA association paths.

...