prosEO Production Planner REST Services API API documentation version v0.1

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 204

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• missionCode: required(string)

  The mission code (e. g. S5P)

• identifier: required(string)

  User-defined order identifier

• uuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique order identifier

• priority: (integer - default: 50)

  Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

• orderState: required(string - default: INITIAL)

  State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

• stateMessage: (string)

  Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

• orderSource: (string - default: OTHER)

  Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

• submissionTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• executionTime: (datetime-only)

  Expected execution time (optional, used for scheduling)

• releaseTime: (datetime-only)

  Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

• estimatedCompletionTime: (datetime-only)

  Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

• actualCompletionTime: (datetime-only)

  Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

• evictionTime: (datetime-only)

  Eviction time (optional, used for automatic order deletion)

• startTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

• stopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

  The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

• slicingType: required(string - default: NONE)

  One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

• sliceDuration: (integer)

  Duration of a slice in seconds (only for slicingType TIME_SLICE)

• sliceOverlap: (integer - default: 0)

  Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

• inputProductReference: (object)

  Identification of the input product to use for On-Demand Production

  • inputFileName: (string)

    The file name of the input product to retrieve

  • sensingStartTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing start time of the input product

  • sensingStopTime: (string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{1,6})?$)

    Sensing stop time of the input product

• 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.

• dynamicProcessingParameters: (array of RestParameter)

  Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

  Items: RestParameter

  • key: required(string)

    The parameter name

  • parameterType: required(string)

    The type of the parameter for deserialization (one of { "STRING", "INTEGER", "BOOLEAN", "DOUBLE", "INSTANT" } )

  • parameterValue: required(string)

    All parameter values are serialized to their string representations. For deserialization refer to the parameterType.

• 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.

• 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.

• workflowUuid: (string - pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)

  Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

• workflowName: (string)

  Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

• configuredProcessors: required(array of string)

  List of identifiers of the configured processors (may be empty)

• orbits: required(array of RestOrbitQuery)

  List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

  Items: RestOrbitQuery

  • spacecraftCode: required(string)
  • orbitNumberFrom: required(integer)
  • orbitNumberTo: required(integer)
• requestedProductClasses: required(array of string)

  List of internal product types requested as output from the order (at least one is required)

• inputProductClasses: required(array of string)

  List of internal product types provided as input to the order (may be empty)

• outputFileClass: required(string)

  The file class for the generated output products

• processingMode: required(string)

  The processing mode to run the processor(s) in

• productionType: (string)

  Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• notificationEndpoint: (object)

  The endpoint to send order completion notifications to

  • uri: required(string)

    The URI used to notify the ProcessingOrder originator of the order completion

  • username: (string)

    The username to authenticate with (using Basic Authentication)

  • password: (string)

    The password to authenticate with, mandatory if username is given; may be set to replacement value (e. g. asterisks) on data retrieval requests

• productRetentionPeriod: (integer)

  Retention period for products generated by this processing order in seconds

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this order is in state FAILED

• jobStepStates: (array of string)

  The different existing job step states of order

• percentCompleted: (integer)

  Percentage of completed job steps

• percentFailed: (integer)

  Percentage of failed job steps

• percentRunning: (integer)

  Percentage of running job steps

• expectedJobs: (integer)

  Expected jobs for planning and releasing

• createdJobs: (integer)

  Fully created/released jobs for planning and releasing

Example:

{
    "id": 12345,
    "version": 3,
    "missionCode": "S5P",
    "identifier": "RPRO Orbits 4567-5678",
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "orderState": "INITIAL",
    "orderSource": "CLI",
    "startTime": "2018-05-17T00:00:00.123456",
    "stopTime": "2019-07-31T12:00:00",
    "slicingType": "ORBIT",
    "sliceOverlap": 0,
    "inputFilters": [
        {
            "productClass": "L1B",
            "filterConditions": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "01"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "13"
                },
                {
                    "key": "fileClass",
                    "parameterType": "STRING",
                    "parameterValue": "OFFL"
                }
            ]
        }
    ],
    "classOutputParameters": [
        {
            "productClass": "CLOUD",
            "outputParameters": [
                {
                    "key": "copernicusCollection",
                    "parameterType": "STRING",
                    "parameterValue": "99"
                },
                {
                    "key": "revision",
                    "parameterType": "INTEGER",
                    "parameterValue": "01"
                }
            ]
        }
    ],
    "outputParameters": [
        {
            "key": "copernicusCollection",
            "parameterType": "STRING",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        }
    ],
    "configuredProcessors": [ "KNMI L2 01.03.02 2019-07-03", "DLR L2 01.01.05 2019-07-03" ],
    "orbits": [
        { "spacecraftCode": "S5P", "orbitNumberFrom": 4567, "orbitNumberTo": 5330 },
        { "spacecraftCode": "S5P", "orbitNumberFrom": 5421, "orbitNumberTo": 5678 }
    ],
    "requestedProductClasses": [ "O3", "CLOUD", "FRESCO", "AAI" ],
    "inputProductClasses": [ "L1B" ],
    "outputFileClass": "RPRO",
    "processingMode": "OFFL",
    "hasFailedJobSteps": false,
    "jobStepStates": [ "INITIAL", "READY" ],
    "percentCompleted": 80,
    "percentFailed": 10,
    "percentRunning": 5
}

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: RestJob

