Management Zones - List By Farmer Id

Служба:: Azure Data Manager for Agriculture

Версия API:: 2021-07-31-preview

Возвращает список ресурсов зоны управления с разбивкой на страницы в рамках конкретного фермера.

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview

С использованием необязательных параметров:

GET /farmers/{farmerId}/management-zones?types={types}&cropIds={cropIds}&seasonIds={seasonIds}&fieldIds={fieldIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
farmerId	path	True	string	Идентификатор связанного фермера.
api-version	query	True	string	Запрошенная версия API
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Максимальное количество необходимых элементов (включительно). Minimum = 10, Maximum = 1000, Значение по умолчанию = 50.
$skipToken	query		string	Пропустите маркер получения следующего набора результатов.
cropIds	query		string[]	Обрезки объекта ManagementZone.
fieldIds	query		string[]	FieldIds в ManagementZone.
ids	query		string[]	Идентификаторы ресурса.
maxCreatedDateTime	query		string (date-time)	Максимальная дата создания ресурса (включительно).
maxLastModifiedDateTime	query		string (date-time)	Максимальная дата последнего изменения ресурса (включительно).
minCreatedDateTime	query		string (date-time)	Минимальная дата создания ресурса (включительно).
minLastModifiedDateTime	query		string (date-time)	Минимальная дата последнего изменения ресурса (включительно).
names	query		string[]	Имена ресурса.
propertyFilters	query		string[]	Фильтрует пары "ключ-значение" в объекте Properties. Например. "{testKey} eq {testValue}".
seasonIds	query		string[]	SeasonIds из ManagementZone.
sources	query		string[]	Источники ManagementZone.
statuses	query		string[]	Состояния ресурса.
types	query		string[]	Типы ManagementZone.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Ответы

Имя	Тип	Описание
200 OK	ManagementZoneListResponse	Успех
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

ManagementZoneListResponse

Успех

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

Безопасность

Authorization

Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Тип: apiKey
В: header

Примеры

ManagementZones_ListByFarmerId

Образец запроса

HTTP

GET /farmers/FARMER123/management-zones?api-version=2021-07-31-preview

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "farmerId": "FARMER123",
      "id": "ManagementZone123",
      "type": "Nutrient rich",
      "seasonId": "Season123",
      "cropId": "Crop123",
      "fieldId": "Field123",
      "source": "Agronomist",
      "name": "John Smith's ManagementZone",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "$skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/management-zones?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"
}

Определения

Имя	Описание
Error	Ошибка из службы Azure AgPlatform.
ErrorResponse	Ответ об ошибке службы Azure AgPlatform. <см. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Справочный документ ErrorResponse.</см>.
InnerError	Внутренняя ошибка, содержащая список ошибок. <см. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Справочный документ< InnerError.>
ManagementZone	Объект Api Model для ManagementZone.
ManagementZoneListResponse	Ответ paged содержит список запрошенных объектов и URL-ссылку, чтобы получить следующий набор результатов.

Error

Object

Ошибка из службы Azure AgPlatform.

Имя	Тип	Описание
code	string	Определяемый сервером набор кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. <см. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Справочный документ< InnerError.>
message	string	Читаемое человеком представление ошибки.
target	string	Цель ошибки.

ErrorResponse

Object

Ответ об ошибке службы Azure AgPlatform. <см. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Справочный документ ErrorResponse.</см>.

Имя	Тип	Описание
error	Error	Ошибка из службы Azure AgPlatform.
traceId	string	Уникальный идентификатор трассировки.

InnerError

Object

Внутренняя ошибка, содержащая список ошибок. <см. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Справочный документ< InnerError.>

Имя	Тип	Описание
code	string	Определенный код ошибки, чем был предоставлен содержащей ошибкой.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. <см. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Справочный документ< InnerError.>

ManagementZone

Object

Объект Api Model для ManagementZone.

Имя	Тип	Описание
createdDateTime	string (date-time)	Дата создания ресурса, пример формата: гггг-ММ-ддTHH:мм:ssZ.
cropId	string	Идентификатор обрезки, связанный с ManagementZone.
description	string minLength: 0 maxLength: 500	Текстовое описание ресурса.
eTag	string	Значение ETag для реализации оптимистического параллелизма.
farmerId	string	Идентификатор фермера, связанный с ManagementZone.
fieldId	string	Идентификатор поля, связанный с ManagementZone.
id	string	Уникальный идентификатор ресурса.
modifiedDateTime	string (date-time)	Дата и время последнего изменения ресурса: формат yy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Имя для идентификации ресурса.
properties		Коллекция пар значений ключей, принадлежащих ресурсу. Каждая пара не должна иметь ключ больше 50 символов и не должна иметь значение больше 150 символов. Примечание. Поддерживаются не более 25 пар значений ключей для ресурса и только строк, числовых и датовых значений (гггг-ММ-ддTHH:мм:ssZ).
seasonId	string	Идентификатор сезона, связанный с ManagementZone.
source	string minLength: 2 maxLength: 100	Источник ресурса.
status	string minLength: 0 maxLength: 100	Состояние ресурса.
type	string minLength: 0 maxLength: 100	Тип ManagementZone.

ManagementZoneListResponse

Object

Ответ paged содержит список запрошенных объектов и URL-ссылку, чтобы получить следующий набор результатов.

Имя	Тип	Описание
$skipToken	string	Маркер, используемый при получении следующей страницы. Если значение NULL, дополнительные страницы отсутствуют.
nextLink	string	Ссылка на продолжение (абсолютный URI) на следующую страницу результатов в списке.
value	ManagementZone[]	Список запрошенных объектов.

Поделиться через

Management Zones - List By Farmer Id

Параметры URI

Заголовок запроса

Ответы

Безопасность

Authorization

Примеры

ManagementZones_ListByFarmerId

Образец запроса

Пример ответа

Определения

Error

ErrorResponse

InnerError

ManagementZone

ManagementZoneListResponse