prosEO Production Interface Delivery Point (PRIP) REST Services API API documentation version v1
/proseo/prip/odata/{version}
- version: required(v1)
/Products
Methods for querying the product catalogue according to ESA's Production Interface Delivery Point (PRIP) API
Query the products catalogue
get /Products
Query the products catalogue
Query Parameters
- $filter: (string)
Filter query string as defined by the ODATA specification
- $orderby: (string)
An ordering string as defined by the ODATA specification, default is ascending order
- $count: (boolean)
Flag indicating whether the number of products found shall be included with the result
- $expand: (string)
List of attributes to expand in product catalogue style
HTTP status code 200
The request was successfully completed (the result may be an empty list, though)
Body
Media type: application/json
Type: array of object
Items: CscProduct
- Id: required(string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)
Universally unique product identifier
- Name: required(string)
Data file name
- ContentType: required(string)
The MIME type of the product (typically application/octet-stream)
- ContentLength: required(integer)
Actual size in bytes of the downloadable file
- CreationDate: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Publication date and time of the data file (time at which the file becomes visible to the user) in UTC
- EvictionDate: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date when the data file will be removed from the rolling archive in UTC
- Checksums: required(array of CscChecksum)
Represents the known checksums for the product’s physical date, providing a unique value for supporting download integrity check. At least MD5 checksum is mandatory. It is noted that checksums are computed for the actual downloaded product file, i.e. the package used for dissemination
Items: CscChecksum
- Algorithm: required(string)
The checksum algorithm (e. g. MD5)
- Value: required(string)
The checksum value
- ChecksumDate: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time the checksum was computed
- Algorithm: required(string)
- ContentDate: required(object)
The sensing range period. Start and end times in UTC
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing start time in UTC
- End: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing end time in UTC
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
- ProductionType: required(one of systematic_production, on-demand:default, on-demand:non-default)
The type of production process applied
- Attributes: (array of CscAttribute)
The variable attributes of the product (as requested by the $expand option)
Items: CscAttribute
- Id: required(string)
String identifier of the attribute
- ContentType: required(string)
The MIME type of the attribute
- ContentLength: required(integer)
Actual size in bytes of the attribute
- StringValue: (string)
The attribute value, if it is a string attribute
- DateValue: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
The attribute value in UTC, if it is a string attribute
- IntegerValue: (integer)
The attribute value, if it is an integer attribute
- Id: required(string)
Example:
[
{
"@odata.context": "$metadata#Products/$entity",
"@odata.mediaContentType": "application/octet-stream",
"Id": "e872683a-ea5b-455d-bfb2-fb304cbfbacb",
"Name": "S1A_EW_OCN__2SDH_20171231T194900_20171231T194913_019951_021F8C_5392.zip",
"ContentType": "application/octet-stream",
"ContentLength": 4063869137,
"CreationDate": "2016-12-25T13:18:00.048Z",
"EvictionDate": "2016-12-28T13:18:00.048Z",
"Checksums":
[
{
"Algorithm": "MD5",
"Value": "E8A303BF3D85200514F727DB60E7DB65",
"ChecksumDate": "2016-12-28T13:18:00.048Z"
}
],
"ContentDate":
{
"Start": "2016-01-17T10:34:51.922Z",
"End": "2016-01-17T10:35:18.872Z"
},
"ProductionType": "systematic_production"
}
]
HTTP status code 400
The request sent to the server contains data which is not as expected e.g. invalid query parameters
Headers
- Warning: required(string - pattern: ^\d{3} proseo-api-prip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-prip (E4711) 'creation-date > today()' is not a valid query filter
HTTP status code 401
The requesting user is unauthorised to submit the product query
HTTP status code 404
The requested resource was not found (i. e. the URI does not exist; not synonymous to "no data found")
Headers
- Warning: required(string - pattern: ^\d{3} proseo-api-prip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-prip (E4711) 'creation-date > today()' is not a valid query filter