Example:

[
    {
        "id": 23785526,
        "version": 1,
        "orderIdentifier": "CO2 products for orbits 2345-4567",
        "jobState": "PLANNED",
        "filterConditions": [],
        "outputParameters": [],
        "priority": 10,
        "hasFailedJobSteps": false,
        "processingFacilityName": "PF1",
        "jobSteps": [
            {
                "id": 23785527,
                "version": 1,
                "jobId": 23785526,
                "jobStepState": "PLANNED",
                "outputParameters": [],
                "processingMode": "OFFL",
                "inputProductClasses": [ "L1B" ],
                "outputProductClass": "CH4",
                "outputProduct": 1234,
                "isFailed": false
            }
        ]
    },
    {
        "id": 23785537,
        "version": 4,
        "orderIdentifier": "CLOUD products for orbits 2345-4567",
        "jobState": "FAILED",
        "filterConditions": [],
        "outputParameters": [],
        "priority": 10,
        "hasFailedJobSteps": true,
        "processingFacilityName": "PF2",
        "jobSteps": [
            {
                "id": 23785538,
                "version": 4,
                "jobId": 23785537,
                "jobStepState": "FAILED",
                "outputParameters": [],
                "processingMode": "OFFL",
                "inputProductClasses": [ "L1B", "CO" ],
                "outputProductClass": "CH4",
                "outputProduct": 1234,
                "isFailed": false
            }
        ]
    }
]

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-planner \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-planner (E4000) List of processing orders retrieved

HTTP status code 404

The requested resource was not found

Headers

• Warning: required(string - pattern: ^\d{3} proseo-planner \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-planner (E4000) List of processing orders retrieved

HTTP status code 200

Body

Media type: text/plain

Type: any

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-planner \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-planner (E4000) List of processing orders retrieved

HTTP status code 404

The requested resource was not found

Headers

• Warning: required(string - pattern: ^\d{3} proseo-planner \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-planner (E4000) List of processing orders retrieved

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• orderIdentifier: required(string)

  User-defined order identifier

• jobState: required(one of INITIAL, PLANNED, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED, CLOSED - default: INITIAL)

  Status of the whole job

• orbit: (object)

  The orbit this job relates to (if any)

  • 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)

  • spacecraftCode: required(string)

    The short code for the spacecraft (e. g. TDX1)

  • orbitNumber: required(integer)

    The orbit number (usually starting at 1 at launch); unique for a spacecraft and usually gapless

  • startTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The start time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • stopTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The stop time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS); usually the stop time of one orbit is the start time of the subsequent orbit

• startTime: (datetime-only)

  The start time of the time interval to process

• stopTime: (datetime-only)

  The end time of the time interval to process

• priority: required(integer - default: 50)

  A processing priority (lower numbers indicate lower priority, higher numbers higher priority; default is 50)

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this job is in state FAILED

• processingFacilityName: required(string)

  The name of the processing facility this job runs on

• jobSteps: required(array of RestJobStep)

  The job steps for this job

  Items: RestJobStep

  • 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)

  • name: (string)

    Job step name generated from the job step id (not part of data model)

  • jobId: required(integer)

    The persistend id of the job this job step belongs to

  • jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

    The currenet status of the job step

  • outputParameters: required(array of RestParameter)

    A set of parameters to set for the generated products.

    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.

  • processingMode: required(string)

    The processing mode to run the processor(s) in

  • inputProductClasses: required(array of string)

    The input product types required for processing

  • outputProductClass: required(string)

    The product type of the output product of this job step

  • outputProduct: (integer)

    The id of the output product of this job step

  • configuredProcessor: (string)

    The configured processor used to create the output product

  • processingStartTime: (datetime-only)

    The start time of the processing job

  • processingCompletionTime: (datetime-only)

    The completion time of the processing job

  • stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stdout

  • stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stderr

  • processingStdOut: (string)

    The standard output of the processing job

  • processingStdErr: (string)

    The standard error output of the processing job

  • isFailed: required(boolean)

    The failed state of the job step

  • jobOrderFilename: (string)

    The filename of the Job Order file in the associated processing facility

  • orderId: (integer)

    The id of the order

  • orderIdentifier: (string)

    The identifier of the order

Example:

{
    "id": 23785526,
    "version": 1,
    "orderIdentifier": "CH4 products for orbits 2345-4567",
    "jobState": "PLANNED",
    "filterConditions": [],
    "outputParameters": [],
    "priority": 10,
    "hasFailedJobSteps": true,
    "processingFacilityName": "PF1",
    "jobSteps": [
        {
            "id": 23785527,
            "version": 1,
            "jobId": 23785526,
            "jobStepState": "PLANNED",
            "outputParameters": [],
            "processingMode": "OFFL",
            "inputProductClasses": [ "L1B" ],
            "outputProductClass": "CH4",
            "outputProduct": 1234,
            "isFailed": false
        }
    ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• orderIdentifier: required(string)

  User-defined order identifier

• jobState: required(one of INITIAL, PLANNED, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED, CLOSED - default: INITIAL)

  Status of the whole job

• orbit: (object)

  The orbit this job relates to (if any)

  • 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)

  • spacecraftCode: required(string)

    The short code for the spacecraft (e. g. TDX1)

  • orbitNumber: required(integer)

    The orbit number (usually starting at 1 at launch); unique for a spacecraft and usually gapless

  • startTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The start time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • stopTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The stop time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS); usually the stop time of one orbit is the start time of the subsequent orbit

• startTime: (datetime-only)

  The start time of the time interval to process

• stopTime: (datetime-only)

  The end time of the time interval to process

• priority: required(integer - default: 50)

  A processing priority (lower numbers indicate lower priority, higher numbers higher priority; default is 50)

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this job is in state FAILED

• processingFacilityName: required(string)

  The name of the processing facility this job runs on

• jobSteps: required(array of RestJobStep)

  The job steps for this job

  Items: RestJobStep

  • 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)

  • name: (string)

    Job step name generated from the job step id (not part of data model)

  • jobId: required(integer)

    The persistend id of the job this job step belongs to

  • jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

    The currenet status of the job step

  • outputParameters: required(array of RestParameter)

    A set of parameters to set for the generated products.

    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.

  • processingMode: required(string)

    The processing mode to run the processor(s) in

  • inputProductClasses: required(array of string)

    The input product types required for processing

  • outputProductClass: required(string)

    The product type of the output product of this job step

  • outputProduct: (integer)

    The id of the output product of this job step

  • configuredProcessor: (string)

    The configured processor used to create the output product

  • processingStartTime: (datetime-only)

    The start time of the processing job

  • processingCompletionTime: (datetime-only)

    The completion time of the processing job

  • stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stdout

  • stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stderr

  • processingStdOut: (string)

    The standard output of the processing job

  • processingStdErr: (string)

    The standard error output of the processing job

  • isFailed: required(boolean)

    The failed state of the job step

  • jobOrderFilename: (string)

    The filename of the Job Order file in the associated processing facility

  • orderId: (integer)

    The id of the order

  • orderIdentifier: (string)

    The identifier of the order

Example:

