prosEO Processor Manager REST Services API API documentation version v0.1
/proseo/processor-mgr/{version}
- version: required(v0.1)
/processorclasses
Get processor classes by mission and name
Create a new processor class
get /processorclasses
Get processor classes by mission and name
Query Parameters
- mission: (string)
the mission code
- processorName: (string)
the processor name
- recordFrom: (integer)
first record of filtered and ordered result to return
- recordTo: (integer)
last record of filtered and ordered result to return
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestProcessorClass
- 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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
[
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
},
{
"id": 1837726,
"version": 7,
"missionCode": "S5P",
"processorName": "DLR L2",
"productClasses": [ "CLOUD", "O3", "HCHO", "SO2", "O3TCL" ]
}
]
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
post /processorclasses
Create a new processor class
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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
}
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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
Count the processor classes matching the specified mission and processor name.
Get a processor class by ID
Update a processor class by ID
Delete a processor class by ID
get /processorclasses/{id}
Get a processor class by ID
URI Parameters
- id: required(integer)
HTTP status code 200
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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
patch /processorclasses/{id}
Update a processor class by ID
URI Parameters
- id: required(integer)
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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
}
HTTP status code 200
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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
}
HTTP status code 304
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)
- processorName: required(string)
User-defined unique processor class name
- productClasses: required(array of string)
The product types of the product classes a processor of this class can generate
Example:
{
"id": 1837725,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"productClasses": [ "FRESCO", "CO", "CH4", "ALH", "AAI", "O3PR", "O3TPR" ]
}
/processors
Get processors by mission, name and version (user-defined version, not database version)
Create a new processor (version)
get /processors
Get processors by mission, name and version (user-defined version, not database version)
Query Parameters
- mission: (string)
the mission code
- processorName: (string)
the name of the processor (class)
- processorVersion: (string)
the processor version
- recordFrom: (integer)
first record of filtered and ordered result to return
- recordTo: (integer)
last record of filtered and ordered result to return
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestProcessor
- 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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
[
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"minMemory": 64,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
},
{
"id": 11987345,
"version": 57,
"missionCode": "S5P",
"processorName": "DLR L2 (upas)",
"processorVersion": "01.01.07",
"isTest": false,
"minDiskSpace": 2048,
"maxTime": 240,
"sensingTimeFlag": true,
"configuredProcessors": [ "DLR L2 01.01.07 2019-03-30" ],
"tasks": [
{
"id": 234962,
"version": 1,
"taskName": "UPAS",
"taskVersion": "01.01.07",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "upas:01.01.07",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/path/to/support_data:/container/path/to/support_data"
}
]
}
]
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
post /processors
Create a new processor (version)
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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
Count the processors matching the specified mission, processor name, and processor version.
get /processors/count
Count the processors matching the specified mission, processor name, and processor version.
Query Parameters
- mission: (string)
the mission code
- processorName: (string)
the name of the processor (class)
- processorVersion: (string)
the processor version
Get a processor by ID
Update a processor by ID
Delete a processor by ID
get /processors/{id}
Get a processor by ID
URI Parameters
- id: required(integer)
HTTP status code 200
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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
HTTP status code 404
The requested resource was not found
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
patch /processors/{id}
Update a processor by ID
URI Parameters
- id: required(integer)
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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
HTTP status code 200
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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
HTTP status code 304
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)
- processorName: required(string)
The name of the processor class this processor (version) belongs to
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- jobOrderVersion: (string - default: MMFI_1_8)
Version identification of the Job Order file specification (allowed values MMFI_1_8 [default], GMES_1_1)
- useInputFileTimeIntervals: (boolean)
Indicates whether time intervals shall be used for input files in the Job Order file (default false)
- isTest: (boolean - default: false)
Indicates a test version of the processor (default false)
- minDiskSpace: (integer - default: 1024)
Minimum disk space in MB, worst case estimate plus safety margin (default 1024)
- maxTime: (integer - default: 0)
Execution time limit in seconds (default 0 means unlimited)
- sensingTimeFlag: (boolean - default: true)
Indicates whether the processor uses a sensing time interval as main processing parameter (default true)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- tasks: required(array of RestTask)
List of tasks for this processor
Items: RestTask
- 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: (string)
The mission code (e. g. S5P) (not required if embedded in processor object)
- processorName: (string)
User-defined unique processor class name of the owning processor (not required if embedded in processor object)
- processorVersion: (string)
Version identification of the processor executable (Docker image) (not required if embedded in processor object)
- taskName: required(string)
The task name (unique for the Processor)
- taskVersion: required(string)
A version identifier for the task
- isCritical: (boolean - default: true)
Indicates whether a failure of the task results in a failure of the whole processor (default true)
- criticalityLevel: (integer)
Task priority, in case of failure all running tasks with a lower priority number will be aborted (mandatory for processors with more than one task)
- numberOfCpus: (integer)
The number of CPUs used by the task
- minMemory: (integer)
Minimum memory (RAM) requirement for this task in GiB
- breakpointFileNames: required(array of string)
Intermediate output files for testing/evaluation purposes
- id: (integer - default: 0)
- dockerImage: required(string)
The name of the docker image (without registry address)
- dockerRunParameters: required(array of RestStringParameter)
Parameters to add to the "docker run" command
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 1198734,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"jobOrderVersion": "GMES_1_1",
"useInputFileTimeIntervals": true,
"isTest": false,
"minDiskSpace": 1024,
"maxTime": 300,
"sensingTimeFlag": true,
"configuredProcessors": [ "KNMI L2 01.03.02 2019-03-30" ],
"tasks": [
{
"id": 234961,
"version": 1,
"taskName": "TROPNLL2",
"taskVersion": "01.03.02",
"isCritical": true,
"criticalityLevel": 100,
"numberOfCpus": 10,
"breakpointFileNames": []
}
],
"dockerImage": "knmi-l2:01.03.02",
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
/configurations
Get configurations by mission, processor name and configuration version
Create a new configuration
get /configurations
Get configurations by mission, processor name and configuration version
Query Parameters
- mission: (string)
the mission code
- processorName: (string)
the name of the processor class this configuration belongs to
- configurationVersion: (string)
the configuration version
- recordFrom: (integer)
first record of filtered and ordered result to return
- recordTo: (integer)
last record of filtered and ordered result to return
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestConfiguration
- 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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
[
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L2/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
},
{
"id": 9276489,
"version": 2,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-04-27",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "error"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "/tmp/knmil2.dump.log"
}
],
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [ ],
"configuredProcessors": [ "KNMI L2 01.03.02 2019-04-27" ],
"dockerRunParameters": []
}
]
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 429
The result list length exceeds a configured maximum.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
post /configurations
Create a new configuration
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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L01B/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L01B/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
Count the configurations matching the specified mission, processor name, and configuration version.
get /configurations/count
Count the configurations matching the specified mission, processor name, and configuration version.
Query Parameters
- missionCode: (string)
the mission code
- processorName: (string)
the name of the processor class this configuration belongs to
- configurationVersion: (string)
the configuration version
Get a configuration by ID
Update a configuration by ID
Delete a configuration by ID
get /configurations/{id}
Get a configuration by ID
URI Parameters
- id: required(integer)
HTTP status code 200
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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L01B/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
HTTP status code 404
The requested resource was not found
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
patch /configurations/{id}
Update a configuration by ID
URI Parameters
- id: required(integer)
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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L01B/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
HTTP status code 200
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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L01B/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
HTTP status code 304
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)
- processorName: required(string)
The processor class this configuration version belongs to
- configurationVersion: required(string)
Version identification of the configuration environment
- mode: (string)
The processing mode, for which this configuration is valid; optional, if set, must match mission processing modes
- dynProcParameters: required(array of RestParameter)
Dynamic processing parameters, the values denoting default values, which may be changed by the Job Order File generator
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)
- productQuality: (string - default: NOMINAL)
Indicates the suitability for general use of products generated with this configuration (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)
- configurationFiles: required(array of RestConfigurationFile)
The configuration files for this configuration
Items: RestConfigurationFile
- fileVersion: (string)
Version string for the configuration file
- fileName: required(string)
Path name for the configuration file
- fileVersion: (string)
- staticInputFiles: required(array of RestConfigurationInputFile)
Static input files for inclusion in generated Job Order Files
Items: RestConfigurationInputFile
- 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)
- fileType: required(string)
File type according to processor-specific ICD or "LOG"
- fileNameType: required(string)
Type of the file names (one of { "Physical", "Logical", "Stem", "Regexp", "Directory" })
- fileNames: required(array of string)
A list of legal and valid filenames
- id: (integer - default: 0)
- configuredProcessors: required(array of string)
The names for the processor configurations this processor version is valid for
- dockerRunParameters: required(array of RestStringParameter)
Specific parameter for "docker run" valid for this configuration
Items: RestStringParameter
- key: required(string)
The parameter key
- value: required(string)
The parameter value
- key: required(string)
Example:
{
"id": 9276488,
"version": 5,
"missionCode": "S5P",
"processorName": "KNMI L2",
"configurationVersion": "2019-03-30",
"mode": "OFFL",
"dynProcParameters": [
{
"key": "logging.root",
"parameterType": "STRING",
"parameterValue": "notice"
},
{
"key": "logging.dumplog",
"parameterType": "STRING",
"parameterValue": "null"
}
],
"productQuality": "EXPERIMENTAL",
"configurationFiles": [
{
"fileVersion": "1.0",
"fileName": "/mnt/sw/MPC/config/S5P_OPER_CFG_MPC_L2_00000000T000000_99999999T999999_20190215T172140.xml"
}
],
"staticInputFiles": [
{
"fileType": "directory.lib",
"fileNameType": "DIRECTORY",
"fileNames": [ "/mnt/sw/IPF_KNMI_L01B/config/lib" ]
}
],
"configuredProcessors": [ "KNMI L2 01.03.01 2018-10-27", "KNMI L2 01.03.02 2019-03-30" ],
"dockerRunParameters": [
{
"key": "-v",
"value": "/my/source/directory:/container/target/directory"
}
]
}
/configuredprocessors
Get configured processors, filtered by mission, identifier, processor name, processor version and/or configuration version
Create a new configured processor
get /configuredprocessors
Get configured processors, filtered by mission, identifier, processor name, processor version and/or configuration version
Query Parameters
- mission: (string)
the mission code
- identifier: (string)
the identifier for the configured processor
- processorName: (string)
the processor name
- processorVersion: (string)
the processor version
- configurationVersion: (string)
the configuration version
- uuid: (string)
the UUID of the configured processor
- recordFrom: (integer)
first record of filtered and ordered result to return
- recordTo: (integer)
last record of filtered and ordered result to return
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestConfiguredProcessor
- 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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
[
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
},
{
"id": 3367252,
"version": 2,
"identifier": "KNMI L2 01.03.02 2019-04-27",
"uuid": "2bfd2856-aec7-4d45-bcc0-6418857c448c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-04-27",
"enabled": false
}
]
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 429
The result list length exceeds a configured maximum.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
post /configuredprocessors
Create a new configured processor
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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
}
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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
Count the configuredProcessors matching the specified mission, processor name, and configuredProcessor version.
get /configuredprocessors/count
Count the configuredProcessors matching the specified mission, processor name, and configuredProcessor version.
Query Parameters
- mission: (string)
the mission code
- processorName: (string)
the processor name
- processorVersion: (string)
the processor version
- configurationVersion: (string)
the configuration version
Get a configured processor by ID
Update a configured processor by ID
Delete a configured processor by ID
get /configuredprocessors/{id}
Get a configured processor by ID
URI Parameters
- id: required(integer)
HTTP status code 200
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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
patch /configuredprocessors/{id}
Update a configured processor by ID
URI Parameters
- id: required(integer)
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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
}
HTTP status code 200
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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
}
HTTP status code 304
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)
- identifier: required(string)
User-defined identifier for this processor configuration
- 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 identifier for this processor configuration ("workflow" in ESA terminology)
- missionCode: required(string)
The mission code (e. g. S5P)
- processorName: required(string)
User-defined unique processor class name
- processorVersion: required(string)
Version identification of the processor executable (Docker image)
- configurationVersion: required(string)
Version identification of the configuration environment
- enabled: (boolean - default: true)
Indicator whether the configured processor is enabled and may be run
Example:
{
"id": 3367251,
"version": 4,
"identifier": "KNMI L2 01.03.02 2019-03-30",
"uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
"missionCode": "S5P",
"processorName": "KNMI L2",
"processorVersion": "01.03.02",
"configurationVersion": "2019-03-30"
}
/workflows
Get a list of all workflows with the specified mission, workflow name, workflow version, input product class and configured processor
Create a workflow from the given Json object
get /workflows
Get a list of all workflows with the specified mission, workflow name, workflow version, input product class and configured processor
Query Parameters
- mission: (string)
the mission code
- name: (string)
the workflow name
- workflowVersion: (string)
the workflow version
- inputProductClass: (string)
the input product class
- configuredProcessor: (string)
the configured processor
- enabled: (boolean)
whether the workflow is enabled
- recordFrom: (integer)
first record of filtered and ordered result to return
- recordTo: (integer)
last record of filtered and ordered result to return
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: RestWorkflow
- 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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
[
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
},
{
"id": 623189045,
"version": 1,
"missionCode": "S5P",
"name": "AER_to_SO2",
"uuid": "256fe2dd-afcf-4742-bba1-727230eb0ac9",
"workflowVersion": "1.0",
"enabled": false,
"inputProductClass": "L2__AER_AI",
"outputProductClass": "L2__SO2___",
"configuredProcessor": "NL-L2 02.04.00",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"workflowOptions": [
{
"id": 623189045,
"version": 1,
"missionCode": "S5P",
"workflowName": "AER_to_SO2",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"outputParameters": []
}
]
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 404
The requested resource was not found.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 429
The result list length exceeds a configured maximum.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
post /workflows
Create a workflow 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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"inputFilters": [
{
"productClass": "L2__CLOUD_",
"filterConditions": [
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"classOutputParameters": [
{
"productClass": "L2__O3____",
"outputParameters": [
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "02"
}
]
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
}
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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"inputFilters": [
{
"productClass": "L2__CLOUD_",
"filterConditions": [
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"classOutputParameters": [
{
"productClass": "L2__O3____",
"outputParameters": [
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "02"
}
]
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
Count the workflows matching the specified name, workflow version, input product class, or configured processor.
get /workflows/count
Count the workflows matching the specified name, workflow version, input product class, or configured processor.
Query Parameters
- mission: (string)
the mission code
- name: (string)
the workflow name
- workflowVersion: (string)
the workflow version
- inputProductClass: (string)
the input product class
- configuredProcessor: (string)
the configured processor
- enabled: (boolean)
whether the workflow is enabled
Find the workflow with the given ID
Update the workflow with the given ID with the attribute values of the given Json object.
Delete a workflow by ID
get /workflows/{id}
Find the workflow with the given ID
URI Parameters
- id: required(integer)
HTTP status code 200
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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"inputFilters": [
{
"productClass": "L2__CLOUD_",
"filterConditions": [
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"classOutputParameters": [
{
"productClass": "L2__O3____",
"outputParameters": [
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "02"
}
]
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
}
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-productclass-mgr \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-productclass-mgr (E5023) Name of configured processor not set
patch /workflows/{id}
Update the workflow with the given ID with the attribute values of the given Json object.
URI Parameters
- id: required(integer)
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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"inputFilters": [
{
"productClass": "L2__CLOUD_",
"filterConditions": [
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"classOutputParameters": [
{
"productClass": "L2__O3____",
"outputParameters": [
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "02"
}
]
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
}
HTTP status code 200
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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"inputFilters": [
{
"productClass": "L2__CLOUD_",
"filterConditions": [
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"classOutputParameters": [
{
"productClass": "L2__O3____",
"outputParameters": [
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "02"
}
]
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
}
HTTP status code 304
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 workflow
- 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 workflow identifier
- description: (string)
Textual description of the workflow, including details of the processor version and configuration applicable
- workflowVersion: required(string)
Version number applicable to the workflow
- enabled: required(boolean)
Flag indicating whether this workflow is available for use (disabled workflows are not visible on the ODIP)
- inputProductClass: required(string)
The (primary) ProductClass used as input for the workflow
- outputProductClass: required(string)
The ProductClass of the (main) output product
- configuredProcessor: required(string)
The identifier of the configured processor implementing this workflow
- outputFileClass: required(string)
The file class for the generated output products
- processingMode: required(string)
The processing mode to run the processor(s) in
- 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)
- 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)
- workflowOptions: required(array of RestWorkflowOption)
Options, which can be set as "Dynamic Processing Parameters" in Job Orders generated from this workflow
Items: RestWorkflowOption
- 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)
- workflowName: required(string)
Unique short name of the owning workflow
- description: (string)
Textual description of the workflow option
- name: required(string)
Short name of the option
- optionType: required(string)
Data type of the option, one of { string, number, datenumber }
- defaultValue: (string)
The default value of the option (from the value range, if applicable)
- valueRange: required(array of string)
List of all possible values of the option
- id: (integer - default: 0)
- 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)
Example:
{
"id": 890456231,
"version": 1,
"missionCode": "S5P",
"name": "CLOUD_to_O3",
"uuid": "43ff0d08-8bf1-48b5-b887-5c6b400967f6",
"workflowVersion": "1.0",
"enabled": true,
"inputProductClass": "L2__CLOUD_",
"outputProductClass": "L2__O3____",
"configuredProcessor": "UPAS 02.04.01 2022-11-02",
"outputFileClass": "RPRO",
"processingMode": "OFFL",
"slicingType": "NONE",
"inputFilters": [
{
"productClass": "L2__CLOUD_",
"filterConditions": [
{
"key": "fileClass",
"parameterType": "STRING",
"parameterValue": "OFFL"
}
]
}
],
"workflowOptions": [
{
"id": 890456232,
"version": 1,
"missionCode": "S5P",
"workflowName": "CLOUD_to_O3",
"name": "Threads",
"optionType": "NUMBER",
"defaultValue": "10",
"valueRange": []
}
],
"classOutputParameters": [
{
"productClass": "L2__O3____",
"outputParameters": [
{
"key": "revision",
"parameterType": "INTEGER",
"parameterValue": "02"
}
]
}
],
"outputParameters": [
{
"key": "baselineCollection",
"parameterType": "STRING",
"parameterValue": "99"
}
]
}