prosEO On-Demand Production Interface Delivery Point (ODIP) REST Services API API documentation version v1
/proseo/odip/odata/{version}
- version: required(v1)
/Workflows
Methods for querying the workflows according to ESA's On-Demand Production Interface Delivery Point (ODIP) API
Query the workflows
get /Workflows
Query the workflows
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 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: CscWorkflow
- 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)
Short name of the workflow
- Description: required(string)
Textual description of the workflow, including details of the processor version and configuration applicable
- InputProductType: required(string)
Product Type of the Input Product
- OutputProductType: required(string)
Product Type of the Output Product
- WorkflowVersion: required(string)
Version number applicable to the workflow
- WorkflowOptions: required(array of CscWorkflowOption)
The workflow options of the workflow
Items: CscWorkflowOption
- Name: required(string)
The name of the option
- Description: (string)
Textual description of the option
- Type: (string)
Type of the option
- Default: (string)
The default value of the option, if there is one
- Value: (array of string)
Array representing all possible values of the option
- Name: required(string)
Example:
[
{
"@odata.context": "$metadata#Workflows/$entity",
"Id": "2b17b57d-fff4-4645-b539-91f305c83b91",
"Name": "S2_L1C_L2A",
"Description": "Product processing from Sentinel-2 L1C to L2A. Processor V2.3.6",
"InputProductType": "S2MSILC",
"OutputProductType": "S2MSI2A",
"WorkflowVersion": "1.2",
"WorkflowOptions":
[
{
"Name": "ImageFormat",
"Description": "Image Format option for the production output: GEOTIFF, JPG",
"Type": "String",
"Default": "GEOTIFF",
"Value":
[
"GEOTIFF",
"JPG"
]
}
]
}
]
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-odip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-odip (E4711) 'creation-date > today()' is not a valid query filter
HTTP status code 401
The requesting user is unauthorised to submit the 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-odip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-odip (E4711) 'creation-date > today()' is not a valid query filter
/ProductionOrder
ProductionOrder submission according to ESA's On-Demand Production Interface Delivery Point (ODIP) API
Create a new production order
post /ProductionOrder
Create a new production order
Body
Media type: application/json
Type: object
Properties- Id: (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 production order identifier
- Status: (one of queued, in_progress, completed, failed, cancelled)
JobStatus value
- StatusMessage: (string)
Text message providing additional information on the returned status
- OrderOutputSize: (integer)
Actual size in bytes (B) of the output Product composing the Order.
- SubmissionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time at which the ProductionOrder was received by the ODPRIP
- EstimatedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Estimated date and time when the product will be available for download from the ODPRIP
- CompletedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time when the product was available for download from the ODPRIP
- EvictionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date when the Product related to the order will be removed from the ODPRIP
- Priority: required(integer)
Priority of the ProductionOrder. It is an integer from 1-100, default 50.
- InputProductReference: required(object)
Complex type used to unambiguously identify the input product
- Reference: (string)
The file name of the input product to retrieve
- ContentDate: (object)
The sensing range period
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing start time of the input product
- End: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing stop time of the input product
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
- Reference: (string)
- WorkflowId: required(string)
The Id is a local unique identifier for the Workflow instance within the ODPRIP which is applicable to the ProductionOrder
- WorkflowName: required(string)
Short name of the workflow
- WorkflowOptions: required(array of CscWorkflowOption)
Selection of applicable options from the Workflow
Items: CscWorkflowOption
- Name: required(string)
The name of the option
- Description: (string)
Textual description of the option
- Type: (string)
Type of the option
- Default: (string)
The default value of the option, if there is one
- Value: (array of string)
Array representing all possible values of the option
- Name: required(string)
- NotificationEndpoint: (string)
URI used by the ODPRIP for product download readiness notifications
- NotificationEpUsername: (string)
The username associated with the EndPoint URI provided
- NotificationEpPassword: (string)
The password associated with the EndPoint URI provided
Example:
{
"InputProductReference":
{
"Reference": "S2B_MSIL1C_20191025T085939_N0208_R007_T37VCC_20191025T112031.zip",
"ContentDate": {
"Start": "2016-01-17T10:34:51.922Z",
"End": "2016-01-17T10:35:18:872Z"
}
},
"Priority": 50,
"WorkflowId": "6c18b57d-fgk4-1236-b539-12h305c26z89",
"WorkflowName": "S2_L1C_L2A",
"WorkflowOptions":
[
{
"Name": "ImageFormat",
"Value":
[
"JPG"
]
}
],
"NotificationEndpoint": "https://myservice/notification",
"NotificationEpUsername": "myserviceuser",
"NotificationEpPassword": "*********"
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- Id: (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 production order identifier
- Status: (one of queued, in_progress, completed, failed, cancelled)
JobStatus value
- StatusMessage: (string)
Text message providing additional information on the returned status
- OrderOutputSize: (integer)
Actual size in bytes (B) of the output Product composing the Order.
- SubmissionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time at which the ProductionOrder was received by the ODPRIP
- EstimatedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Estimated date and time when the product will be available for download from the ODPRIP
- CompletedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time when the product was available for download from the ODPRIP
- EvictionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date when the Product related to the order will be removed from the ODPRIP
- Priority: required(integer)
Priority of the ProductionOrder. It is an integer from 1-100, default 50.
- InputProductReference: required(object)
Complex type used to unambiguously identify the input product
- Reference: (string)
The file name of the input product to retrieve
- ContentDate: (object)
The sensing range period
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing start time of the input product
- End: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing stop time of the input product
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
- Reference: (string)
- WorkflowId: required(string)
The Id is a local unique identifier for the Workflow instance within the ODPRIP which is applicable to the ProductionOrder
- WorkflowName: required(string)
Short name of the workflow
- WorkflowOptions: required(array of CscWorkflowOption)
Selection of applicable options from the Workflow
Items: CscWorkflowOption
- Name: required(string)
The name of the option
- Description: (string)
Textual description of the option
- Type: (string)
Type of the option
- Default: (string)
The default value of the option, if there is one
- Value: (array of string)
Array representing all possible values of the option
- Name: required(string)
- NotificationEndpoint: (string)
URI used by the ODPRIP for product download readiness notifications
- NotificationEpUsername: (string)
The username associated with the EndPoint URI provided
- NotificationEpPassword: (string)
The password associated with the EndPoint URI provided
Example:
{
"InputProductReference":
{
"Reference": "S2B_MSIL1C_20191025T085939_N0208_R007_T37VCC_20191025T112031.zip",
"ContentDate": {
"Start": "2016-01-17T10:34:51.922Z",
"End": "2016-01-17T10:35:18:872Z"
}
},
"Priority": 50,
"WorkflowId": "6c18b57d-fgk4-1236-b539-12h305c26z89",
"WorkflowName": "S2_L1C_L2A",
"WorkflowOptions":
[
{
"Name": "ImageFormat",
"Value":
[
"JPG"
]
}
],
"NotificationEndpoint": "https://myservice/notification",
"NotificationEpUsername": "myserviceuser",
"NotificationEpPassword": "*********"
}
/ProductionOrders
Methods for production orders according to ESA's On-Demand Production Interface Delivery Point (ODIP) API
Query the production orders
get /ProductionOrders
Query the production orders
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 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: CscProductionOrder
- Id: (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 production order identifier
- Status: (one of queued, in_progress, completed, failed, cancelled)
JobStatus value
- StatusMessage: (string)
Text message providing additional information on the returned status
- OrderOutputSize: (integer)
Actual size in bytes (B) of the output Product composing the Order.
- SubmissionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time at which the ProductionOrder was received by the ODPRIP
- EstimatedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Estimated date and time when the product will be available for download from the ODPRIP
- CompletedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time when the product was available for download from the ODPRIP
- EvictionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date when the Product related to the order will be removed from the ODPRIP
- Priority: required(integer)
Priority of the ProductionOrder. It is an integer from 1-100, default 50.
- InputProductReference: required(object)
Complex type used to unambiguously identify the input product
- Reference: (string)
The file name of the input product to retrieve
- ContentDate: (object)
The sensing range period
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing start time of the input product
- End: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing stop time of the input product
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
- Reference: (string)
- WorkflowId: required(string)
The Id is a local unique identifier for the Workflow instance within the ODPRIP which is applicable to the ProductionOrder
- WorkflowName: required(string)
Short name of the workflow
- WorkflowOptions: required(array of CscWorkflowOption)
Selection of applicable options from the Workflow
Items: CscWorkflowOption
- Name: required(string)
The name of the option
- Description: (string)
Textual description of the option
- Type: (string)
Type of the option
- Default: (string)
The default value of the option, if there is one
- Value: (array of string)
Array representing all possible values of the option
- Name: required(string)
- NotificationEndpoint: (string)
URI used by the ODPRIP for product download readiness notifications
- NotificationEpUsername: (string)
The username associated with the EndPoint URI provided
- NotificationEpPassword: (string)
The password associated with the EndPoint URI provided
Example:
[
{
"InputProductReference":
{
"Reference": "S2B_MSIL1C_20191025T085939_N0208_R007_T37VCC_20191025T112031.zip",
"ContentDate": {
"Start": "2016-01-17T10:34:51.922Z",
"End": "2016-01-17T10:35:18:872Z"
}
},
"Priority": 50,
"WorkflowId": "6c18b57d-fgk4-1236-b539-12h305c26z89",
"WorkflowName": "S2_L1C_L2A",
"WorkflowOptions":
[
{
"Name": "ImageFormat",
"Value":
[
"JPG"
]
}
],
"NotificationEndpoint": "https://myservice/notification",
"NotificationEpUsername": "myserviceuser",
"NotificationEpPassword": "*********"
}
]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-odip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-odip (E4711) 'creation-date > today()' is not a valid query filter
HTTP status code 401
The requesting user is unauthorised to submit the 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-odip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-odip (E4711) 'creation-date > today()' is not a valid query filter
getProductionOrderById
Methods for production orders according to ESA's On-Demand Production Interface Delivery Point (ODIP) API
Query the production orders by id
get /ProductionOrders('{Id}')
Query the production orders by id
URI Parameters
- 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 identifier
HTTP status code 200
The request was successfully completed
Body
Media type: application/json
Type: object
Properties- Id: (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 production order identifier
- Status: (one of queued, in_progress, completed, failed, cancelled)
JobStatus value
- StatusMessage: (string)
Text message providing additional information on the returned status
- OrderOutputSize: (integer)
Actual size in bytes (B) of the output Product composing the Order.
- SubmissionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time at which the ProductionOrder was received by the ODPRIP
- EstimatedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Estimated date and time when the product will be available for download from the ODPRIP
- CompletedDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date and time when the product was available for download from the ODPRIP
- EvictionDate: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Date when the Product related to the order will be removed from the ODPRIP
- Priority: required(integer)
Priority of the ProductionOrder. It is an integer from 1-100, default 50.
- InputProductReference: required(object)
Complex type used to unambiguously identify the input product
- Reference: (string)
The file name of the input product to retrieve
- ContentDate: (object)
The sensing range period
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing start time of the input product
- End: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
Sensing stop time of the input product
- Start: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{3}Z$)
- Reference: (string)
- WorkflowId: required(string)
The Id is a local unique identifier for the Workflow instance within the ODPRIP which is applicable to the ProductionOrder
- WorkflowName: required(string)
Short name of the workflow
- WorkflowOptions: required(array of CscWorkflowOption)
Selection of applicable options from the Workflow
Items: CscWorkflowOption
- Name: required(string)
The name of the option
- Description: (string)
Textual description of the option
- Type: (string)
Type of the option
- Default: (string)
The default value of the option, if there is one
- Value: (array of string)
Array representing all possible values of the option
- Name: required(string)
- NotificationEndpoint: (string)
URI used by the ODPRIP for product download readiness notifications
- NotificationEpUsername: (string)
The username associated with the EndPoint URI provided
- NotificationEpPassword: (string)
The password associated with the EndPoint URI provided
Example:
{
"InputProductReference":
{
"Reference": "S2B_MSIL1C_20191025T085939_N0208_R007_T37VCC_20191025T112031.zip",
"ContentDate": {
"Start": "2016-01-17T10:34:51.922Z",
"End": "2016-01-17T10:35:18:872Z"
}
},
"Priority": 50,
"WorkflowId": "6c18b57d-fgk4-1236-b539-12h305c26z89",
"WorkflowName": "S2_L1C_L2A",
"WorkflowOptions":
[
{
"Name": "ImageFormat",
"Value":
[
"JPG"
]
}
],
"NotificationEndpoint": "https://myservice/notification",
"NotificationEpUsername": "myserviceuser",
"NotificationEpPassword": "*********"
}
HTTP status code 400
The request sent to the server contains data which is not as expected e.g. invalid URI parameters
Headers
- Warning: required(string - pattern: ^\d{3} proseo-api-odip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-odip (E4711) 'creation-date > today()' is not a valid query filter
HTTP status code 401
The requesting user is unauthorised to download the orduction order
HTTP status code 404
The requested resource was not found (i. e. the orduction order does not exist or is not available any more)
Headers
- Warning: required(string - pattern: ^\d{3} proseo-api-odip \([EW]\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-api-odip (E4711) 'creation-date > today()' is not a valid query filter