Parties - List

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Retorna uma lista paginada de recursos de terceiros.

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

Com parâmetros opcionais:

GET {endpoint}/parties?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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
api-version	query	True	string	A versão da API solicitada
ids	query		string[]	IDs do recurso.
maxCreatedDateTime	query		string (date-time)	Data máxima de criação do recurso (inclusive).
maxLastModifiedDateTime	query		string (date-time)	Data máxima da última modificação do recurso (inclusive).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50.
minCreatedDateTime	query		string (date-time)	Data mínima de criação do recurso (inclusive).
minLastModifiedDateTime	query		string (date-time)	Data mínima da última modificação do recurso (inclusive).
names	query		string[]	Nomes do recurso.
propertyFilters	query		string[]	Filtra os pares chave-valor dentro do objeto Properties. Eg. "{testKey} eq {testValue}".
skipToken	query		string	Ignore o token para obter o próximo conjunto de resultados.
statuses	query		string[]	Status do recurso.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Respostas

Nome	Tipo	Description
200 OK	PartyListResponse	Êxito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Parties_List

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "PARTY123",
      "name": "John Smith",
      "status": "Active",
      "description": "Some description",
      "source": "source",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "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}}?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"
}

Definições

Nome	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
Party	Esquema de recurso de parte.
PartyListResponse	A resposta paginada contém uma lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

Error

Objeto

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string minLength: 1	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
message	string minLength: 1	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Objeto

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Objeto

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Party

Objeto

Esquema de recurso de parte.

Nome	Tipo	Description
createdBy	string	Criado por ID de usuário/locatário.
createdDateTime	string (date-time)	Data/hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
id	string	ID de recurso exclusiva.
modifiedBy	string	Modificado pela ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
source	string minLength: 2 maxLength: 100	Origem do recurso.
status	string minLength: 0 maxLength: 100	Status do recurso.

PartyListResponse

Objeto

A resposta paginada contém uma lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

Nome	Tipo	Description
nextLink	string	Link de continuação (URI absoluto) para a próxima página de resultados na lista.
skipToken	string	Token usado na recuperação da próxima página. Se for nulo, não haverá páginas adicionais.
value	Party[]	Lista de objetos solicitados.