swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ModelInference API
schemes:
- https
tags:
- name: ModelInference
paths:
  /model-inference/models/microsoft-biomass/infer-data/{jobId}:
    put:
      tags:
      - ModelInference
      description: Create a Biomass Model job.
      operationId: microsoftAzureModelinferenceCreatebiomassmodeljob
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: JobId provided by user.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: job
        description: Job parameters supplied by user.
        required: true
        schema:
          $ref: '#/definitions/BiomassModelJob'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/BiomassModelJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        ModelInference_CreateBiomassModelJob:
          $ref: ./examples/ModelInference_CreateBiomassModelJob.json
      summary: Microsoft Azure Put Model Inference Models Microsoft Biomass Infer Data Jobid
    get:
      tags:
      - ModelInference
      description: Get Biomass Model job's details.
      operationId: microsoftAzureModelinferenceGetbiomassmodeljob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BiomassModelJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        ModelInference_GetBiomassModelJob:
          $ref: ./examples/ModelInference_GetBiomassModelJob.json
      summary: Microsoft Azure Get Model Inference Models Microsoft Biomass Infer Data Jobid
  /model-inference/models/microsoft-sensor-placement/infer-data/{jobId}:
    put:
      tags:
      - ModelInference
      description: Create a Sensor Placement Model job.
      operationId: microsoftAzureModelinferenceCreatesensorplacementmodeljob
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: JobId provided by user.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: job
        description: Job parameters supplied by user.
        required: true
        schema:
          $ref: '#/definitions/SensorPlacementModelJob'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/SensorPlacementModelJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        ModelInference_CreateSensorPlacementModelJob:
          $ref: ./examples/ModelInference_CreateSensorPlacementModelJob.json
      summary: Microsoft Azure Put Model Inference Models Microsoft Sensor Placement Infer Data Jobid
    get:
      tags:
      - ModelInference
      description: Get Sensor Placement Model job's details.
      operationId: microsoftAzureModelinferenceGetsensorplacementmodeljob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SensorPlacementModelJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        ModelInference_GetSensorPlacementModelJob:
          $ref: ./examples/ModelInference_GetSensorPlacementModelJob.json
      summary: Microsoft Azure Get Model Inference Models Microsoft Sensor Placement Infer Data Jobid
  /model-inference/models/microsoft-soil-moisture/infer-data/{jobId}:
    put:
      tags:
      - ModelInference
      description: Create a SoilMoisture Model job.
      operationId: microsoftAzureModelinferenceCreatesoilmoisturemodeljob
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: JobId provided by user.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: job
        description: Job parameters supplied by user.
        required: true
        schema:
          $ref: '#/definitions/SoilMoistureModelJob'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/SoilMoistureModelJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        ModelInference_CreateSoilMoistureModelJob:
          $ref: ./examples/ModelInference_CreateSoilMoistureModelJob.json
      summary: Microsoft Azure Put Model Inference Models Microsoft Soil Moisture Infer Data Jobid
    get:
      tags:
      - ModelInference
      description: Get SoilMoisture Model job's details.
      operationId: microsoftAzureModelinferenceGetsoilmoisturemodeljob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SoilMoistureModelJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        ModelInference_GetSoilMoistureModelJob:
          $ref: ./examples/ModelInference_GetSoilMoistureModelJob.json
      summary: Microsoft Azure Get Model Inference Models Microsoft Soil Moisture Infer Data Jobid
