prosEO EDIP Monitor REST Services version v0.1
/proseo/order-gen/{version}
- version: required(v0.1)
/triggers
List of triggers filtered by mission, name, type, orderTemplate, inputProductClass, outputProductClass
Create a trigger from the given JSON object
Update a trigger from the given JSON object
Delete all triggers filtered by mission, name, type
get /triggers
List of triggers filtered by mission, name, type, orderTemplate, inputProductClass, outputProductClass
Query Parameters
- mission: (string)
the mission code
- name: (string)
the unique name
- type: (string)
the trigger type
- orderTemplate: (string)
the trigger orderTemplate
- inputProductClass: (string)
the trigger orderTemplate input product class
- outputProductClass: (string)
the trigger orderTemplate output product class
- recordFrom: (integer)
first record of filtered and ordered result to return
- recordTo: (integer)
last record of filtered and ordered result to return
- orderBy: (array of )
an array of strings containing a column name and an optional sort direction (ASC/DESC), separated by white space
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestTrigger
- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- name: required(string)
Short name of the trigger
- type: required(string)
The trigger type (one of "DataDriven", "TimeInterval", "Calendar", "Orbit", "Datatake")
- orderTemplateName: required(string)
Short name of the order template
- inputProductType: (string)
Product type of the input product class (mandatory for DataDrivenOrderTrigger)
- inputFileClass: (string)
The file class of the input product (optional)
- inputProcessingMode: (string)
The processing mode of the input product (optional)
- executionDelay: (integer)
Delay time range to run an order
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- nextTriggerTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Next time to run
- triggerInterval: (integer)
Interval time range to run next job
- cronExpression: (string)
A cron-style expression to schedule trigger firing
- spacecraftCode: (string)
The spacecraft code whose orbit start times determine the trigger times
- lastOrbitNumber: (integer)
The number of the last orbit for which a trigger was generated
- datatakeType: (string)
Type of datatake as annotated in Mission Planning files
- lastDatatakeStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Start time of the last datatake, for which a processing order was generated
- deltaTime: (integer)
Time offset for the trigger to fire, relative to the mission planning object's start time
- parametersToCopy: (array of string)
Set of keys for datatake parameters/attributes to copy as output parameters to the processing order
- enabled: (boolean - default: true)
Flag determining whether the trigger is usable
Example:
[
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "trigger_1",
"type": "DataDriven",
"orderTemplateName": "ot_1",
"enabled" : true
},
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"name": "trigger_2",
"type": "DataDriven",
"orderTemplateName": "ot_2",
"enabled" : true
}
]HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
post /triggers
Create a trigger from the given JSON object
Body
Media type: application/json
Type: object
Properties- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- name: required(string)
Short name of the trigger
- type: required(string)
The trigger type (one of "DataDriven", "TimeInterval", "Calendar", "Orbit", "Datatake")
- orderTemplateName: required(string)
Short name of the order template
- inputProductType: (string)
Product type of the input product class (mandatory for DataDrivenOrderTrigger)
- inputFileClass: (string)
The file class of the input product (optional)
- inputProcessingMode: (string)
The processing mode of the input product (optional)
- executionDelay: (integer)
Delay time range to run an order
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- nextTriggerTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Next time to run
- triggerInterval: (integer)
Interval time range to run next job
- cronExpression: (string)
A cron-style expression to schedule trigger firing
- spacecraftCode: (string)
The spacecraft code whose orbit start times determine the trigger times
- lastOrbitNumber: (integer)
The number of the last orbit for which a trigger was generated
- datatakeType: (string)
Type of datatake as annotated in Mission Planning files
- lastDatatakeStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Start time of the last datatake, for which a processing order was generated
- deltaTime: (integer)
Time offset for the trigger to fire, relative to the mission planning object's start time
- parametersToCopy: (array of string)
Set of keys for datatake parameters/attributes to copy as output parameters to the processing order
- enabled: (boolean - default: true)
Flag determining whether the trigger is usable
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "trigger_1",
"type": "DataDriven",
"orderTemplateName": "ot_1",
"enabled" : true
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- name: required(string)
Short name of the trigger
- type: required(string)
The trigger type (one of "DataDriven", "TimeInterval", "Calendar", "Orbit", "Datatake")
- orderTemplateName: required(string)
Short name of the order template
- inputProductType: (string)
Product type of the input product class (mandatory for DataDrivenOrderTrigger)
- inputFileClass: (string)
The file class of the input product (optional)
- inputProcessingMode: (string)
The processing mode of the input product (optional)
- executionDelay: (integer)
Delay time range to run an order
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- nextTriggerTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Next time to run
- triggerInterval: (integer)
Interval time range to run next job
- cronExpression: (string)
A cron-style expression to schedule trigger firing
- spacecraftCode: (string)
The spacecraft code whose orbit start times determine the trigger times
- lastOrbitNumber: (integer)
The number of the last orbit for which a trigger was generated
- datatakeType: (string)
Type of datatake as annotated in Mission Planning files
- lastDatatakeStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Start time of the last datatake, for which a processing order was generated
- deltaTime: (integer)
Time offset for the trigger to fire, relative to the mission planning object's start time
- parametersToCopy: (array of string)
Set of keys for datatake parameters/attributes to copy as output parameters to the processing order
- enabled: (boolean - default: true)
Flag determining whether the trigger is usable
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "trigger_1",
"type": "DataDriven",
"orderTemplateName": "ot_1",
"enabled" : true
}
HTTP status code 400
The request sent to the server contains data which is not as expected e.g. invalid location URI
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
patch /triggers
Update a trigger from the given JSON object
Body
Media type: application/json
Type: object
Properties- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- name: required(string)
Short name of the trigger
- type: required(string)
The trigger type (one of "DataDriven", "TimeInterval", "Calendar", "Orbit", "Datatake")
- orderTemplateName: required(string)
Short name of the order template
- inputProductType: (string)
Product type of the input product class (mandatory for DataDrivenOrderTrigger)
- inputFileClass: (string)
The file class of the input product (optional)
- inputProcessingMode: (string)
The processing mode of the input product (optional)
- executionDelay: (integer)
Delay time range to run an order
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- nextTriggerTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Next time to run
- triggerInterval: (integer)
Interval time range to run next job
- cronExpression: (string)
A cron-style expression to schedule trigger firing
- spacecraftCode: (string)
The spacecraft code whose orbit start times determine the trigger times
- lastOrbitNumber: (integer)
The number of the last orbit for which a trigger was generated
- datatakeType: (string)
Type of datatake as annotated in Mission Planning files
- lastDatatakeStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Start time of the last datatake, for which a processing order was generated
- deltaTime: (integer)
Time offset for the trigger to fire, relative to the mission planning object's start time
- parametersToCopy: (array of string)
Set of keys for datatake parameters/attributes to copy as output parameters to the processing order
- enabled: (boolean - default: true)
Flag determining whether the trigger is usable
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "trigger_1",
"type": "DataDriven",
"orderTemplateName": "ot_1",
"enabled" : true
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- name: required(string)
Short name of the trigger
- type: required(string)
The trigger type (one of "DataDriven", "TimeInterval", "Calendar", "Orbit", "Datatake")
- orderTemplateName: required(string)
Short name of the order template
- inputProductType: (string)
Product type of the input product class (mandatory for DataDrivenOrderTrigger)
- inputFileClass: (string)
The file class of the input product (optional)
- inputProcessingMode: (string)
The processing mode of the input product (optional)
- executionDelay: (integer)
Delay time range to run an order
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- nextTriggerTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Next time to run
- triggerInterval: (integer)
Interval time range to run next job
- cronExpression: (string)
A cron-style expression to schedule trigger firing
- spacecraftCode: (string)
The spacecraft code whose orbit start times determine the trigger times
- lastOrbitNumber: (integer)
The number of the last orbit for which a trigger was generated
- datatakeType: (string)
Type of datatake as annotated in Mission Planning files
- lastDatatakeStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Start time of the last datatake, for which a processing order was generated
- deltaTime: (integer)
Time offset for the trigger to fire, relative to the mission planning object's start time
- parametersToCopy: (array of string)
Set of keys for datatake parameters/attributes to copy as output parameters to the processing order
- enabled: (boolean - default: true)
Flag determining whether the trigger is usable
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "trigger_1",
"type": "DataDriven",
"orderTemplateName": "ot_1",
"enabled" : true
}
HTTP status code 400
The request sent to the server contains data which is not as expected e.g. invalid location URI
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 404
The requested resource was not found
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 409
A concurrent modification was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
delete /triggers
Delete all triggers filtered by mission, name, type
Query Parameters
- mission: required(string)
the mission code
- name: required(string)
the unique name
- type: required(string)
the trigger type
HTTP status code 204
HTTP status code 304
The resource could not be deleted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 404
The requested resource to delete was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
count the triggers filtered by mission, name, type, orderTemplate, inputProductClass, outputProductClass
get /triggers/count
count the triggers filtered by mission, name, type, orderTemplate, inputProductClass, outputProductClass
Query Parameters
- mission: (string)
the mission code
- name: (string)
the unique name
- type: (string)
the trigger type
- orderTemplate: (string)
the trigger orderTemplate
- inputProductClass: (string)
the trigger orderTemplate input product class
- outputProductClass: (string)
the trigger orderTemplate output product class
Get all data driven triggers for order templates having the given product class as input product class
get /triggers/byproducttype
Get all data driven triggers for order templates having the given product class as input product class
Query Parameters
- mission: required(string)
the mission code
- productType: required(string)
The product type of the requested product class
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestTrigger
- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- name: required(string)
Short name of the trigger
- type: required(string)
The trigger type (one of "DataDriven", "TimeInterval", "Calendar", "Orbit", "Datatake")
- orderTemplateName: required(string)
Short name of the order template
- inputProductType: (string)
Product type of the input product class (mandatory for DataDrivenOrderTrigger)
- inputFileClass: (string)
The file class of the input product (optional)
- inputProcessingMode: (string)
The processing mode of the input product (optional)
- executionDelay: (integer)
Delay time range to run an order
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- nextTriggerTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Next time to run
- triggerInterval: (integer)
Interval time range to run next job
- cronExpression: (string)
A cron-style expression to schedule trigger firing
- spacecraftCode: (string)
The spacecraft code whose orbit start times determine the trigger times
- lastOrbitNumber: (integer)
The number of the last orbit for which a trigger was generated
- datatakeType: (string)
Type of datatake as annotated in Mission Planning files
- lastDatatakeStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)
Start time of the last datatake, for which a processing order was generated
- deltaTime: (integer)
Time offset for the trigger to fire, relative to the mission planning object's start time
- parametersToCopy: (array of string)
Set of keys for datatake parameters/attributes to copy as output parameters to the processing order
- enabled: (boolean - default: true)
Flag determining whether the trigger is usable
Example:
[
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "trigger_1",
"type": "DataDriven",
"orderTemplateName": "ot_1",
"enabled" : true
},
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"name": "trigger_2",
"type": "DataDriven",
"orderTemplateName": "ot_2",
"enabled" : true
}
]HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
Stop triggers, reload them from database and start again.
get /triggers/reload
Stop triggers, reload them from database and start again.
Query Parameters
- mission: (string)
the mission code
HTTP status code 200
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
/generator
Fire a data-driven trigger to generate a processing order from the given input product
post /generator/forProduct/{productId}
Fire a data-driven trigger to generate a processing order from the given input product
URI Parameters
- productId: required(integer)
Database ID of the input product to use for order generation
HTTP status code 201
Body
Media type: application/json
Type: array of object
Items: RestOrder
- id: (integer - default: 0)
The persistent id of this object
- version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
- missionCode: required(string)
The mission code (e. g. S5P)
- identifier: required(string)
User-defined order identifier
- uuid: (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 order identifier
- priority: (integer - default: 50)
Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.
- orderState: required(string - default: INITIAL)
State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }
- stateMessage: (string)
Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)
- orderSource: (string - default: OTHER)
Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }
- submissionTime: (datetime-only)
Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)
- executionTime: (datetime-only)
Expected execution time (optional, used for scheduling)
- releaseTime: (datetime-only)
Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)
- estimatedCompletionTime: (datetime-only)
Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)
- actualCompletionTime: (datetime-only)
Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")
- evictionTime: (datetime-only)
Eviction time (optional, used for automatic order deletion)
- startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)
The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.
- stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)
The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.
- slicingType: required(string - default: NONE)
One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }
- sliceDuration: (integer)
Duration of a slice in seconds (only for slicingType TIME_SLICE)
- sliceOverlap: (integer - default: 0)
Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)
- inputProductReference: (object)
Identification of the input product to use for On-Demand Production
- inputFileName: (string)
The file name of the input product to retrieve
- sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)
Sensing start time of the input product
- sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)
Sensing stop time of the input product
- inputFileName: (string)
- inputFilters: (array of RestInputFilter)
Filter conditions to apply to input products
Items: RestInputFilter
- productClass: required(string)
The product class the input filters apply to
- filterConditions: required(array of RestParameter)
Filter conditions to apply to input products of the given product class
Items: RestParameter
- key: required(string)
The parameter name
- parameterType: required(string)
The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )
- parameterValue: required(string)
All parameter values are serialized to their string representations. For deserialization refer to the parameterType.
- key: required(string)
- productClass: required(string)
- dynamicProcessingParameters: (array of RestParameter)
Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file
Items: RestParameter
- key: required(string)
The parameter name
- parameterType: required(string)
The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )
- parameterValue: required(string)
All parameter values are serialized to their string representations. For deserialization refer to the parameterType.
- key: required(string)
- classOutputParameters: (array of RestClassOutputParameter)
Set of parameters to apply to a generated product of the referenced product class replacing the general output parameters
Items: RestClassOutputParameter
- productClass: required(string)
The product class to generate as output
- outputParameters: required(array of RestParameter)
Set of parameters to apply to the generated products (may be empty)
Items: RestParameter
- key: required(string)
The parameter name
- parameterType: required(string)
The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )
- parameterValue: required(string)
All parameter values are serialized to their string representations. For deserialization refer to the parameterType.
- key: required(string)
- productClass: required(string)
- outputParameters: required(array of RestParameter)
Parameters to set for the generated products (may be empty)
Items: RestParameter
- key: required(string)
The parameter name
- parameterType: required(string)
The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )
- parameterValue: required(string)
All parameter values are serialized to their string representations. For deserialization refer to the parameterType.
- key: required(string)
- workflowUuid: (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 workflow identifier (only for orders generated through ODIP, mandatory for these)
- workflowName: (string)
Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)
- configuredProcessors: required(array of string)
List of identifiers of the configured processors (may be empty)
- orbits: required(array of RestOrbitQuery)
List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)
Items: RestOrbitQuery
- spacecraftCode: required(string)
- orbitNumberFrom: required(integer)
- orbitNumberTo: required(integer)
- requestedProductClasses: required(array of string)
List of internal product types requested as output from the order (at least one is required)
- inputProductClasses: required(array of string)
List of internal product types provided as input to the order (may be empty)
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- productionType: (string)
Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)
- notificationEndpoint: (object)
The endpoint to send order completion notifications to
- uri: required(string)
The URI used to notify the ProcessingOrder originator of the order completion
- username: (string)
The username to authenticate with (using Basic Authentication)
- password: (string)
The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests
- uri: required(string)
- productRetentionPeriod: (integer)
Retention period for products generated by this processing order in seconds
- autoRelease: (boolean - default: false)
Flag determining whether the processing order will be released automatically
- autoClose: (boolean - default: false)
Flag determining whether the order will be closed immediately after successful completion
- inputDataTimeoutPeriod: (integer)
Timeout period for input data to arrive, before order is cancelled or executed with available data
- onInputDataTimeoutFail: (boolean - default: false)
Flag determining whether the order will fail when the input timeout period is reached
- hasFailedJobSteps: (boolean)
Indicates whether at least one of the job steps for this order is in state FAILED
- jobStepStates: (array of string)
The different existing job step states of order
- percentCompleted: (integer)
Percentage of completed job steps
- percentFailed: (integer)
Percentage of failed job steps
- percentRunning: (integer)
Percentage of running job steps
- expectedJobs: (integer)
Expected jobs for planning and releasing
- createdJobs: (integer)
Fully created/released jobs for planning and releasing
Example:
[
{
"id": 12345,
"version": 3,
"missionCode": "S5P",
"identifier": "RPRO Orbits 4567-5678",
"uuid": "2bfd2856-aec7-4d45-bcc0-6418857c448c",
"orderState": "INITIAL",
"startTime": "2018-05-17T00:00:00.123456",
"stopTime": "2019-07-31T12:00:00",
"slicingType": "ORBIT",
"sliceOverlap": 0,
"inputFilters": [
{
"productClass": "L1B",
"filterConditions": [
{
"key": "copernicusCollection",
"parameterType": "STRING",
"parameterValue": "01"
},
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "13"
},
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"classOutputParameters": [
{
"productClass": "CLOUD",
"outputParameters": [
{
"key": "copernicusCollection",
"parameterType": "STRING",
"parameterValue": "99"
},
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "77"
}
]
}
],
"outputParameters": [
{
"key": "copernicusCollection",
"parameterType": "STRING",
"parameterValue": "02"
},
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "14"
}
],
"configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
"orbits": [
{ "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
{ "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
],
"requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
"inputProductClasses": [ "L1B" ],
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"productRetentionPeriod": 2592000,
"hasFailedJobSteps": false,
"jobStepStates": [ "INITIAL", "READY" ],
"percentCompleted": 80,
"percentFailed": 10,
"percentRunning": 5
},
{
"id": 12346,
"version": 3,
"missionCode": "S5P",
"identifier": "RPRO Orbit 4711",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"orderState": "RELEASED",
"executionTime": "2019-10-31T12:00:00",
"evictionTime": "2019-11-05T07:25:18",
"startTime": "2018-06-13T09:23:45.678",
"stopTime": "2018-06-13T10:53:45.678",
"slicingType": "TIME_SLICE",
"sliceDuration": 300,
"sliceOverlap": 60,
"inputFilters": [
{
"productClass": "L1B",
"filterConditions": [
{
"key": "copernicusCollection",
"parameterType": "STRING",
"parameterValue": "01"
},
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "13"
},
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"classOutputParameters": [
{
"productClass": "AAI",
"outputParameters": [
{
"key": "copernicusCollection",
"parameterType": "STRING",
"parameterValue": "66"
},
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "88"
}
]
}
],
"outputParameters": [
{
"key": "copernicusCollection",
"parameterType": "STRING",
"parameterValue": "99"
},
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "14"
}
],
"configuredProcessors": [ "KNMI L2 02.01.00 2019-11-17" ],
"orbits": [
{ "spacecraftCode": "S5P", "orbitNumberFrom": 4711, "orbitNumberTo": 4711 }
],
"requestedProductClasses": [ "FRESCO", "AAI" ],
"inputProductClasses": [ ],
"outputFileClass": "NRTI",
"processingMode": "NRTI",
"productionType": "SYSTEMATIC",
"hasFailedJobSteps": true,
"jobStepStates": [ "INITIAL", "READY" ],
"percentCompleted": 80,
"percentFailed": 10,
"percentRunning": 5
}
]
HTTP status code 400
The request sent to the server contains data which is not as expected e.g. invalid location URI
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-order-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-order-mgr (E3527) No mission code given