OPUS API Guide

This guide describes the API that drives OPUS, an outer planets data search tool produced by the NASA PDS Rings Node. Any search that can be performed in OPUS can also be requested as an API call. Below are several examples. Please send us questions or comments.

Getting Data

api/data.[fmt]

get data

  • fmt: json,html,zip,csv
  • GET params: search params, limit, page

api/metadata/[ring_obs_id].[fmt]

get detail for a single observation

  • ring_obs_id: valid ring_obs_id
  • fmt: json,html,zip,csv

api/images/[size].[fmt]

get image results for a search

  • size: thumb,small,med,full
  • fmt: json,html,zip,csv
  • GET params: search params, limit, page
Example:

api/image/[size]/[ring_obs_id]

get images for a single observation

  • size: thumb,small,med,full
  • ring_obs_id: valid ring_obs_id

api/files/[ring_obs_id].[fmt]

get files for a single observation

  • ring_obs_id: valid ring_obs_id
  • fmt: json,html,zip,csv

api/files.[fmt]

get all files for a search

  • fmt: json,html,zip,csv
  • GET params: search params, limit, page
back to top

Getting Information about Data

api/meta/result_count.[fmt]

get result count for a search

  • GET Params: search params, limit, page
  • fmt: json,html,zip

api/meta/mults[param].[fmt]

returns all possible values for a given multiple choice field, given a search, and the result count for each value

  • param: param name
  • fmt : json,html,zip
  • GET params: search params, limit, offset
Example:

api/meta/range/endpoints/[param].[fmt]

get range endpoints for a field, given a search

  • param: param name
  • fmt: json,html,zip
  • GET params: search params, limit, offset

api/fields/[field].[fmt]

get information about a particular field

  • field: field name or no
  • fmt: json,html,zip
Example:

api/fields.[fmt]

get list of all fields

  • fmt: json, html, zip
Example:

api/category/[cat_name]

get all fields in a category

  • cat_name: category name

api/categories.[fmt]

list category names

  • fmt: json
back to top

User Interface Resources

back to top

Extended Examples

multiple instruments

Search accross different result sets, can search accross any missions or instruments

range query - type any (default)

returns products that intersect at least some piece of the desired range.

  • qtype-[param]: any, all, only
  • GET params: search params, limit, offset
Example:

range query - type 'all'

product contains the entire desired range (and possibly more)

  • qtype-[param]: any, all, only
  • GET params: search params, limit, offset
Example:

range query - type 'only'

No piece of the product's footprint lands outside the desired range

  • qtype-[param]: any, all, only
  • GET params: search params, limit, offset
Example:
back to top

 

Any = The image contains at least a portion of the region bounded by the given min and max.

All = The image contains the entire requested range from min to max.

Only = Everything within the image is in the requested range.