Microsoft Azure FarmOperations API

openapi: 3.2.0
info:
  title: Microsoft Azure Farm Operations API
  version: '1.0'
  description: 'Operations tagged FarmOperations across 2 of this provider''s published API definitions: azure-agfoodplatform-data-plane-service-openapi-original.yml, microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml. Each path carries the servers of the definition it was published in.'
security:
- Bearer: []
tags:
- name: FarmOperations
paths:
  /farm-operations/ingest-data/{jobId}:
    put:
      tags:
      - FarmOperations
      description: Create a farm operation data ingestion job.
      operationId: microsoftAzureFarmoperationsCreatedataingestionjob
      parameters:
      - in: path
        name: jobId
        description: Job Id supplied by user.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FarmOperationDataIngestionJob'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        FarmOperations_CreateDataIngestionJob:
          $ref: ./examples/FarmOperations_CreateDataIngestionJob.json
      summary: Microsoft Azure Put Farm Operations Ingest Data Jobid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FarmOperationDataIngestionJob'
        description: Job parameters supplied by user.
        required: true
    get:
      tags:
      - FarmOperations
      description: Get a farm operation data ingestion job.
      operationId: microsoftAzureFarmoperationsGetdataingestionjobdetails
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FarmOperationDataIngestionJob'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        FarmOperations_GetDataIngestionJobDetails:
          $ref: ./examples/FarmOperations_GetDataIngestionJobDetails.json
      summary: Microsoft Azure Get Farm Operations Ingest Data Jobid
components:
  schemas:
    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: '#/components/schemas/Error'
        innererror:
          $ref: '#/components/schemas/InnerError'
    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: '#/components/schemas/Error'
        traceId:
          description: Unique trace Id.
          type: string
    FarmOperationDataIngestionJob:
      description: Schema of farm operation data ingestion job.
      required:
      - authProviderId
      - partyId
      - startYear
      type: object
      properties:
        partyId:
          description: Party Id.
          minLength: 1
          type: string
        authProviderId:
          description: Authentication provider Id.
          minLength: 1
          type: string
        operations:
          description: 'List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.'
          type: array
          items:
            type: string
        startYear:
          format: int32
          description: Start Year (Minimum = 2000, Maximum = CurrentYear).
          type: integer
        isIncremental:
          description: Use this to pull only the incremental changes from the last run.
          default: false
          type: boolean
        id:
          description: Unique job id.
          type: string
          readOnly: true
        status:
          description: 'Status of the job.

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

            Each pair must not have a key greater than 50 characters

            and must not have a value greater than 150 characters.

            Note: A maximum of 25 key value pairs can be provided for a resource and only string,

            numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.'
          type: object
          additionalProperties: {}
          example:
            key1: value1
            key2: 123.45
    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: '#/components/schemas/InnerError'
    FarmOperationJobProviderInput:
      description: Schema for provider input for Farm operations job.
      required:
      - shapeResolution
      - shapeType
      type: object
      properties:
        shapeType:
          description: 'Type of shape file to be ingested from JohnDeere.

            Possible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.'
          minLength: 1
          enum:
          - Point
          - Polygon
          - None
          type: string
          x-ms-enum:
            name: ShapeType
            modelAsString: true
        shapeResolution:
          description: 'Resolution of shape file to be ingested from JohnDeere.

            Possible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.'
          minLength: 1
          enum:
          - EachSection
          - EachSensor
          - OneHertz
          - None
          type: string
          x-ms-enum:
            name: ShapeResolution
            modelAsString: true
    FarmOperationDataIngestionJob_2:
      description: Schema of farm operation data ingestion job.
      required:
      - authProviderId
      - partyId
      - providerInput
      - startYear
      type: object
      properties:
        partyId:
          description: Party Id.
          minLength: 1
          type: string
        authProviderId:
          description: Authentication provider Id.
          minLength: 1
          type: string
        operations:
          description: 'List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.'
          type: array
          items:
            type: string
        startYear:
          format: int32
          description: Start Year (Minimum = 2000, Maximum = CurrentYear).
          type: integer
        isIncremental:
          description: Use this to pull only the incremental changes from the last run.
          default: false
          type: boolean
        providerInput:
          $ref: '#/components/schemas/FarmOperationJobProviderInput'
        id:
          description: Unique job id.
          type: string
          readOnly: true
        status:
          description: 'Status of the job.

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

            Each pair must not have a key greater than 50 characters

            and must not have a value greater than 150 characters.

            Note: A maximum of 25 key value pairs can be provided for a resource and only string,

            numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.'
          type: object
          additionalProperties: {}
          example:
            key1: value1
            key2: 123.45
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.
x-refined-from:
- azure-agfoodplatform-data-plane-service-openapi-original.yml
- microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'