{
    "id": 23785526,
    "version": 1,
    "orderIdentifier": "CH4 products for orbits 2345-4567",
    "jobState": "PLANNED",
    "filterConditions": [],
    "outputParameters": [],
    "priority": 10,
    "hasFailedJobSteps": true,
    "processingFacilityName": "PF1",
    "jobSteps": [
        {
            "id": 23785527,
            "version": 1,
            "jobId": 23785526,
            "jobStepState": "PLANNED",
            "outputParameters": [],
            "processingMode": "OFFL",
            "inputProductClasses": [ "L1B" ],
            "outputProductClass": "CH4",
            "outputProduct": 1234,
            "isFailed": false
        }
    ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• orderIdentifier: required(string)

  User-defined order identifier

• jobState: required(one of INITIAL, PLANNED, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED, CLOSED - default: INITIAL)

  Status of the whole job

• orbit: (object)

  The orbit this job relates to (if any)

  • 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)

  • spacecraftCode: required(string)

    The short code for the spacecraft (e. g. TDX1)

  • orbitNumber: required(integer)

    The orbit number (usually starting at 1 at launch); unique for a spacecraft and usually gapless

  • startTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The start time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • stopTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The stop time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS); usually the stop time of one orbit is the start time of the subsequent orbit

• startTime: (datetime-only)

  The start time of the time interval to process

• stopTime: (datetime-only)

  The end time of the time interval to process

• priority: required(integer - default: 50)

  A processing priority (lower numbers indicate lower priority, higher numbers higher priority; default is 50)

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this job is in state FAILED

• processingFacilityName: required(string)

  The name of the processing facility this job runs on

• jobSteps: required(array of RestJobStep)

  The job steps for this job

  Items: RestJobStep

  • 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)

  • name: (string)

    Job step name generated from the job step id (not part of data model)

  • jobId: required(integer)

    The persistend id of the job this job step belongs to

  • jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

    The currenet status of the job step

  • outputParameters: required(array of RestParameter)

    A set of parameters to set for the generated products.

    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.

  • processingMode: required(string)

    The processing mode to run the processor(s) in

  • inputProductClasses: required(array of string)

    The input product types required for processing

  • outputProductClass: required(string)

    The product type of the output product of this job step

  • outputProduct: (integer)

    The id of the output product of this job step

  • configuredProcessor: (string)

    The configured processor used to create the output product

  • processingStartTime: (datetime-only)

    The start time of the processing job

  • processingCompletionTime: (datetime-only)

    The completion time of the processing job

  • stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stdout

  • stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stderr

  • processingStdOut: (string)

    The standard output of the processing job

  • processingStdErr: (string)

    The standard error output of the processing job

  • isFailed: required(boolean)

    The failed state of the job step

  • jobOrderFilename: (string)

    The filename of the Job Order file in the associated processing facility

  • orderId: (integer)

    The id of the order

  • orderIdentifier: (string)

    The identifier of the order

Example:

{
    "id": 23785526,
    "version": 1,
    "orderIdentifier": "CH4 products for orbits 2345-4567",
    "jobState": "PLANNED",
    "filterConditions": [],
    "outputParameters": [],
    "priority": 10,
    "hasFailedJobSteps": true,
    "processingFacilityName": "PF1",
    "jobSteps": [
        {
            "id": 23785527,
            "version": 1,
            "jobId": 23785526,
            "jobStepState": "PLANNED",
            "outputParameters": [],
            "processingMode": "OFFL",
            "inputProductClasses": [ "L1B" ],
            "outputProductClass": "CH4",
            "outputProduct": 1234,
            "isFailed": false
        }
    ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• orderIdentifier: required(string)

  User-defined order identifier

• jobState: required(one of INITIAL, PLANNED, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED, CLOSED - default: INITIAL)

  Status of the whole job

• orbit: (object)

  The orbit this job relates to (if any)

  • 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)

  • spacecraftCode: required(string)

    The short code for the spacecraft (e. g. TDX1)

  • orbitNumber: required(integer)

    The orbit number (usually starting at 1 at launch); unique for a spacecraft and usually gapless

  • startTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The start time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • stopTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The stop time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS); usually the stop time of one orbit is the start time of the subsequent orbit

• startTime: (datetime-only)

  The start time of the time interval to process

• stopTime: (datetime-only)

  The end time of the time interval to process

• priority: required(integer - default: 50)

  A processing priority (lower numbers indicate lower priority, higher numbers higher priority; default is 50)

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this job is in state FAILED

• processingFacilityName: required(string)

  The name of the processing facility this job runs on

• jobSteps: required(array of RestJobStep)

  The job steps for this job

  Items: RestJobStep

  • 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)

  • name: (string)

    Job step name generated from the job step id (not part of data model)

  • jobId: required(integer)

    The persistend id of the job this job step belongs to

  • jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

    The currenet status of the job step

  • outputParameters: required(array of RestParameter)

    A set of parameters to set for the generated products.

    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.

  • processingMode: required(string)

    The processing mode to run the processor(s) in

  • inputProductClasses: required(array of string)

    The input product types required for processing

  • outputProductClass: required(string)

    The product type of the output product of this job step

  • outputProduct: (integer)

    The id of the output product of this job step

  • configuredProcessor: (string)

    The configured processor used to create the output product

  • processingStartTime: (datetime-only)

    The start time of the processing job

  • processingCompletionTime: (datetime-only)

    The completion time of the processing job

  • stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stdout

  • stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stderr

  • processingStdOut: (string)

    The standard output of the processing job

  • processingStdErr: (string)

    The standard error output of the processing job

  • isFailed: required(boolean)

    The failed state of the job step

  • jobOrderFilename: (string)

    The filename of the Job Order file in the associated processing facility

  • orderId: (integer)

    The id of the order

  • orderIdentifier: (string)

    The identifier of the order

Example:

{
    "id": 23785526,
    "version": 1,
    "orderIdentifier": "CH4 products for orbits 2345-4567",
    "jobState": "PLANNED",
    "filterConditions": [],
    "outputParameters": [],
    "priority": 10,
    "hasFailedJobSteps": true,
    "processingFacilityName": "PF1",
    "jobSteps": [
        {
            "id": 23785527,
            "version": 1,
            "jobId": 23785526,
            "jobStepState": "PLANNED",
            "outputParameters": [],
            "processingMode": "OFFL",
            "inputProductClasses": [ "L1B" ],
            "outputProductClass": "CH4",
            "outputProduct": 1234,
            "isFailed": false
        }
    ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• orderIdentifier: required(string)

  User-defined order identifier

• jobState: required(one of INITIAL, PLANNED, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED, CLOSED - default: INITIAL)

  Status of the whole job

• orbit: (object)

  The orbit this job relates to (if any)

  • 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)

  • spacecraftCode: required(string)

    The short code for the spacecraft (e. g. TDX1)

  • orbitNumber: required(integer)

    The orbit number (usually starting at 1 at launch); unique for a spacecraft and usually gapless

  • startTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The start time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • stopTime: required(string - pattern: ^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d{6}$)

    The stop time of the orbit (e. g. using a Spacecraft Midnight Crossing [SMX] event) in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS); usually the stop time of one orbit is the start time of the subsequent orbit

• startTime: (datetime-only)

  The start time of the time interval to process

• stopTime: (datetime-only)

  The end time of the time interval to process

• priority: required(integer - default: 50)

  A processing priority (lower numbers indicate lower priority, higher numbers higher priority; default is 50)

• hasFailedJobSteps: (boolean)

  Indicates whether at least one of the job steps for this job is in state FAILED

• processingFacilityName: required(string)

  The name of the processing facility this job runs on

• jobSteps: required(array of RestJobStep)

  The job steps for this job

  Items: RestJobStep

  • 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)

  • name: (string)

    Job step name generated from the job step id (not part of data model)

  • jobId: required(integer)

    The persistend id of the job this job step belongs to

  • jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

    The currenet status of the job step

  • outputParameters: required(array of RestParameter)

    A set of parameters to set for the generated products.

    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.

  • processingMode: required(string)

    The processing mode to run the processor(s) in

  • inputProductClasses: required(array of string)

    The input product types required for processing

  • outputProductClass: required(string)

    The product type of the output product of this job step

  • outputProduct: (integer)

    The id of the output product of this job step

  • configuredProcessor: (string)

    The configured processor used to create the output product

  • processingStartTime: (datetime-only)

    The start time of the processing job

  • processingCompletionTime: (datetime-only)

    The completion time of the processing job

  • stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stdout

  • stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

    The log level of stderr

  • processingStdOut: (string)

    The standard output of the processing job

  • processingStdErr: (string)

    The standard error output of the processing job

  • isFailed: required(boolean)

    The failed state of the job step

  • jobOrderFilename: (string)

    The filename of the Job Order file in the associated processing facility

  • orderId: (integer)

    The id of the order

  • orderIdentifier: (string)

    The identifier of the order

Example:

{
    "id": 23785526,
    "version": 1,
    "orderIdentifier": "CH4 products for orbits 2345-4567",
    "jobState": "PLANNED",
    "filterConditions": [],
    "outputParameters": [],
    "priority": 10,
    "hasFailedJobSteps": true,
    "processingFacilityName": "PF1",
    "jobSteps": [
        {
            "id": 23785527,
            "version": 1,
            "jobId": 23785526,
            "jobStepState": "PLANNED",
            "outputParameters": [],
            "processingMode": "OFFL",
            "inputProductClasses": [ "L1B" ],
            "outputProductClass": "CH4",
            "outputProduct": 1234,
            "isFailed": false
        }
    ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer)

  The persistent id of this object

• jobState: required(one of INITIAL, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED)

  Status of the whole job

• jobSteps: required(array of RestJobStepGraph)

  The job steps for this job

  Items: RestJobStepGraph

  • id: (integer)

    The persistent id of this object

  • jobStepState: required(one of INITIAL, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED)

    The currenet status of the job step

  • outputProductClass: required(string)

    The product type of the output product of this job step

  • predecessors: required(array of RestId)

    The list of predecessor job step ids

    Items: RestId

    • id: (integer)

      The persistent id of this object

Example:

{
    "id": 23785526,
    "jobState": "INITIAL",
    "jobSteps": [
        {
            "id": 23785527,
            "jobStepState": "INITIAL",
            "outputProductClass": "CH4",
            "predecessors": []
        }
    ]
}

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: RestJobStep

Example:

[
    {
        "id": 23785527,
        "version": 1,
        "name": "proseojob23785527",
        "jobId": 23785526,
        "jobStepState": "PLANNED",
        "outputParameters": [],
        "processingMode": "OFFL",
        "inputProductClasses": [ "L1B" ],
        "outputProductClass": "CH4",
        "outputProduct": 1234,
        "configuredProcessor": "confProc",
        "stdoutLogLevel": "INFO",
        "stderrLogLevel": "INFO",
        "isFailed": false
    },
    {
        "id": 23785538,
        "version": 4,
        "jobId": 23785537,
        "jobStepState": "FAILED",
        "outputParameters": [],
        "processingMode": "OFFL",
        "inputProductClasses": [ "L1B", "CO" ],
        "outputProductClass": "CH4",
        "outputProduct": 1234,
        "configuredProcessor": "confProc",
        "stdoutLogLevel": "INFO",
        "stderrLogLevel": "INFO",
        "isFailed": false
    }
]

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-planner \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-planner (E4000) List of processing orders retrieved

HTTP status code 404

The requested resource was not found

Headers

• Warning: required(string - pattern: ^\d{3} proseo-planner \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-planner (E4000) List of processing orders retrieved

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: (string)

  Job step name generated from the job step id (not part of data model)

• jobId: required(integer)

  The persistend id of the job this job step belongs to

• jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

  The currenet status of the job step

• outputParameters: required(array of RestParameter)

  A set of parameters to set for the generated products.

  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.

• processingMode: required(string)

  The processing mode to run the processor(s) in

• inputProductClasses: required(array of string)

  The input product types required for processing

• outputProductClass: required(string)

  The product type of the output product of this job step

• outputProduct: (integer)

  The id of the output product of this job step

• configuredProcessor: (string)

  The configured processor used to create the output product

• processingStartTime: (datetime-only)

  The start time of the processing job

• processingCompletionTime: (datetime-only)

  The completion time of the processing job

• stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stdout

• stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stderr

• processingStdOut: (string)

  The standard output of the processing job

• processingStdErr: (string)

  The standard error output of the processing job

• isFailed: required(boolean)

  The failed state of the job step

• jobOrderFilename: (string)

  The filename of the Job Order file in the associated processing facility

• orderId: (integer)

  The id of the order

• orderIdentifier: (string)

  The identifier of the order

Example:

{
    "id": 23785527,
    "version": 1,
    "name": "proseojob23785527",
    "jobId": 23785526,
    "jobStepState": "PLANNED",
    "outputParameters": [],
    "processingMode": "OFFL",
    "inputProductClasses": [ "L1B" ],
    "outputProductClass": "CH4",
    "outputProduct": 1234,
    "configuredProcessor": "confProc",
    "stdoutLogLevel": "INFO",
    "stderrLogLevel": "INFO",
    "isFailed": false
}

HTTP status code 200

Body

Media type: text/plain

Type: any

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: (string)

  Job step name generated from the job step id (not part of data model)

• jobId: required(integer)

  The persistend id of the job this job step belongs to

• jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

  The currenet status of the job step

• outputParameters: required(array of RestParameter)

  A set of parameters to set for the generated products.

  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.

• processingMode: required(string)

  The processing mode to run the processor(s) in

• inputProductClasses: required(array of string)

  The input product types required for processing

• outputProductClass: required(string)

  The product type of the output product of this job step

• outputProduct: (integer)

  The id of the output product of this job step

• configuredProcessor: (string)

  The configured processor used to create the output product

• processingStartTime: (datetime-only)

  The start time of the processing job

• processingCompletionTime: (datetime-only)

  The completion time of the processing job

• stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stdout

• stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stderr

• processingStdOut: (string)

  The standard output of the processing job

• processingStdErr: (string)

  The standard error output of the processing job

• isFailed: required(boolean)

  The failed state of the job step

• jobOrderFilename: (string)

  The filename of the Job Order file in the associated processing facility

• orderId: (integer)

  The id of the order

• orderIdentifier: (string)

  The identifier of the order

Example:

{
    "id": 23785527,
    "version": 1,
    "name": "proseojob23785527",
    "jobId": 23785526,
    "jobStepState": "PLANNED",
    "outputParameters": [],
    "processingMode": "OFFL",
    "inputProductClasses": [ "L1B" ],
    "outputProductClass": "CH4",
    "outputProduct": 1234,
    "configuredProcessor": "confProc",
    "stdoutLogLevel": "INFO",
    "stderrLogLevel": "INFO",
    "isFailed": false
}

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: (string)

  Job step name generated from the job step id (not part of data model)

• jobId: required(integer)

  The persistend id of the job this job step belongs to

• jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

  The currenet status of the job step

• outputParameters: required(array of RestParameter)

  A set of parameters to set for the generated products.

  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.

• processingMode: required(string)

  The processing mode to run the processor(s) in

• inputProductClasses: required(array of string)

  The input product types required for processing

• outputProductClass: required(string)

  The product type of the output product of this job step

• outputProduct: (integer)

  The id of the output product of this job step

• configuredProcessor: (string)

  The configured processor used to create the output product

• processingStartTime: (datetime-only)

  The start time of the processing job

• processingCompletionTime: (datetime-only)

  The completion time of the processing job

• stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stdout

• stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stderr

• processingStdOut: (string)

  The standard output of the processing job

• processingStdErr: (string)

  The standard error output of the processing job

• isFailed: required(boolean)

  The failed state of the job step

• jobOrderFilename: (string)

  The filename of the Job Order file in the associated processing facility

• orderId: (integer)

  The id of the order

• orderIdentifier: (string)

  The identifier of the order

Example:

{
    "id": 23785527,
    "version": 1,
    "name": "proseojob23785527",
    "jobId": 23785526,
    "jobStepState": "PLANNED",
    "outputParameters": [],
    "processingMode": "OFFL",
    "inputProductClasses": [ "L1B" ],
    "outputProductClass": "CH4",
    "outputProduct": 1234,
    "configuredProcessor": "confProc",
    "stdoutLogLevel": "INFO",
    "stderrLogLevel": "INFO",
    "isFailed": false
}

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: (string)

  Job step name generated from the job step id (not part of data model)

• jobId: required(integer)

  The persistend id of the job this job step belongs to

• jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

  The currenet status of the job step

• outputParameters: required(array of RestParameter)

  A set of parameters to set for the generated products.

  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.

• processingMode: required(string)

  The processing mode to run the processor(s) in

• inputProductClasses: required(array of string)

  The input product types required for processing

• outputProductClass: required(string)

  The product type of the output product of this job step

• outputProduct: (integer)

  The id of the output product of this job step

• configuredProcessor: (string)

  The configured processor used to create the output product

• processingStartTime: (datetime-only)

  The start time of the processing job

• processingCompletionTime: (datetime-only)

  The completion time of the processing job

• stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stdout

• stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stderr

• processingStdOut: (string)

  The standard output of the processing job

• processingStdErr: (string)

  The standard error output of the processing job

• isFailed: required(boolean)

  The failed state of the job step

• jobOrderFilename: (string)

  The filename of the Job Order file in the associated processing facility

• orderId: (integer)

  The id of the order

• orderIdentifier: (string)

  The identifier of the order

Example:

{
    "id": 23785527,
    "version": 1,
    "name": "proseojob23785527",
    "jobId": 23785526,
    "jobStepState": "PLANNED",
    "outputParameters": [],
    "processingMode": "OFFL",
    "inputProductClasses": [ "L1B" ],
    "outputProductClass": "CH4",
    "outputProduct": 1234,
    "configuredProcessor": "confProc",
    "stdoutLogLevel": "INFO",
    "stderrLogLevel": "INFO",
    "isFailed": false
}

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: (string)

  Job step name generated from the job step id (not part of data model)

• jobId: required(integer)

  The persistend id of the job this job step belongs to

• jobStepState: required(one of PLANNED, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED, CLOSED - default: PLANNED)

  The currenet status of the job step

• outputParameters: required(array of RestParameter)

  A set of parameters to set for the generated products.

  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.

• processingMode: required(string)

  The processing mode to run the processor(s) in

• inputProductClasses: required(array of string)

  The input product types required for processing

• outputProductClass: required(string)

  The product type of the output product of this job step

• outputProduct: (integer)

  The id of the output product of this job step

• configuredProcessor: (string)

  The configured processor used to create the output product

• processingStartTime: (datetime-only)

  The start time of the processing job

• processingCompletionTime: (datetime-only)

  The completion time of the processing job

• stdoutLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stdout

• stderrLogLevel: (one of DEBUG, INFO, PROGRESS, WARNING, ERROR - default: INFO)

  The log level of stderr

• processingStdOut: (string)

  The standard output of the processing job

• processingStdErr: (string)

  The standard error output of the processing job

• isFailed: required(boolean)

  The failed state of the job step

• jobOrderFilename: (string)

  The filename of the Job Order file in the associated processing facility

• orderId: (integer)

  The id of the order

• orderIdentifier: (string)

  The identifier of the order

Example:

{
    "id": 23785527,
    "version": 1,
    "name": "proseojob23785527",
    "jobId": 23785526,
    "jobStepState": "PLANNED",
    "outputParameters": [],
    "processingMode": "OFFL",
    "inputProductClasses": [ "L1B" ],
    "outputProductClass": "CH4",
    "outputProduct": 1234,
    "configuredProcessor": "confProc",
    "stdoutLogLevel": "INFO",
    "stderrLogLevel": "INFO",
    "isFailed": false
}

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: required(string)

  The facility name (unique key)

• facilityState: required(string - default: DISABLED)

  The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }

• description: (string)

  A short description of the processing facility

• processingEngineUrl: (string)

  The URL to access this facility's processing engine (Kubernetes instance)

• processingEngineToken: (string)

  Authentication token for connecting to this facility's processing engine (Kubernetes instance)

• maxJobsPerNode: (integer - default: 1)

  Maximum number of jobs schedulable per worker node (default 1)

• storageManagerUrl: required(string)

  The URL to access this facility's storage manager from the control instance

• externalStorageManagerUrl: required(string)

  The URL to access this facility's storage manager from an external client (via PRIP API)

• localStorageManagerUrl: (string)

  URL of the locally accessible Storage Manager

• storageManagerUser: required(string)

  User name for connecting to the Storage Manager (locally and from external services)

• storageManagerPassword: required(string)

  Password for connecting to the Storage Manager (locally and from external services)

• defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)

  The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: required(string)
• name: required(string)
• starttime: required(string)
• completiontime: required(string)
• succeded: required(string)
• type: required(string)
• status: required(string)
• log: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

• 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)

• name: required(string)

  The facility name (unique key)

• facilityState: required(string - default: DISABLED)

  The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }

• description: (string)

  A short description of the processing facility

• processingEngineUrl: (string)

  The URL to access this facility's processing engine (Kubernetes instance)

• processingEngineToken: (string)

  Authentication token for connecting to this facility's processing engine (Kubernetes instance)

• maxJobsPerNode: (integer - default: 1)

  Maximum number of jobs schedulable per worker node (default 1)

• storageManagerUrl: required(string)

  The URL to access this facility's storage manager from the control instance

• externalStorageManagerUrl: required(string)

  The URL to access this facility's storage manager from an external client (via PRIP API)

• localStorageManagerUrl: (string)

  URL of the locally accessible Storage Manager

• storageManagerUser: required(string)

  User name for connecting to the Storage Manager (locally and from external services)

• storageManagerPassword: required(string)

  Password for connecting to the Storage Manager (locally and from external services)

• defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)

  The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

HTTP status code 200

Body

Media type: text/plain

Type: any