prosEO AIP Client 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)

• 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 product identifier

• missionCode: required(string)

  The mission code of the Product class this products instantiates

• productClass: required(string)

  Product type of the Product class this products instantiates

• processingLevel: (string)

  The level of processing required for this product's product class (L0, L1, L1A, L1B, L2, L2A etc.; output only)

• fileClass: (string)

  File class as defined for the enclosing mission (optional)

• mode: (string)

  Processing modes as defined for the enclosing mission (only if generated by this mission)

• productQuality: (string)

  Indicator for the suitability of this product for general use (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)

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

  Planned start time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS), default same as sensingStartTime

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

  Planned stop time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS), default same as sensingStopTime

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

  Sensing start time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Sensing stop time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Satellite raw data availability time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Product generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Product ingestion time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Product eviction time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

• downloadHistory: (array of RestDownloadHistory)

  The download history for this product

  Items: RestDownloadHistory

  • username: required(string)

    The user who initiated the download

  • productFileName: required(string)

    The file name of the downloaded ProductFile

  • productFileSize: required(integer)

    The product file size in bytes

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

    The time of the download in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

• productionType: (string)

  Type of production process generating this product (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• componentProductIds: (array of integer)

  Id values of the component products

• enclosingProductId: (integer)

  Id value of the enclosing product

• orbit: (object)

  Orbit relationship of this product, if any

  • spacecraftCode: required(string)
  • orbitNumber: required(integer)
• productFile: (array of RestProductFile)

  Product files for this product

  Items: RestProductFile

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

  • productId: required(integer)

    Id value of the product this product file belongs to

  • processingFacilityName: required(string)

    The name of the processing facility, in which this product file is stored

  • productFileName: required(string)

    The name of the product data file

  • auxFileNames: required(array of string)

    The auxiliary files for this product file

  • filePath: required(string)

    The path to the product files (POSIX file path, S3 bucket etc.)

  • storageType: required(string)

    The string representation of the type of the storage location (e. g. "S3", "POSIX")

  • fileSize: required(integer)

    The size of the primary product file in bytes

  • checksum: required(string)

    Checksum value for the primary product file (computed by MD5 algorithm)

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

    Checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • zipFileName: (string)

    The file name of the ZIP archive containing all product and auxiliary files intended for distribution

  • zipFileSize: (integer)

    The file size of the ZIP archive in bytes

  • zipChecksum: (string)

    The MD5 checksum for the ZIP archive

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

    ZIP archive checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

• configuredProcessor: (object)

  The generating processor and its configuration

  • id: (integer - default: 0)

    The persistent id of this object

  • version: (integer - default: 1)

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

  • identifier: required(string)

    User-defined identifier for this processor configuration

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

    Universally unique identifier for this processor configuration ("workflow" in ESA terminology)

  • missionCode: required(string)

    The mission code (e. g. S5P)

  • processorName: required(string)

    User-defined unique processor class name

  • processorVersion: required(string)

    Version identification of the processor executable (Docker image)

  • configurationVersion: required(string)

    Version identification of the configuration environment

  • enabled: (boolean - default: true)

    Indicator whether the configured processor is enabled and may be run

• parameters: required(array of RestParameter)

  A collection of mission-specific parameters for this object

  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.

Example:

{
    "id": 689325,
    "version": 11,
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "missionCode": "S5P",
    "productClass": "AAI",
    "fileClass": "TEST",
    "mode": "OFFL",
    "productQuality": "EXPERIMENTAL",
    "requestedStartTime": "2018-06-13T09:23:45.396521",
    "requestedStopTime": "2018-06-13T10:53:45.396521",
    "sensingStartTime": "2018-06-13T09:43:56.789000",
    "sensingStopTime": "2018-06-13T10:33:45.678000",
    "generationTime": "2019-10-05T10:12:39.000000",
    "orbit": {
        "spacecraftCode": "S5P",
        "orbitNumber": 4711
    },
    "parameters": [
        {
            "key": "baselineCollection",
            "parameterType": "INTEGER",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        },
        {
            "key": "fileClass",
            "parameterType": "STRING",
            "parameterValue": "RPRO"
        }
    ]
}

HTTP status code 400

The request sent to the server contains data which is not as expected e.g. invalid facility name, product type or sensing time

Headers

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

  An error code and a plain text error message

  Example:

  199 proseo-api-apiclient (E1001) Product with file name 'S1A_OPER_xxx.SAFE' not found

HTTP status code 404

The requested resource was not found

Headers

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

  An error code and a plain text error message

  Example:

  199 proseo-api-apiclient (E1001) Product with file name 'S1A_OPER_xxx.SAFE' not found

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)

• 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 product identifier

• missionCode: required(string)

  The mission code of the Product class this products instantiates

• productClass: required(string)

  Product type of the Product class this products instantiates

• processingLevel: (string)

  The level of processing required for this product's product class (L0, L1, L1A, L1B, L2, L2A etc.; output only)

• fileClass: (string)

  File class as defined for the enclosing mission (optional)

• mode: (string)

  Processing modes as defined for the enclosing mission (only if generated by this mission)

• productQuality: (string)

  Indicator for the suitability of this product for general use (NOMINAL, EXPERIMENTAL, TEST; default NOMINAL)

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

  Planned start time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS), default same as sensingStartTime

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

  Planned stop time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS), default same as sensingStopTime

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

  Sensing start time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Sensing stop time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Satellite raw data availability time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Product generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Product ingestion time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

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

  Product eviction time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

• downloadHistory: (array of RestDownloadHistory)

  The download history for this product

  Items: RestDownloadHistory

  • username: required(string)

    The user who initiated the download

  • productFileName: required(string)

    The file name of the downloaded ProductFile

  • productFileSize: required(integer)

    The product file size in bytes

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

    The time of the download in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

• productionType: (string)

  Type of production process generating this product (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

• componentProductIds: (array of integer)

  Id values of the component products

• enclosingProductId: (integer)

  Id value of the enclosing product

• orbit: (object)

  Orbit relationship of this product, if any

  • spacecraftCode: required(string)
  • orbitNumber: required(integer)
• productFile: (array of RestProductFile)

  Product files for this product

  Items: RestProductFile

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

  • productId: required(integer)

    Id value of the product this product file belongs to

  • processingFacilityName: required(string)

    The name of the processing facility, in which this product file is stored

  • productFileName: required(string)

    The name of the product data file

  • auxFileNames: required(array of string)

    The auxiliary files for this product file

  • filePath: required(string)

    The path to the product files (POSIX file path, S3 bucket etc.)

  • storageType: required(string)

    The string representation of the type of the storage location (e. g. "S3", "POSIX")

  • fileSize: required(integer)

    The size of the primary product file in bytes

  • checksum: required(string)

    Checksum value for the primary product file (computed by MD5 algorithm)

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

    Checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

  • zipFileName: (string)

    The file name of the ZIP archive containing all product and auxiliary files intended for distribution

  • zipFileSize: (integer)

    The file size of the ZIP archive in bytes

  • zipChecksum: (string)

    The MD5 checksum for the ZIP archive

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

    ZIP archive checksum generation time in orbit format (YYYY-MM-DDThh:mm:ss.SSSSSS)

• configuredProcessor: (object)

  The generating processor and its configuration

  • id: (integer - default: 0)

    The persistent id of this object

  • version: (integer - default: 1)

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

  • identifier: required(string)

    User-defined identifier for this processor configuration

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

    Universally unique identifier for this processor configuration ("workflow" in ESA terminology)

  • missionCode: required(string)

    The mission code (e. g. S5P)

  • processorName: required(string)

    User-defined unique processor class name

  • processorVersion: required(string)

    Version identification of the processor executable (Docker image)

  • configurationVersion: required(string)

    Version identification of the configuration environment

  • enabled: (boolean - default: true)

    Indicator whether the configured processor is enabled and may be run

• parameters: required(array of RestParameter)

  A collection of mission-specific parameters for this object

  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.

Example:

{
    "id": 689325,
    "version": 11,
    "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
    "missionCode": "S5P",
    "productClass": "AAI",
    "fileClass": "TEST",
    "mode": "OFFL",
    "productQuality": "EXPERIMENTAL",
    "requestedStartTime": "2018-06-13T09:23:45.396521",
    "requestedStopTime": "2018-06-13T10:53:45.396521",
    "sensingStartTime": "2018-06-13T09:43:56.789000",
    "sensingStopTime": "2018-06-13T10:33:45.678000",
    "generationTime": "2019-10-05T10:12:39.000000",
    "orbit": {
        "spacecraftCode": "S5P",
        "orbitNumber": 4711
    },
    "parameters": [
        {
            "key": "baselineCollection",
            "parameterType": "INTEGER",
            "parameterValue": "99"
        },
        {
            "key": "revision",
            "parameterType": "INTEGER",
            "parameterValue": "14"
        },
        {
            "key": "fileClass",
            "parameterType": "STRING",
            "parameterValue": "RPRO"
        }
    ]
}

HTTP status code 400

The request sent to the server contains data which is not as expected e.g. invalid facility name, product type or sensing time

Headers

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

  An error code and a plain text error message

  Example:

  199 proseo-api-apiclient (E1001) Product with file name 'S1A_OPER_xxx.SAFE' not found

HTTP status code 404

The requested resource was not found

Headers

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

  An error code and a plain text error message

  Example:

  199 proseo-api-apiclient (E1001) Product with file name 'S1A_OPER_xxx.SAFE' not found

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: RestProduct

Example:

[
    {
        "id": 689325,
        "version": 11,
        "uuid": "3fcab4f3-457a-4424-9287-269286e5c03c",
        "missionCode": "S5P",
        "productClass": "AAI",
        "fileClass": "TEST",
        "mode": "OFFL",
        "productQuality": "EXPERIMENTAL",
        "sensingStartTime": "2018-06-13T09:23:45.396521",
        "sensingStopTime": "2018-06-13T10:53:45.396521",
        "generationTime": "2019-10-05T10:12:39.000000",
        "orbit": {
            "spacecraftCode": "S5P",
            "orbitNumber": 4711
        },
        "parameters": [
            {
                "key": "copernicusCollection",
                "parameterType": "INTEGER",
                "parameterValue": "99"
            },
            {
                "key": "revision",
                "parameterType": "INTEGER",
                "parameterValue": "14"
            },
            {
                "key": "fileClass",
                "parameterType": "STRING",
                "parameterValue": "RPRO"
            }
        ]
    },
    {
        "id": 689326,
        "version": 7,
        "uuid": "2bfd2856-aec7-4d45-bcc0-6418857c448c",
        "missionCode": "S5P",
        "productClass": "O3",
        "fileClass": "RPRO",
        "mode": "OFFL",
        "sensingStartTime": "2018-06-13T09:23:45.396521",
        "sensingStopTime": "2018-06-13T10:53:45.396521",
        "rawDataAvailabilityTime": "2018-06-13T12:25:37.000000",
        "generationTime": "2019-10-05T10:13:22.000000",
        "publicationTime": "2019-10-05T10:13:25.926000",
        "evictionTime": "2019-11-05T10:13:25.926000",
        "downloadHistory": [
            {
                "username": "johndoe",
                "productFileName": "S5P_OPER_L0________20190509T212509_20190509T214507_08138_01.ZIP",
                "productFileSize": 2625765376,
                "dateTime": "2019-10-05T17:22:48.294673"
            }
        ],
        "orbit": {
            "spacecraftCode": "S5P",
            "orbitNumber": 4711
        },
        "parameters": [
            {
                "key": "copernicusCollection",
                "parameterType": "INTEGER",
                "parameterValue": "99"
            },
            {
                "key": "revision",
                "parameterType": "INTEGER",
                "parameterValue": "14"
            },
            {
                "key": "fileClass",
                "parameterType": "STRING",
                "parameterValue": "RPRO"
            }
        ]
    }
]

HTTP status code 400

The request sent to the server contains data which is not as expected e.g. invalid facility name, product type or sensing time

Headers

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

  An error code and a plain text error message

  Example:

  199 proseo-api-apiclient (E1001) Product with file name 'S1A_OPER_xxx.SAFE' not found

HTTP status code 404

The requested resource was not found

Headers

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

  An error code and a plain text error message

  Example:

  199 proseo-api-apiclient (E1001) Product with file name 'S1A_OPER_xxx.SAFE' not found