Profile Configuration FAQs

[recalcitrantsupplant]

I want to pull out a few extra fields for the prez:searchResultURI, whether it be a site/sample/report/etc. How
do I do that? Do I make a profile and make the target prez:searchResultURI? Can I have a different profile for each type (i.e. site/sample/report/etc), or must it all be one, if many is allowed, how do I use them in one call?

The profile should target prez:SearchResult. This is not a real class in the data, it is a "placeholder" class prez uses in order that you can create profiles for search results, as the search results can be of many different types.
It is recommended that, as searches can return many results, for both performance and readability, a minimal set of common properties is defined in the search profiles. The default search profiles only return information like name, description, and geo location for this reason. Users can retrieve detailed information on search results in subsequent API calls.

How do I create an endpoint for /site/{siteId} that will take a profile. At the moment, we have one endpoint /site that allows
for profiles but returns all sites and another endpoint /sites/{siteId} that allows us to specify a site id, but not a profile.

The /sites endpoint is a listing endpoint, profiles classed as a prez:ListingProfile are targeted when a request comes in on a listing endpoint. The /sites/{sideId} endpoint is an object endpoint, profiles classed as a prez:ObjectProfile are targeted when a request for an object comes in on an object endpoint. A profile can be classed as both. Typically you would want a listing profile to define a minimal set of properties per listing item, to reduce the amount of data needing to be transferred. An object profile would tend to define a more "complete" set of properties that describe an object.

[bgan8]

@recalcitrantsupplant

Thank you for clarifying the prez:SearchResult query.

For the /sites/{siteId}, I understand that normally when you do a specific search on one object, you would want a detailed output. However, the devs are trying to create a fully dynamic table where it just outputs whatever the API response is. Therefore, we need an option to specify a profile, so that it only outputs this set of fields, instead of everything.