다음을 통해 공유


Chemical Products - List

페이지를 매긴 화학 제품 리소스 목록을 반환합니다.

GET {endpoint}/chemical-products?api-version=2023-11-01-preview
GET {endpoint}/chemical-products?cropIds={cropIds}&brands={brands}&products={products}&types={types}&states={states}&activeIngredients={activeIngredients}&specificGravity={specificGravity}&formulation={formulation}&registrationNumber={registrationNumber}&minReEntryInterval={minReEntryInterval}&maxReEntryInterval={maxReEntryInterval}&locations={locations}&companyNames={companyNames}&datasetIds={datasetIds}&referenceRecordIds={referenceRecordIds}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
path True

string

uri

네임스페이스의 호스트 이름(예: admaInstanceName.farmbeats.azure.net

api-version
query True

string

요청된 API 버전

activeIngredients
query

string[]

화학 제품의 ActiveIngredients.

brands
query

string[]

화학 제품의 브랜드.

companyNames
query

string[]

화학 제품의 회사 이름입니다.

cropIds
query

string[]

화학 제품의 CropIds.

datasetIds
query

string[]

화학 제품의 참조 데이터 세트 ID입니다.

formulation
query

string[]

화학 제품의 제제.

ids
query

string[]

리소스의 ID입니다.

locations
query

string[]

화학 제품의 위치.

maxCreatedDateTime
query

string

date-time

리소스의 최대 생성 날짜(포함)입니다.

maxLastModifiedDateTime
query

string

date-time

리소스의 마지막 수정 날짜(포함)입니다.

maxPageSize
query

integer

int32

필요한 최대 항목 수(포함)입니다. 최소 = 10, 최대 = 1000, 기본값 = 50.

maxReEntryInterval
query

integer

int32

화학 제품의 최대 ReEntryInterval입니다.

minCreatedDateTime
query

string

date-time

리소스의 최소 생성 날짜(포함)입니다.

minLastModifiedDateTime
query

string

date-time

마지막으로 수정한 리소스 날짜(포함)입니다.

minReEntryInterval
query

integer

int32

화학 제품의 Min ReEntryInterval.

names
query

string[]

리소스의 이름입니다.

products
query

string[]

화학 제품의 제품.

propertyFilters
query

string[]

Properties 개체 내의 키-값 쌍을 필터링합니다. 예: "{testKey} eq {testValue}".

referenceRecordIds
query

string[]

화학 제품의 참조 레코드 ID입니다.

registrationNumber
query

string[]

등록화학 제품의 등록 번호입니다.

skipToken
query

string

다음 결과 집합을 가져오기 위한 토큰을 건너뜁니다.

specificGravity
query

string[]

화학 제품의 특정 중력.

states
query

string[]

화학 제품의 상태.

statuses
query

string[]

리소스의 상태입니다.

types
query

string[]

화학 제품의 유형.

요청 헤더

Name 필수 형식 Description
Authorization True

string

권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

응답

Name 형식 Description
200 OK

ChemicalProductListResponse

성공

Other Status Codes

ErrorResponse

오류

헤더

x-ms-error-code: string

보안

Authorization

권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

형식: apiKey
In(다음 안에): header

예제

ChemicalProducts_List

샘플 요청

GET {endpoint}/chemical-products?api-version=2023-11-01-preview

샘플 응답

{
  "value": [
    {
      "id": "Chemical123",
      "cropIds": [
        "CropId"
      ],
      "reference": {
        "datasetId": "datasetId",
        "recordId": "recordId"
      },
      "brand": "Brand",
      "product": "AGTECH",
      "type": "Herbicide",
      "state": "Liquid",
      "activeIngredients": [
        "NO2"
      ],
      "specificGravity": "string",
      "formulation": "N, P, K",
      "company": {
        "name": "CompanyName",
        "description": "Agriculture Manufacturer",
        "registrationNumber": "1234"
      },
      "location": "US",
      "registrationNumber": "1234",
      "reEntryInterval": 5,
      "status": "Active",
      "source": "Manufacturer",
      "name": "Fertilizer1",
      "description": "string",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "modifiedBy": "00000000-0000-0000-0000-000000000000",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/chemical-products/{{chemicalProductId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

정의

Name Description
ChemicalProduct

ChemicalProduct 리소스의 스키마입니다.

ChemicalProductListResponse

페이징된 응답에는 요청된 개체 목록과 다음 결과 집합을 가져오는 skipToken이 포함됩니다.

Company

회사/제조업체의 세부 정보입니다.

Error

Azure AgPlatform 서비스의 오류입니다.

ErrorResponse

Azure AgPlatform 서비스의 오류 응답입니다. ErrorResponse 참조 문서를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Reference

데이터 세트 레코드에 대한 참조입니다.

ChemicalProduct

ChemicalProduct 리소스의 스키마입니다.

Name 형식 Description
activeIngredients

string[]

제형의 활성 화학 물질.

brand

string

화학 제품의 상용 브랜드.

company

Company

회사/제조업체의 세부 정보입니다.

createdBy

string

사용자/테넌트 ID로 생성됩니다.

createdDateTime

string

리소스가 생성된 날짜-시간입니다(샘플 형식: yyyy-MM-ddTHH:mm:ssZ).

cropIds

string[]

화학 제품과 관련된 작물의 ID입니다. 참고: 최대 25개 작물을 cropProduct와 연결할 수 있습니다.

description

string

리소스에 대한 텍스트 형식의 설명입니다.

eTag

string

낙관적 동시성을 구현하는 ETag 값입니다.

formulation

string

수식화 설명입니다. N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL의 백분율 또는 기타 단위(원본에 따라 사용 가능한 화학 요소는 다를 수 있지만 일반적인 목록입니다).

id

string

고유 리소스 ID입니다.

location

string

화학 물질이 사용되는 영역입니다. 이는 규정 준수 관점에서 중요합니다.

modifiedBy

string

사용자/테넌트 ID에 의해 수정되었습니다.

modifiedDateTime

string

리소스가 마지막으로 수정된 날짜-시간입니다(샘플 형식: yyyy-MM-ddTHH:mm:ssZ).

name

string

리소스를 식별하는 이름입니다.

product

string

화학 제품의 상용 제품 이름입니다.

properties

리소스에 속하는 키 값 쌍의 컬렉션입니다. 각 쌍에는 50자보다 큰 키가 없어야 하며 150자를 초과하는 값이 없어야 합니다. 참고: 리소스에 대해 최대 25개의 키 값 쌍을 제공할 수 있으며 문자열, 숫자 및 datetime(yyyy-MM-ddTHH:mm:ssZ) 값만 지원됩니다.

reEntryInterval

integer

화학 제품이 적용된 후 사람이 필드를 방문할 수 있는 일 수입니다.

reference

Reference

데이터 세트 레코드에 대한 참조입니다.

registrationNumber

string

화학 물질의 등록 번호입니다. 이는 지리에 따라 달라질 수 있습니다.

source

string

리소스의 원본입니다.

specificGravity

string

특정 중력 세부 정보.

state

string

Liquid/non Liquid.

status

string

리소스의 상태입니다.

type

string

제초제, 첨가제, 살충제, 비료.

ChemicalProductListResponse

페이징된 응답에는 요청된 개체 목록과 다음 결과 집합을 가져오는 skipToken이 포함됩니다.

Name 형식 Description
nextLink

string

목록에서 결과의 다음 페이지에 대한 연속 링크(절대 URI)입니다.

skipToken

string

다음 페이지를 검색하는 데 사용되는 토큰입니다. null이면 추가 페이지가 없습니다.

value

ChemicalProduct[]

요청된 개체 목록입니다.

Company

회사/제조업체의 세부 정보입니다.

Name 형식 Description
description

string

제조 회사 설명.

name

string

제조 회사의 이름입니다.

registrationNumber

string

회사의 등록 번호입니다.

Error

Azure AgPlatform 서비스의 오류입니다.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합입니다.

details

Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.

innererror

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

message

string

사람이 읽을 수 있는 오류 표현입니다.

target

string

오류의 대상입니다.

ErrorResponse

Azure AgPlatform 서비스의 오류 응답입니다. ErrorResponse 참조 문서를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name 형식 Description
error

Error

Azure AgPlatform 서비스의 오류입니다.

traceId

string

고유 추적 ID입니다.

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name 형식 Description
code

string

포함된 오류에서 제공한 것보다 구체적인 오류 코드입니다.

innererror

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Reference

데이터 세트 레코드에 대한 참조입니다.

Name 형식 Description
datasetId

string

데이터 세트 ID입니다.

recordId

string

레코드 ID입니다.