Microsoft Azure ChemicalProducts API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ChemicalProducts API
schemes:
- https
tags:
- name: ChemicalProducts
paths:
  /chemical-products:
    get:
      tags:
      - ChemicalProducts
      description: Returns a paginated list of chemical product resources.
      operationId: microsoftAzureChemicalproductsList
      produces:
      - application/json
      parameters:
      - in: query
        name: cropIds
        description: CropIds of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: brands
        description: Brands of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: products
        description: Products of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: types
        description: Types of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: states
        description: States of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: activeIngredients
        description: ActiveIngredients of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: specificGravity
        description: SpecificGravity of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: formulation
        description: Formulation of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: registrationNumber
        description: RegistrationNumber of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minReEntryInterval
        description: Min ReEntryInterval of chemical product.
        type: integer
        format: int32
      - in: query
        name: maxReEntryInterval
        description: Max ReEntryInterval of chemical product.
        type: integer
        format: int32
      - in: query
        name: locations
        description: Locations of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: companyNames
        description: Company names of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: datasetIds
        description: Reference dataset id of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: referenceRecordIds
        description: Reference record id of chemical product.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ChemicalProductListResponse'
        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-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
      produces:
      - application/json
      parameters:
      - in: path
        name: chemicalProductId
        description: Id of the chemicalProduct.
        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/ChemicalProduct'
        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:
        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
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: chemicalProductId
        description: Id of the chemicalProduct resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: chemicalProduct
        description: ChemicalProduct resource payload to create or update.
        required: true
        schema:
          $ref: '#/definitions/ChemicalProduct'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ChemicalProduct'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ChemicalProduct'
        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:
        ChemicalProducts_CreateOrUpdate:
          $ref: ./examples/ChemicalProducts_CreateOrUpdate.json
      summary: Microsoft Azure Patch Chemical Products Chemicalproductid
    delete:
      tags:
      - ChemicalProducts
      description: Deletes dataset for given chemicalProduct id.
      operationId: microsoftAzureChemicalproductsDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: chemicalProductId
        description: Id of chemicalProduct to be deleted.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        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:
        ChemicalProducts_Delete:
          $ref: ./examples/ChemicalProducts_Delete.json
      summary: Microsoft Azure Delete Chemical Products Chemicalproductid
definitions:
  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
  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
  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
  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: '#/definitions/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
  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'
  ChemicalProduct:
    description: Schema of ChemicalProduct resource.
    type: object
    properties:
      cropIds:
        description: "The Ids of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct."
        uniqueItems: true
        type: array
        items:
          type: string
      reference:
        $ref: '#/definitions/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\r\n(based on the source, the available chemical elements can vary, but this is a typical list)."
        type: string
      company:
        $ref: '#/definitions/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.\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
  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'