GET api/v1/search/products/lidvids/metadata/files/{lidvid}/{fileType}/{outputFormat}

This API method will return the list of files that have been cataloged for a particular PDS product. It can be limited to specific desired file types (data, label, labelpds3, labelpds4, browse, ancillary, derived) or the default is to return "all" file types.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lidvid

PDS4 product lidvid (PDS4 product lid + product version id) or a PDS4 product lid (the most recent product version will be returned)

string

Default value is

fileType

[Optional field] The file type desired: all (the default), data, label, labelpds3, labelpds4, browse, ancillary, derived

string

Default value is all

outputFormat

[Optional field] Specify the desired format json or xml

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of urlEntry
NameDescriptionTypeAdditional information
url

The direct URL to a file

string

String length: inclusive between 0 and 3000

fileType

The file type

string

String length: inclusive between 0 and 50

description

The file description

string

String length: inclusive between 0 and 1000

Response Formats

application/json, text/json

Sample:
[
  {
    "url": "sample string 1",
    "fileType": "sample string 2",
    "description": "sample string 3"
  },
  {
    "url": "sample string 1",
    "fileType": "sample string 2",
    "description": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfurlEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPITest.Models">
  <urlEntry>
    <description>sample string 3</description>
    <fileType>sample string 2</fileType>
    <url>sample string 1</url>
  </urlEntry>
  <urlEntry>
    <description>sample string 3</description>
    <fileType>sample string 2</fileType>
    <url>sample string 1</url>
  </urlEntry>
</ArrayOfurlEntry>