Microsoft Azure ChemicalProducts API

openapi: 3.2.0
info:
  title: Microsoft Azure Data Manager for Agriculture Data Plane…
  description: APIs documentation for Microsoft Azure Data Manager for Agriculture DataPlane Service.
  version: 2023-11-01-preview
security:
- Bearer: []
tags:
- name: ChemicalProducts
paths:
  /chemical-products:
    get:
      tags:
      - ChemicalProducts
      description: Returns a paginated list of chemical product resources.
      operationId: microsoftAzureChemicalproductsList
      parameters:
      - in: query
        name: cropIds
        description: CropIds of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: brands
        description: Brands of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: products
        description: Products of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: types
        description: Types of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: states
        description: States of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: activeIngredients
        description: ActiveIngredients of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: specificGravity
        description: SpecificGravity of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: formulation
        description: Formulation of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: registrationNumber
        description: RegistrationNumber of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: minReEntryInterval
        description: Min ReEntryInterval of chemical product.
        schema:
          type: integer
          format: int32
      - in: query
        name: maxReEntryInterval
        description: Max ReEntryInterval of chemical product.
        schema:
          type: integer
          format: int32
      - in: query
        name: locations
        description: Locations of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: companyNames
        description: Company names of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: datasetIds
        description: Reference dataset id of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: referenceRecordIds
        description: Reference record id of chemical product.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: ids
        description: Ids of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: names
        description: Names of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: propertyFilters
        description: 'Filters on key-value pairs within the Properties object.

          eg. "{testKey} eq {testValue}".'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: statuses
        description: Statuses of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxPageSize
        description: 'Maximum number of items needed (inclusive).

          Minimum = 10, Maximum = 1000, Default value = 50.'
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        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/ChemicalProductListResponse'
        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-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ChemicalProducts_List:
          $ref: ./examples/ChemicalProducts_List.json
      summary: Microsoft Azure Get Chemical Products
  /chemical-products/{chemicalProductId}:
    get:
      tags:
      - ChemicalProducts
      description: Gets a specified chemicalProduct resource.
      operationId: microsoftAzureChemicalproductsGet
      parameters:
      - in: path
        name: chemicalProductId
        description: Id of the chemicalProduct.
        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/ChemicalProduct'
        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:
        ChemicalProducts_Get:
          $ref: ./examples/ChemicalProducts_Get.json
      summary: Microsoft Azure Get Chemical Products Chemicalproductid
    patch:
      tags:
      - ChemicalProducts
      description: Creates or updates a chemicalProduct resource.
      operationId: microsoftAzureChemicalproductsCreateorupdate
      parameters:
      - in: path
        name: chemicalProductId
        description: Id of the chemicalProduct resource.
        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/ChemicalProduct'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChemicalProduct'
        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:
        ChemicalProducts_CreateOrUpdate:
          $ref: ./examples/ChemicalProducts_CreateOrUpdate.json
      summary: Microsoft Azure Patch Chemical Products Chemicalproductid
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/ChemicalProduct'
        description: ChemicalProduct resource payload to create or update.
        required: true
    delete:
      tags:
      - ChemicalProducts
      description: Deletes dataset for given chemicalProduct id.
      operationId: microsoftAzureChemicalproductsDelete
      parameters:
      - in: path
        name: chemicalProductId
        description: Id of chemicalProduct to be deleted.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        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:
        ChemicalProducts_Delete:
          $ref: ./examples/ChemicalProducts_Delete.json
      summary: Microsoft Azure Delete Chemical Products Chemicalproductid
components:
  schemas:
    Company:
      description: Company/Manufacturer's details.
      type: object
      properties:
        name:
          description: Name of the manufacturing company.
          type: string
        description:
          description: Manufacturing Company description.
          type: string
        registrationNumber:
          description: Registration number of the company.
          type: string
    Reference:
      description: Reference to a dataset record.
      type: object
      properties:
        datasetId:
          description: Dataset id.
          maxLength: 100
          minLength: 0
          type: string
        recordId:
          description: Record id.
          maxLength: 100
          minLength: 0
          type: string
    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'
    ChemicalProduct:
      description: Schema of ChemicalProduct resource.
      type: object
      properties:
        cropIds:
          description: 'The Ids of the crops associated with the Chemical product.

            Note: A maximum of 25 crops can be associated with a cropProduct.'
          uniqueItems: true
          type: array
          items:
            type: string
        reference:
          $ref: '#/components/schemas/Reference'
        brand:
          description: Commercial brand of the chemical product.
          type: string
        product:
          description: Commercial product name of the chemical product.
          type: string
        type:
          description: Herbicide, Additive, Insecticides, Fertilizers.
          type: string
        state:
          description: Liquid/non Liquid.
          type: string
        activeIngredients:
          description: Active chemicals in the formulation.
          type: array
          items:
            type: string
        specificGravity:
          description: Specific gravity details.
          type: string
        formulation:
          description: 'Formulation description. Percentage or other unit of N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL

            (based on the source, the available chemical elements can vary, but this is a typical list).'
          type: string
        company:
          $ref: '#/components/schemas/Company'
        location:
          description: Area where the chemical is used. This is important from a compliance perspective.
          type: string
        registrationNumber:
          description: Registration number of the chemical. This could vary by geography.
          type: string
        reEntryInterval:
          format: int32
          description: The number of days after which a person can visit the field after the chemical product is applied.
          type: integer
        id:
          description: Unique resource ID.
          type: string
          readOnly: true
        eTag:
          description: The ETag value to implement optimistic concurrency.
          type: string
          readOnly: true
        status:
          description: Status of the resource.
          maxLength: 100
          minLength: 0
          type: string
        createdDateTime:
          format: date-time
          description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
          example: '2020-12-31T11:10:21Z'
        modifiedDateTime:
          format: date-time
          description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
          example: '2020-12-31T11:10:21Z'
        source:
          description: Source of the resource.
          maxLength: 100
          minLength: 2
          type: string
        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'
    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
    ChemicalProductListResponse:
      description: Paged response contains list of requested objects and a skipToken to get the next set of results.
      required:
      - value
      type: object
      properties:
        value:
          description: List of requested objects.
          type: array
          items:
            $ref: '#/components/schemas/ChemicalProduct'
        skipToken:
          description: Token used in retrieving the next page. If null, there are no additional pages.
          type: string
        nextLink:
          description: Continuation link (absolute URI) to the next page of results in the list.
          type: string
  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-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true