definitions:
  SoilMoistureModelJob:
    description: Schema of soil moisture model job.
    required:
    - boundaryId
    - imageFormat
    - imageResolution
    - inferenceEndDateTime
    - inferenceStartDateTime
    - modelVersion
    - partyId
    - satelliteProvider
    - satelliteSource
    - sensorDataModelId
    - sensorDefinition
    - sensorPartnerId
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      boundaryId:
        description: The id of the boundary object for which soil moisture is being calculated.
        minLength: 1
        type: string
      sensorDataModelId:
        description: Sensor data model Id.
        minLength: 1
        type: string
      sensorPartnerId:
        description: Sensor partner Id.
        minLength: 1
        type: string
      inferenceStartDateTime:
        format: date-time
        description: Inference start date time for soil moisture calculations.
        type: string
      inferenceEndDateTime:
        format: date-time
        description: Inference end date time for soil moisture calculations.
        type: string
      satelliteProvider:
        description: 'Provider of satellite data. Available Value: Microsoft.'
        minLength: 1
        enum:
        - Microsoft
        type: string
        x-ms-enum:
          name: DataProvider
          modelAsString: true
      satelliteSource:
        description: 'Source of satellite data. Available Value: Sentinel_2_L2A.'
        minLength: 1
        enum:
        - Sentinel_2_L2A
        - Sentinel_2_L1C
        type: string
        x-ms-enum:
          name: Source
          modelAsString: true
      imageResolution:
        format: double
        description: 'ImageResolution in meters. Available values: 10, 20, 60.'
        type: number
      imageFormat:
        description: 'ImageFormat. Available value: TIF.'
        minLength: 1
        enum:
        - TIF
        type: string
        x-ms-enum:
          name: ImageFormat
          modelAsString: true
      modelVersion:
        description: The version of the soil moisture model to be run.
        minLength: 1
        type: string
      sensorDefinition:
        $ref: '#/definitions/SoilMoistureModelSensorDefinition'
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        type: string
        readOnly: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  SensorPlacementModelJob:
    description: Schema of sensor placement model job.
    required:
    - boundaryId
    - inferenceEndDateTime
    - inferenceStartDateTime
    - isRanked
    - modelVersion
    - partyId
    - satelliteProvider
    - satelliteSource
    - sensorType
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      boundaryId:
        description: The id of the boundary object for which sensor placement is being calculated.
        minLength: 1
        type: string
      modelVersion:
        description: The version of the sensor placement model to be run.
        minLength: 1
        type: string
      inferenceStartDateTime:
        format: date-time
        description: Start datetime for satellite data to be pulled.
        type: string
      inferenceEndDateTime:
        format: date-time
        description: End datetime for satellite data to be pulled.
        type: string
      satelliteProvider:
        description: 'Provider of satellite data. Available Value: Microsoft.'
        minLength: 1
        enum:
        - Microsoft
        type: string
        x-ms-enum:
          name: DataProvider
          modelAsString: true
      satelliteSource:
        description: 'Source of satellite data. Available Value: Sentinel_2_L2A.'
        minLength: 1
        enum:
        - Sentinel_2_L2A
        - Sentinel_2_L1C
        type: string
        x-ms-enum:
          name: Source
          modelAsString: true
      sensorType:
        description: 'SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture.'
        minLength: 1
        type: string
      isRanked:
        description: IsRanked, if True the sensor placements will be ranked.
        type: boolean
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        type: string
        readOnly: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  BiomassModelJob:
    description: Schema of biomass model job.
    required:
    - boundaryId
    - cropName
    - imageFormat
    - imageResolution
    - inferenceEndDateTime
    - modelVersion
    - partyId
    - plantingStartDateTime
    - satelliteProvider
    - satelliteSource
    - weatherExtensionId
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      boundaryId:
        description: The id of the boundary object for which biomass is being calculated.
        minLength: 1
        type: string
      modelVersion:
        description: 'The version of the biomass model to be run. Available Value: 1.0 .'
        minLength: 1
        type: string
      cropName:
        description: 'Crop name for biomass model. Available Value: Corn.'
        minLength: 1
        enum:
        - Corn
        type: string
        x-ms-enum:
          name: CropName
          modelAsString: true
      plantingStartDateTime:
        format: date-time
        description: 'Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
      inferenceEndDateTime:
        format: date-time
        description: 'End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
      weatherExtensionId:
        description: 'ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices.'
        maxLength: 100
        minLength: 2
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
        type: string
      satelliteProvider:
        description: 'Provider of satellite data. Available Value: Microsoft.'
        minLength: 1
        enum:
        - Microsoft
        type: string
        x-ms-enum:
          name: DataProvider
          modelAsString: true
      satelliteSource:
        description: 'Source of satellite data. Available Value: Sentinel_2_L2A.'
        minLength: 1
        enum:
        - Sentinel_2_L2A
        - Sentinel_2_L1C
        type: string
        x-ms-enum:
          name: Source
          modelAsString: true
      imageResolution:
        format: double
        description: 'ImageResolution in meters. Available values: 10, 20, 60.'
        type: number
      imageFormat:
        description: 'ImageFormat. Available value: TIF.'
        minLength: 1
        enum:
        - TIF
        type: string
        x-ms-enum:
          name: ImageFormat
          modelAsString: true
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        type: string
        readOnly: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  SoilMoistureModelSensorDefinition:
    description: Schema for storing sensor definition keywords.
    required:
    - maxProperty
    - minProperty
    - sensorMeasurement
    type: object
    properties:
      sensorMeasurement:
        description: The measurement name for sensor measure in sensorDataModel.
        minLength: 1
        type: string
      minProperty:
        description: The measurement name for minimum measurement value.
        minLength: 1
        type: string
      maxProperty:
        description: The measurement name for maximum measurement value.
        minLength: 1
        type: string
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'