Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieval functions

Retrieve Product

Queries

text in red relates to requirements not supported by the OGC standard

Call from LTA Client"OGC API - Processes" operationDetails Response of query
Product Order Request

/processes/{PROCESSID}/execution

Query type : POST

PROCESSID = order-requestProductRetrieve

Input parameters

  • product_identifier
  • priority

Response by default :

  • jobID → ID of the Order
  • status (value set to "accepted") → Status 
  • type (value set to "process")
  • message → StatusMessage
  • created → SubmissionDate

Mandatory information not supported by the standard : 

  • EstimatedDate
  • Priority

Order Status Query (status = completed)




/jobs/{JOBID}?status=successful

Query type : GET

JOBID = ID returned by the execute query

List of completed Jobs with their ID and following parameters : 

  • jobID → ID of the Order
  • status (value set to "successful") → Status
  • message → StatusMessage
  • finished → CompletedDate

Information not supported by the standard : 

  • OrderSize
  • EvictionDate

Get result of Order result query

(NEW)

/jobs/{JOBID}/results

Query type : GET

JOBID = ID returned by the execute query

Returns a JSON response with output parameters set for the completed order 

A process result will contain the following information : 

  • OrderSize
  • EvictionDate
  • ProductLink (optional & not in the current ICD)
Product Staging NotificationCallback mechanism for completed jobs : requires to add a subscriber property in the order request (notification endpoint)To assess : authorisation for callback

Retrieve process description

(NEW)

/processes/{PROCESSID}

Query type : GET

PROCESSID = ProductRetrieve

Response depending on the process definition (see below)

JobStatus value correspondance

...