/s requests
  • 22 Feb 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

/s requests

  • Dark
    Light
  • PDF

Article summary

As described above, the /s API method requests metadata about the FC.

Request

It requires no JSON payload.

Response

The response to the /s request is also quite useful for encoding provenance on analysis results and other Useful Data ArtifacTs (UDATs). For UDATs to be fully reproducible, they must be calculated from the exact same data, and with the exact same server configuration (FC version, FC project repository version).

Example /s response

{
  "version": "2.88.95", // <-- FC server version
  "commit": "N/A", // <-- The git commit for fc-iris when the server was started
  "start_time": "1677024487695",
  "data_commit": "N/A", // <-- The git commit for fc-iris when the data model was created
  "data_server_version": "2.88.95", // <-- FC server version when the data model was created
  "data_version": "af894ab0-6c1c-4153-8a1d-19b9bcd326fe", // <-- Data model UUID
  "data_timestamp":"1670924298582",
  "name": "fc-iris",
  "title": "FC Iris",
  "description": "The iris flower data set",
  "asset": {
     "path": "lightbulb-line-mixed.png"
  },
  "link": "https://en.wikipedia.org/wiki/Iris_flower_data_set",
  "owner": "Tag.bio",
  "entity_name_singular": "observation",
  "entity_name_plural": "observations",
  "overview_protocol": "overview",
  "entity_count": "150"
}

Was this article helpful?

What's Next