SoilOptix Analyses - Read API

openapi: 3.2.0
info:
  title: SoilOptix Client Analyses - Read API
  version: '1.0'
  description: Service to retrieve data from SoilOptix Db for Clients portal
  termsOfService: https://soiloptix.com/terms-of-service/
  contact:
    name: Get Help with this API
    url: http://www.soiloptix.com
    email: dev@soiloptix.com
    copyright: SoilOptix 2022-2025
tags:
- name: Analyses - Read
  description: View general information about an Analysis and the available Models. A Model represents a soil property, such as Sand, Silt, or Clay. Exports provides a number of standard export formats for your convenience.
paths:
  /api/v4/analyses/:
    get:
      tags:
      - Analyses - Read
      summary: Work with data related to your field analyses
      operationId: get_analyses_api_v4_analyses__get
      security:
      - Authorization: []
      parameters:
      - name: filterByField
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: Limit results to Analyses found under this Field Id
          title: Filterbyfield
        description: Limit results to Analyses found under this Field Id
      - name: filterByFarm
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: Limit results to Analyses found under this Farm Id
          title: Filterbyfarm
        description: Limit results to Analyses found under this Farm Id
      - name: filterByBusinessRecursive
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: Limit results to Analyses found under this Business Id and it's child businesses
          title: Filterbybusinessrecursive
        description: Limit results to Analyses found under this Business Id and it's child businesses
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/AnalysisRelationEnum'
          description: Include additional relations to the entity
          default: []
          title: Include
        description: Include additional relations to the entity
      - name: sortBy
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/AnalysisSortByEnum'
      - name: searchName
        in: query
        required: false
        schema:
          type: string
          maxLength: 128
          default: ''
          title: Searchname
      - name: beforeDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Return data before this date (YYYY-MM-DD)
          title: Beforedate
        description: Return data before this date (YYYY-MM-DD)
      - name: afterDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Return data after this date (YYYY-MM-DD)
          title: Afterdate
        description: Return data after this date (YYYY-MM-DD)
      - name: createdBefore
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter analyses created before this date (YYYY-MM-DD)
          title: Createdbefore
        description: Filter analyses created before this date (YYYY-MM-DD)
      - name: createdAfter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter analyses created after this date (YYYY-MM-DD)
          title: Createdafter
        description: Filter analyses created after this date (YYYY-MM-DD)
      - name: returnActiveOnly
        in: query
        required: false
        schema:
          type: boolean
          description: Return only active analyses
          default: false
          title: Returnactiveonly
        description: Return only active analyses
      - name: status
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/AnalysisStatusEnum'
          description: Filter analyses by Status
        description: Filter analyses by Status
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: Page size
          default: 5
          title: Limit
        description: Page size
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Current page, starts from 0
          default: 0
          title: Page
        description: Current page, starts from 0
      - name: sortAsc
        in: query
        required: false
        schema:
          type: boolean
          description: Sort direction, ascending if true
          default: true
          title: Sortasc
        description: Sort direction, ascending if true
      - name: returnEnum
        in: query
        required: false
        schema:
          type: boolean
          description: Return short entity version, containing only Id and Name
          default: false
          title: Returnenum
        description: Return short entity version, containing only Id and Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  anyOf:
                  - $ref: '#/components/schemas/Analysis'
                  - $ref: '#/components/schemas/EnumEntity'
                title: Response Get Analyses Api V4 Analyses  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}:
    get:
      tags:
      - Analyses - Read
      summary: Work with data related to your field analysis
      operationId: get_analysis_by_id_api_v4_analyses__analysis_id__get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/AnalysisRelationEnum'
          default: []
          title: Include
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Analysis'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/models/:
    get:
      tags:
      - Analyses - Read
      summary: Work with data related to your field's analyses' models
      operationId: get_analysis_models_api_v4_analyses__analysis_id__models__get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  anyOf:
                  - $ref: '#/components/schemas/Model'
                  - $ref: '#/components/schemas/EnumEntity'
                title: Response Get Analysis Models Api V4 Analyses  Analysis Id  Models  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/models/{model_id}/geojson:
    get:
      tags:
      - Analyses - Read
      summary: Get field's analyses' models' heatmap
      operationId: get_analysis_model_regression_heatmap_api_v4_analyses__analysis_id__models__model_id__geojson_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      - name: model_id
        in: path
        required: true
        schema:
          type: integer
          title: Model Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/samplePoints:
    get:
      tags:
      - Analyses - Read
      summary: Get Sample Point Locations by Analysis Id
      description: Effectively the same as downloading activity points csv and getting the values from there
      operationId: get_sample_point_locations_by_analysis_id_api_v4_analyses__analysis_id__samplePoints_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Records'
                title: Response Get Sample Point Locations By Analysis Id Api V4 Analyses  Analysis Id  Samplepoints Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/:
    get:
      tags:
      - Analyses - Read
      summary: Get list of available exports for an analysis
      operationId: get_analysis_exports_api_v4_analyses__analysis_id__exports__get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                title: Response Get Analysis Exports Api V4 Analyses  Analysis Id  Exports  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/csv:
    get:
      tags:
      - Analyses - Read
      summary: Download model data in .csv format
      operationId: get_regression_csv_api_v4_analyses__analysis_id__exports_csv_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/shp:
    get:
      tags:
      - Analyses - Read
      summary: Download Shapefile(.shp) export
      operationId: get_shp_export_api_v4_analyses__analysis_id__exports_shp_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/pdf:
    get:
      tags:
      - Analyses - Read
      summary: Download PDF(.pdf) export
      operationId: get_pdf_export_api_v4_analyses__analysis_id__exports_pdf_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/tif:
    get:
      tags:
      - Analyses - Read
      summary: Download TIF exports in .zip format
      operationId: get_tif_zip_export_api_v4_analyses__analysis_id__exports_tif_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/lab:
    get:
      tags:
      - Analyses - Read
      summary: Get Sample Points export in .csv format
      operationId: get_sample_points_export_api_v4_analyses__analysis_id__exports_lab_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/analyses/{analysis_id}/exports/bnd:
    get:
      tags:
      - Analyses - Read
      summary: Get Boundary export
      operationId: export_boundary_by_id_api_v4_analyses__analysis_id__exports_bnd_get
      security:
      - Authorization: []
      parameters:
      - name: analysis_id
        in: path
        required: true
        schema:
          type: integer
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Export Boundary By Id Api V4 Analyses  Analysis Id  Exports Bnd Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CustomerBusinessRelationship:
      properties:
        Id:
          type: integer
          title: Id
        Name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        Email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        BusinessTypeId:
          type: integer
          title: Businesstypeid
          default: 1
        IsAdmin:
          type: boolean
          title: Isadmin
          default: false
        IsSubscribed:
          type: boolean
          title: Issubscribed
          default: false
      type: object
      required:
      - Id
      title: CustomerBusinessRelationship
    AnalysisStatusEnum:
      type: string
      enum:
      - NotSubmitted
      - ReviewNeeded
      - Processing
      - PartiallyPublished
      - FullyPublished
      title: AnalysisStatusEnum
    AnalysisSortByEnum:
      type: string
      enum:
      - Id
      - Name
      - AreaSquareM
      - StatusId
      - LastUpdated
      - CreatedOn
      title: AnalysisSortByEnum
    Invite:
      properties:
        Id:
          type: integer
          title: Id
        Email:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
        InvitedAsAdmin:
          type: boolean
          title: Invitedasadmin
        Business:
          $ref: '#/components/schemas/BusinessPublic'
      type: object
      required:
      - Id
      - InvitedAsAdmin
      title: Invite
    Model:
      properties:
        Id:
          type: integer
          title: Id
        Name:
          type: string
          title: Name
        Resolution:
          type: number
          title: Resolution
        PublishedDate:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Publisheddate
      type: object
      required:
      - Id
      - Name
      - Resolution
      - PublishedDate
      title: Model
    BusinessPublic:
      properties:
        Name:
          type: string
          title: Name
        ContactName:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactname
        ContactEmail:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactemail
        Phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        Address:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Address
        City:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: City
        PostalCode:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Postalcode
        ProvinceState:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Provincestate
        CountryId:
          type: integer
          title: Countryid
        BusinessTypeId:
          type: integer
          title: Businesstypeid
          default: 1
        Id:
          type: integer
          title: Id
      type: object
      required:
      - Name
      - CountryId
      - Id
      title: BusinessPublic
    AnalysisPackage:
      properties:
        PackageId:
          type: integer
          title: Packageid
        PackageName:
          type: string
          title: Packagename
        IsSelected:
          type: boolean
          title: Isselected
      type: object
      required:
      - PackageId
      - PackageName
      - IsSelected
      title: AnalysisPackage
    Analysis:
      properties:
        Name:
          type: string
          title: Name
        FieldId:
          type: integer
          title: Fieldid
        Id:
          type: integer
          title: Id
        LastUpdated:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Lastupdated
        CreatedOn:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdon
        AreaSquareM:
          anyOf:
          - type: number
          - type: 'null'
          title: Areasquarem
        IsActive:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Isactive
        Resample:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Resample
        Business:
          anyOf:
          - $ref: '#/components/schemas/Business'
          - type: 'null'
        Farm:
          anyOf:
          - $ref: '#/components/schemas/Farm'
          - type: 'null'
        Field:
          anyOf:
          - $ref: '#/components/schemas/Field'
          - type: 'null'
        Models:
          items:
            $ref: '#/components/schemas/Model'
          type: array
          title: Models
        Boundary:
          anyOf:
          - type: string
          - type: 'null'
          title: Boundary
        Status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        Packages:
          anyOf:
          - items:
              $ref: '#/components/schemas/AnalysisPackage'
            type: array
          - type: 'null'
          title: Packages
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
        CanModifyBillable:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodifybillable
      type: object
      required:
      - Name
      - FieldId
      - Id
      title: Analysis
    Records:
      properties:
        Row:
          type: integer
          title: Row
        WKT:
          type: string
          title: Wkt
      type: object
      required:
      - Row
      - WKT
      title: Records
    Farm:
      properties:
        Name:
          type: string
          title: Name
        CountryId:
          type: integer
          title: Countryid
        BusinessId:
          type: integer
          title: Businessid
        Id:
          type: integer
          title: Id
        CreatedOn:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdon
        Business:
          anyOf:
          - $ref: '#/components/schemas/Business'
          - type: 'null'
        Fields:
          anyOf:
          - items:
              $ref: '#/components/schemas/Field'
            type: array
          - type: 'null'
          title: Fields
        Country:
          anyOf:
          - $ref: '#/components/schemas/EnumEntity'
          - type: 'null'
        Area:
          type: number
          title: Area
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
      type: object
      required:
      - Name
      - CountryId
      - BusinessId
      - Id
      title: Farm
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Field:
      properties:
        Name:
          type: string
          title: Name
        CountryId:
          type: integer
          title: Countryid
        FarmId:
          type: integer
          title: Farmid
        Id:
          type: integer
          title: Id
        CreatedOn:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdon
        Farm:
          anyOf:
          - $ref: '#/components/schemas/Farm'
          - type: 'null'
        Business:
          anyOf:
          - $ref: '#/components/schemas/Business'
          - type: 'null'
        Country:
          anyOf:
          - $ref: '#/components/schemas/EnumEntity'
          - type: 'null'
        Analyses:
          items:
            $ref: '#/components/schemas/Analysis'
          type: array
          title: Analyses
        Boundary:
          anyOf:
          - type: string
          - type: 'null'
          title: Boundary
        Status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
      type: object
      required:
      - Name
      - CountryId
      - FarmId
      - Id
      title: Field
    EnumEntity:
      properties:
        Id:
          type: integer
          title: Id
        Name:
          type: string
          title: Name
      type: object
      required:
      - Id
      - Name
      title: EnumEntity
    AnalysisRelationEnum:
      type: string
      enum:
      - Business
      - Farm
      - Field
      - Models
      - Status
      - Packages
      - Boundary
      title: AnalysisRelationEnum
    Business:
      properties:
        Name:
          type: string
          title: Name
        ContactName:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactname
        ContactEmail:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactemail
        Phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        Address:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Address
        City:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: City
        PostalCode:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Postalcode
        ProvinceState:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Provincestate
        CountryId:
          type: integer
          title: Countryid
        BusinessTypeId:
          type: integer
          title: Businesstypeid
          default: 1
        Id:
          type: integer
          title: Id
        ParentBusinesses:
          anyOf:
          - items:
              $ref: '#/components/schemas/BusinessPublic'
            type: array
          - type: 'null'
          title: Parentbusinesses
        Customers:
          anyOf:
          - items:
              $ref: '#/components/schemas/CustomerBusinessRelationship'
            type: array
          - type: 'null'
          title: Customers
        Invites:
          anyOf:
          - items:
              $ref: '#/components/schemas/Invite'
            type: array
          - type: 'null'
          title: Invites
        Farms:
          anyOf:
          - items:
              $ref: '#/components/schemas/Farm'
            type: array
          - type: 'null'
          title: Farms
        Country:
          anyOf:
          - $ref: '#/components/schemas/EnumEntity'
          - type: 'null'
        ChildBusinesses:
          anyOf:
          - items:
              $ref: '#/components/schemas/BusinessPublic'
            type: array
          - type: 'null'
          title: Childbusinesses
        ContractId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Contractid
        ZCTTemplates:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Zcttemplates
        CreatedOn:
          type: string
          format: date-time
          title: Createdon
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
      type: object
      required:
      - Name
      - CountryId
      - Id
      - CreatedOn
      title: Business
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer