...
| LTA Client Use Case | Operation | Request | Response |
|---|---|---|---|
| Submit Product Order | POST /processes/ProductOrder/execution | Header:
Body:
| Header:
Body:
|
| Get Order Status | GET /jobs/{jobId} | Body: job-status | |
| Get Order Result | GET /jobs/{jobId}/results | Body: job-result | |
| Cancel Order | DELETE /jobs/{jobId} | Body: job-status | |
| List processes | GET /processes | Body: process-list | |
| Describe Product Order process | GET /processes/ProductOrder | Body: process-description |
Data Model Mapping from OData API to Processes API
| OData Field | Processes API Field | Description | Mapping to Processing API objects | |||
|---|---|---|---|---|---|---|
process-description |
|---|
process-execute-request |
|---|
job-status |
|---|
job-result |
|---|
process-list | |||||||
|---|---|---|---|---|---|---|---|
| Id | product_id | Product name without file extension. Shall we use the product URL instead which also contains the collection identifier? | $.inputs.product_id | $.inputs.product_id | |||
| Priority | priority | Priority of the order. It is an integer from 1-100, where 100 is the highest priority. There is always a priority associated to an order: if it is not set within the Order Request, then it is automatically set to the default priority assigned to the user. | $.inputs.priority | $.inputs.priority | |||
| OrderSize | order_size | Actual size in bytes of the data composing the Order (which would be the ProductSize unless any transformation is performed by the LTA, e.g. band extraction). Only provided if the order/job is in status "successful". | $.outputs.order_size | $.outputs.order_size | $.order_size | ||
| EvictionDate | eviction_date | Date when the Product related to the order will be removed from the Archive delivery Interface Point. Only provided if the order/job is in status "successful". | $.outputs.eviction_date | $.outputs.eviction_date | $.eviction_date | ||
| NotificationEndpoint | successUri | URI used by the LTA for product download readiness notifications, should these be required. If not provided, no notifications will be sent. | $.subscriber.successUri | ||||
| inProgressUri | URI used by the LTA for notifications to indicate updates in the progress of the order. If not provided, no notifications will be sent. | $.subscriber.inProgressUri | |||||
| failedUri | URI used by the LTA for notifications indicating that the product retrieval failed. If not provided, no notifications will be sent. | $.subscriber.failedUri | |||||
| NotificationEpUsername | TBD | ||||||
| NotificationEpPassword | TBD | ||||||
| Status | status | Current status of the job. One of: "accepted" "running" "successful" "failed" "dismissed" | $.status | ||||
| StatusMessage | message | More detailed status message | $.message | ||||
| SubmissionDate | created | Date and time at which the order was received by the LTA. Formatted as ISO8601 string. | $.created | ||||
| EstimatedDate | TBD | ||||||
| CompletedDate | finished | Date and time when the product was available for download from the Archive delivery Interface Point. Formatted as ISO8601 string. | $.finished | ||||
| id | REQUIRED. Identifier of the process. Always `ProductOrder` | $.id | |||||
| version | REQUIRED. Version of the process | $.version | |||||
| title | A narrative description of the process | $.title | |||||
| description | Detailed description of the process | $.description | |||||
| keywords | List of keywords that can be associated with the process | $.keywords | |||||
| jobControlOptions | List of options that indicates whether the process can be invoked synchronously, asynchronously, or either. One or more of: "sync-execute" "async-execute" "dismiss" | $.jobContolOptions | |||||
| outputTransmission | List of specifications that indicates how the results of a process are retrieved; either by value or by reference. One of: "value" "reference" | $.outputTransmission |
Retrieval functions
Retrieve Product
...