Project

General

Profile

Task #4684

Updated by Chris Jones about 10 years ago

We need to update the Architecture Documents to add the View Service API calls. This has been prototyped in Metacat (see https://projects.ecoinformatics.org/ecoinfo/issues/5948), but the API APi needs to be formalized and reviewed. The summarized service in #3918 is:
<pre>
GET /views
[MNRead|CNRead].listViews() -> Types.ViewList

Displays a list of usable formats (themes) for rendering science metadata content,
and marks the default format. [Note: While this may be eventually a useful API call,
it is so far not prototyped, see https://projects.ecoinformatics.org/ecoinfo/issues/6029.
The returned ViewList type is undefined at the moment.]

GET /views/{format}/{pid}
[MNRead|CNRead].getView(pid, format) -> Types.OctetStream

Renders the science metadata document using the given named format string.
If the format string is not recognized, renders the science metadata using the default format.
Note that the return type of Types.OctetStream requires that the consuming client has a priori
knowledge of the format being returned (like HTML).
</pre>

Back

Add picture from clipboard (Maximum size: 14.8 MB)