Package gov.nasa.pds.api.base

Interface ProductsApi

All Known Implementing Classes:

ProductsApiController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2024-09-03T18:10:48.512595446Z[GMT]")
@Validated
public interface ProductsApi

Method Summary

Modifier and Type	Method	Description
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()
default org.springframework.http.ResponseEntity<Object>	productList(@Valid List<String> fields, @Valid List<String> keywords, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products : search the latest-versioned instances of all PDS data products, including bundles, collections, documentation, context and observational products.
default org.springframework.http.ResponseEntity<Object>	productMemberOf(String identifier, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/member-of : returns one or more PDS Products that have the given PDS lid/lidvid as a member.
default org.springframework.http.ResponseEntity<Object>	productMemberOfOf(String identifier, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/member-of/member-of : returns one or more PDS Products that have the given PDS lid/lidvid as a member of its members.
default org.springframework.http.ResponseEntity<Object>	productMemberOfOfVers(String identifier, String versions, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/member-of/member-of/{versions} : returns one or more PDS Products that have the given PDS lid/lidvid as a member of its members.
default org.springframework.http.ResponseEntity<Object>	productMemberOfVers(String identifier, String versions, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/member-of/{versions} : returns one or more PDS Products that have the given PDS lid/lidvid as a member.
default org.springframework.http.ResponseEntity<Object>	productMembers(String identifier, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/members : returns all of the members of the given lid/lidvid
default org.springframework.http.ResponseEntity<Object>	productMembersMembers(String identifier, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/members/members : returns all of the members of the members of the given lid/lidvid
default org.springframework.http.ResponseEntity<Object>	productMembersMembersVers(String identifier, String versions, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/members/members/{versions} : returns all of the members of the members of the given lid/lidvid
default org.springframework.http.ResponseEntity<Object>	productMembersVers(String identifier, String versions, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/members/{versions} : returns all of the members of the given lid/lidvid
default org.springframework.http.ResponseEntity<Object>	selectByLidvid(String identifier, @Valid List<String> fields)	GET /products/{identifier} : returns one PDS Product with the identifier selected from all PDS Products, including bundles, collections, data, documentation, context and observational products.
default org.springframework.http.ResponseEntity<Object>	selectByLidvidAll(String identifier, @Valid List<String> fields, @Min(0L) @Valid Integer limit, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /products/{identifier}/all : returns all product versions with the identifier (lid) selected from all PDS Products.
default org.springframework.http.ResponseEntity<Object>	selectByLidvidLatest(String identifier, @Valid List<String> fields)	GET /products/{identifier}/latest : returns one PDS Product with the identifier selected from all PDS Products.

Method Details

getRequest

default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

productList

@RequestMapping(method=GET,
                value="/products",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productList(@Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Valid @RequestParam(value="keywords",required=false)
 @Valid List<String> keywords,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                             throws Exception

GET /products : search the latest-versioned instances of all PDS data products, including bundles, collections, documentation, context and observational products.

Parameters:

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

keywords - syntax: keyword=keyword1,keyword2,... behavior: free text search on title and description (if set q is ignored (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMemberOf

@RequestMapping(method=GET,
                value="/products/{identifier}/member-of",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMemberOf(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                 throws Exception

GET /products/{identifier}/member-of : returns one or more PDS Products that have the given PDS lid/lidvid as a member.

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMemberOfOf

@RequestMapping(method=GET,
                value="/products/{identifier}/member-of/member-of",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMemberOfOf(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                   throws Exception

GET /products/{identifier}/member-of/member-of : returns one or more PDS Products that have the given PDS lid/lidvid as a member of its members.

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMemberOfOfVers

@RequestMapping(method=GET,
                value="/products/{identifier}/member-of/member-of/{versions}",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMemberOfOfVers(@PathVariable("identifier")
 String identifier,
 @PathVariable("versions")
 String versions,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                       throws Exception

GET /products/{identifier}/member-of/member-of/{versions} : returns one or more PDS Products that have the given PDS lid/lidvid as a member of its members.

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

versions - syntax: one of the allowable enum values This is a shortcut for doing a query with ... (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMemberOfVers

@RequestMapping(method=GET,
                value="/products/{identifier}/member-of/{versions}",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMemberOfVers(@PathVariable("identifier")
 String identifier,
 @PathVariable("versions")
 String versions,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                     throws Exception

GET /products/{identifier}/member-of/{versions} : returns one or more PDS Products that have the given PDS lid/lidvid as a member.

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

versions - syntax: one of the allowable enum values This is a shortcut for doing a query with ... (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMembers

@RequestMapping(method=GET,
                value="/products/{identifier}/members",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMembers(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                throws Exception

GET /products/{identifier}/members : returns all of the members of the given lid/lidvid

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMembersMembers

@RequestMapping(method=GET,
                value="/products/{identifier}/members/members",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMembersMembers(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                       throws Exception

GET /products/{identifier}/members/members : returns all of the members of the members of the given lid/lidvid

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMembersMembersVers

@RequestMapping(method=GET,
                value="/products/{identifier}/members/members/{versions}",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMembersMembersVers(@PathVariable("identifier")
 String identifier,
 @PathVariable("versions")
 String versions,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                           throws Exception

GET /products/{identifier}/members/members/{versions} : returns all of the members of the members of the given lid/lidvid

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

versions - syntax: one of the allowable enum values This is a shortcut for doing a query with ... (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

productMembersVers

@RequestMapping(method=GET,
                value="/products/{identifier}/members/{versions}",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> productMembersVers(@PathVariable("identifier")
 String identifier,
 @PathVariable("versions")
 String versions,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                    throws Exception

GET /products/{identifier}/members/{versions} : returns all of the members of the given lid/lidvid

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

versions - syntax: one of the allowable enum values This is a shortcut for doing a query with ... (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

selectByLidvid

@RequestMapping(method=GET,
                value="/products/{identifier}",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> selectByLidvid(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields)
                                                                throws Exception

GET /products/{identifier} : returns one PDS Product with the identifier selected from all PDS Products, including bundles, collections, data, documentation, context and observational products. See identifier for details on how it determines what is returned.

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

selectByLidvidAll

@RequestMapping(method=GET,
                value="/products/{identifier}/all",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> selectByLidvidAll(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                                   throws Exception

GET /products/{identifier}/all : returns all product versions with the identifier (lid) selected from all PDS Products. See identifier for details on how it determines what is returned. note: if given a lidvid, it will be translated to a lid

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

selectByLidvidLatest

@RequestMapping(method=GET,
                value="/products/{identifier}/latest",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> selectByLidvidLatest(@PathVariable("identifier")
 String identifier,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields)
                                                                      throws Exception

GET /products/{identifier}/latest : returns one PDS Product with the identifier selected from all PDS Products. See identifier for details on how it determines what is returned.

Parameters:

identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception