ECMWF Data Stores Processing API

openapi: 3.1.0
info:
  title: ECMWF Data Stores Processing API
  description: 'This REST API service enables the submission of processing tasks (data
    retrieval) to the ECMWF Data Stores system, and their consequent monitoring and
    management. The service is based on the [OGC API - Processes standard](https://ogcapi.ogc.org/processes/).


    Being based on the OGC API - Processes standard, some terminology is inherited
    from it. In the context of this specific API, each _process_ is associated with
    a specific dataset and enables the retrieval of data from that dataset: as such,
    each _process_ identifier corresponds to a specific dataset identifier.

    A _job_, instead, is a specific data retrieval task that has been submitted for
    execution.'
  version: 0.1.0
paths:
  /:
    get:
      summary: Landing page
      description: Get the API landing page.
      operationId: GetLandingPage__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLandingPage'
  /conformance:
    get:
      summary: Conformance classes
      description: Get the API conformance declaration page.
      operationId: GetConformance_conformance_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConformance'
  /processes:
    get:
      summary: List of the available processes
      description: Get the list of available processes' summaries.
      operationId: GetProcesses_processes_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 10000
            minimum: 1
          - type: 'null'
          description: Maximum number of results to return.
          default: 10
          title: Limit
        description: Maximum number of results to return.
      - name: sortby
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ProcessSortCriterion'
          - type: 'null'
          description: Sorting criterion.
          default: id
          title: Sortby
        description: Sorting criterion.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProcesses'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /processes/{process_id}:
    get:
      summary: Description of a process
      description: Get the description of the process identified by `process_id`.
      operationId: GetProcess_processes__process_id__get
      parameters:
      - name: process_id
        in: path
        required: true
        schema:
          type: string
          description: Process identifier.
          title: Process Id
        description: Process identifier.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProcess'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /processes/{process_id}/execute:
    post:
      summary: Execution of a process
      description: Create a new job.
      operationId: PostProcessExecute_processes__process_id__execute_post
      deprecated: true
      parameters:
      - name: process_id
        in: path
        required: true
        schema:
          type: string
          description: Process identifier.
          title: Process Id
        description: Process identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Execute'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostProcessExecute'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /processes/{process_id}/execution:
    post:
      summary: Execution of a process
      description: Request execution of a process.
      operationId: PostProcessExecution_processes__process_id__execution_post
      parameters:
      - name: process_id
        in: path
        required: true
        schema:
          type: string
          description: Process identifier.
          title: Process Id
        description: Process identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Execute'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostProcessExecution'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /jobs:
    get:
      summary: List of submitted jobs
      description: Get the list of submitted jobs, alongside information on their
        status.
      operationId: GetJobs_jobs_get
      parameters:
      - name: processID
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Processes identifiers. Only jobs associated to the specified
            processes shall be included in the response.
          title: Processid
        description: Processes identifiers. Only jobs associated to the specified
          processes shall be included in the response.
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/SearchableStatusCode'
          - type: 'null'
          description: Job statuses. Only jobs with the specified statuses shall be
            included in the response.
          default:
          - accepted
          - running
          - successful
          - failed
          - rejected
          title: Status
        description: Job statuses. Only jobs with the specified statuses shall be
          included in the response.
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 10000
            minimum: 1
          - type: 'null'
          description: Maximum number of results to return.
          default: 10
          title: Limit
        description: Maximum number of results to return.
      - name: sortby
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/JobSortCriterion'
          - type: 'null'
          description: Sorting criterion.
          default: -created
          title: Sortby
        description: Sorting criterion.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobs'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /jobs/{job_id}:
    get:
      summary: Status of a job
      description: Get status information for the job identifed by `job_id`.
      operationId: GetJob_jobs__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Job identifier.
          title: Job Id
        description: Job identifier.
      - name: qos
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to include job qos info in the response.
          default: false
          title: Qos
        description: Whether to include job qos info in the response.
      - name: request
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to include the sumbitted request in the response.
          default: false
          title: Request
        description: Whether to include the sumbitted request in the response.
      - name: log
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to include the job's log in the response.
          default: false
          title: Log
        description: Whether to include the job's log in the response.
      - name: logStartTime
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Datetime of the first log message to be returned.
          title: Logstarttime
        description: Datetime of the first log message to be returned.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJob'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      summary: Cancel a job
      description: Dismiss the job identifed by `job_id`.
      operationId: DeleteJob_jobs__job_id__delete
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Job identifier.
          title: Job Id
        description: Job identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteJob'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /jobs/{job_id}/results:
    get:
      summary: Results of a job
      description: Get results for the job identifed by `job_id`.
      operationId: GetJobResults_jobs__job_id__results_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Job identifier.
          title: Job Id
        description: Job identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResults'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /processes/{process_id}/constraints:
    post:
      summary: Apply Constraints
      description: Apply constraints to the submitted process execution.
      operationId: apply_constraints_processes__process_id__constraints_post
      parameters:
      - name: process_id
        in: path
        required: true
        schema:
          type: string
          description: Process identifier.
          title: Process Id
        description: Process identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Execute'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Apply Constraints Processes  Process Id  Constraints
                  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /processes/{process_id}/costing:
    post:
      summary: Estimate Cost
      description: Estimate costs of the submitted process execution.
      operationId: estimate_cost_processes__process_id__costing_post
      parameters:
      - name: process_id
        in: path
        required: true
        schema:
          type: string
          description: Process identifier.
          title: Process Id
        description: Process identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Execute'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestCost'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /processes/{process_id}/api-request:
    post:
      summary: Get Api Request
      description: Get API request equivalent to the submitted process execution json.
      operationId: get_api_request_processes__process_id__api_request_post
      parameters:
      - name: process_id
        in: path
        required: true
        schema:
          type: string
          description: Process identifier.
          title: Process Id
        description: Process identifier.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Request
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Get Api Request Processes  Process Id  Api Request
                  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /jobs/delete:
    post:
      summary: Delete Jobs
      description: Delete jobs by their identifiers.
      operationId: delete_jobs_jobs_delete_post
      parameters:
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteJobs'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /jobs/{job_id}/receipt:
    get:
      summary: Get Job Receipt
      description: Get the receipt of a job.
      operationId: get_job_receipt_jobs__job_id__receipt_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          description: Job identifier.
          title: Job Id
        description: Job identifier.
      - name: allow_unauthenticated
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Allow Unauthenticated
      - name: PRIVATE-TOKEN
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key.
          title: Private-Token
        description: API key.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Job Receipt Jobs  Job Id  Receipt Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AdditionalParameter:
      properties:
        name:
          type: string
          title: Name
        value:
          items:
            anyOf:
            - type: string
            - type: number
            - type: integer
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          type: array
          title: Value
      type: object
      required:
      - name
      - value
      title: AdditionalParameter
    AdditionalParameters:
      properties:
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        role:
          anyOf:
          - type: string
          - type: 'null'
          title: Role
        href:
          anyOf:
          - type: string
          - type: 'null'
          title: Href
        parameters:
          anyOf:
          - items:
              $ref: '#/components/schemas/AdditionalParameter'
            type: array
          - type: 'null'
          title: Parameters
      type: object
      title: AdditionalParameters
    Bbox:
      properties:
        bbox:
          items:
            type: number
          type: array
          title: Bbox
        crs:
          anyOf:
          - $ref: '#/components/schemas/Crs'
          - type: 'null'
          default: http://www.opengis.net/def/crs/OGC/1.3/CRS84
      type: object
      required:
      - bbox
      title: Bbox
    Crs:
      type: string
      enum:
      - http://www.opengis.net/def/crs/OGC/1.3/CRS84
      - http://www.opengis.net/def/crs/OGC/0/CRS84h
      title: Crs
    DeleteJob:
      properties:
        processID:
          anyOf:
          - type: string
          - type: 'null'
          title: Processid
        type:
          $ref: '#/components/schemas/JobType'
        jobID:
          type: string
          title: Jobid
        status:
          $ref: '#/components/schemas/StatusCode'
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created
        started:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started
        finished:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished
        updated:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated
        progress:
          anyOf:
          - type: integer
            maximum: 100.0
            minimum: 0.0
          - type: 'null'
          title: Progress
        links:
          anyOf:
          - items:
              $ref: '#/components/schemas/Link'
            type: array
          - type: 'null'
          title: Links
        metadata:
          anyOf:
          - $ref: '#/components/schemas/StatusInfoMetadata'
          - type: 'null'
      additionalProperties: true
      type: object
      required:
      - type
      - jobID
      - status
      title: DeleteJob
    DeleteJobs:
      properties:
        job_ids:
          items:
            type: string
          type: array
          title: Job Ids
          description: Identifiers of the jobs to delete.
      type: object
      required:
      - job_ids
      title: DeleteJobs
      description: Request body for DELETE /jobs.
    Execute:
      properties:
        inputs:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Inputs
        outputs:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/Output'
            type: object
          - type: 'null'
          title: Outputs
        response:
          anyOf:
          - $ref: '#/components/schemas/Response'
          - type: 'null'
          default: raw
        subscriber:
          anyOf:
          - $ref: '#/components/schemas/Subscriber'
          - type: 'null'
      type: object
      title: Execute
    Format:
      properties:
        mediaType:
          anyOf:
          - type: string
          - type: 'null'
          title: Mediatype
        encoding:
          anyOf:
          - type: string
          - type: 'null'
          title: Encoding
        schema:
          anyOf:
          - type: string
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Schema
      type: object
      title: Format
    GetConformance:
      properties:
        conformsTo:
          items:
            type: string
          type: array
          title: Conformsto
          example: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
      type: object
      required:
      - conformsTo
      title: GetConformance
    GetJob:
      properties:
        processID:
          anyOf:
          - type: string
          - type: 'null'
          title: Processid
        type:
          $ref: '#/components/schemas/JobType'
        jobID:
          type: string
          title: Jobid
        status:
          $ref: '#/components/schemas/StatusCode'
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created
        started:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started
        finished:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished
        updated:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated
        progress:
          anyOf:
          - type: integer
            maximum: 100.0
            minimum: 0.0
          - type: 'null'
          title: Progress
        links:
          anyOf:
          - items:
              $ref: '#/components/schemas/Link'
            type: array
          - type: 'null'
          title: Links
        metadata:
          anyOf:
          - $ref: '#/components/schemas/StatusInfoMetadata'
          - type: 'null'
      additionalProperties: true
      type: object
      required:
      - type
      - jobID
      - status
      title: GetJob
    GetJobResults:
      anyOf:
      - additionalProperties:
          $ref: '#/components/schemas/RootModel_Union_RootModel_Union_str__float__int__bool__List_Any___RootModel_str___Bbox____QualifiedInputValue__Link__'
        type: object
      - type: 'null'
      title: GetJobResults
    GetJobs:
      properties:
        jobs:
          items:
            $ref: '#/components/schemas/StatusInfo'
          type: array
          title: Jobs
        links:
          anyOf:
          - items:
              $ref: '#/components/schemas/Link'
            type: array
          - type: 'null'
          title: Links
        metadata:
          anyOf:
          - $ref: '#/components/schemas/JobListMetadata'
          - type: 'null'
      type: object
      required:
      - jobs
      title: GetJobs
    GetLandingPage:
      properties:
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          example: Example processing server
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          example: Example server implementing the OGC API - Processes 1.0 Standard
        links:
          items:
            $ref: '#/components/schemas/Link'
          type: array
          title: Links
      type: object
      required:
      - links
      title: GetLandingPage
    GetProcess:
      properties:
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        keywords:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keywords
        metadata:
          anyOf:
          - items:
              $ref: '#/components/schemas/Metadata'
            type: array
          - type: 'null'
          title: Metadata
        additionalParameters:
          anyOf:
          - $ref: '#/components/schemas/AdditionalParameters'
          - type: 'null'
        id:
          type: string
          title: Id
        version:
          type: string
          title: Version
        jobControlOptions:
          anyOf:
          - items:
              $ref: '#/components/schemas/JobControlOptions'
            type: array
          - type: 'null'
          title: Jobcontroloptions
        outputTransmission:
          anyOf:
          - items:
              $ref: '#/components/schemas/TransmissionMode'
            type: array
          - type: 'null'
          title: Outputtransmission
        links:
          anyOf:
          - items:
              $ref: '#/components/schemas/Link'
            type: array
          - type: 'null'
          title: Links
        inputs:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/InputDescription'
            type: object
          - type: 'null'
          title: Inputs
        outputs:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/OutputDescription'
            type: object
          - type: 'null'
          title: Outputs
      type: object
      required:
      - id
      - version
      title: GetProcess
    GetProcesses:
      properties:
        processes:
          items:
            $ref: '#/components/schemas/ProcessSummary'
          type: array
          title: Processes
        links:
          items:
            $ref: '#/components/schemas/Link'
          type: array
          title: Links
      type: object
      required:
      - processes
      - links
      title: GetProcesses
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InputDescription:
      properties:
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        keywords:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keywords
        metadata:
          anyOf:
          - items:
              $ref: '#/components/schemas/Metadata'
            type: array
          - type: 'null'
          title: Metadata
        additionalParameters:
          anyOf:
          - $ref: '#/components/schemas/AdditionalParameters'
          - type: 'null'
        minOccurs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Minoccurs
          default: 1
        maxOccurs:
          anyOf:
          - type: integer
          - $ref: '#/components/schemas/MaxOccur'
          - type: 'null'
          title: Maxoccurs
        schema:
          anyOf:
          - $ref: '#/components/schemas/Reference'
          - $ref: '#/components/schemas/SchemaItem'
          title: Schema
      type: object
      required:
      - schema
      title: InputDescription
    JobControlOptions:
      type: string
      enum:
      - sync-execute
      - async-execute
      - dismiss
      titl

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://artifacts.apis.io/ecmwf/openapi/ecmwf-data-stores-processing-openapi.yml