Consultar Registros de Entidade

Consulta registros de entidade.

Ponto de Extremidade da API

BaseURL/EntityService/<Entity>/query

• URL base: https://{yourDomain}/{organizationName}/{tenantName}/dataservice_

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <access_token>
Tipo de conteúdo	application/json

Observação:

Substitua todos os valores entre os colchetes angulares <...> por seus valores de caso de uso correspondentes.

O <access_token> é aquele que você recebeu quando autorizou o aplicativo externo. Ele fica disponível por 1 hora, então você precisa gerar um novo, ou solicitar um token de atualização.

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description	Valor padrão
Expansão (opcional)	int32	Especifica a profundidade dos registros relacionados a serem recuperados. O valor deste parâmetro pode ser 1, 2 ou 3.	2

Corpo da solicitação (obrigatório)

{
  "selectedFields": [
    "string"
  ],
  "filterGroup": {
    "logicalOperator": 0,
    "queryFilters": [
      {
        "fieldName": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "filterGroups": [
      null
    ]
  },
  "start": 0,
  "limit": 0,
  "sortOptions": [
    {
      "fieldName": "string",
      "isDescending": true
    }
  ]
}

Solicitar esquemas de corpo

O corpo da solicitação de endpoint query tem os seguintes componentes:

selectedFields

Este é um componente opcional, do tipo string. Especifica a lista dos campos a serem retornados para cada registro da consulta. Se deixado em branco ou se a lista de consulta estiver vazia, todos os campos de registro serão retornados. O valor padrão é null.

filterGroup

Este é um componente obrigatório que ajuda a definir as propriedades de filtragem para a consulta. Combina as seguintes propriedades:

• logicalOperator - This is an optional filterGroup property, of type int32. It specifies if all the filters and filter groups apply to the query. Use 0 to apply all the filters and filter groups. Use 1 to apply any of the filters and filter groups. Default value is 0.

• queryFilter - This is a required filterGroup property, that helps you define the filtering expression. It has the following properties:

  propriedade QueryFilter	Tipo de dados	Description
  fieldName	string	Especifica o nome do campo a ser filtrado.
  operator	string	Specifies the filter operator. Supports the following: contains, not contains, startswith, endswith, =, !=, >, <,>=, <=, in, not in. Use the adequate operator for the corresponding field type.
  Value	string	Especifica o valor de filtragem.

• filterGroups - This is an optional filterGroup property, in case you need to set another filtering option to the query. It contains all the filterGroup properties listed above.

Iniciar

This is an optional component, of type int32. Specifies the number of records to skip before retrieving the records from the query. Can be used together with the limit property to implement pagination. The records are ordered ascendingly by their IDs. To modify the sort order, use the sortOptions property. Default value is 0.

limit

This is an optional component, of type int32. It specifies the maximum number of records to be read from the entity. Can be used together with the start property to implement pagination. The default value is 100, and the maximum value is 1000.

sortOptions

Este é um componente opcional, que ajuda a classificar os registros consultados por uma lista de campos. Se deixados em branco, os registros serão classificados em ordem crescente por seus IDs. Combina as seguintes propriedades:

• fieldName - This is a required sortOptions property, of type string. It specifies the name of the field used to sort the records. The name must correspond to a valid field, and it is case-sensitive.
• isDescending - This is an optional sortOptions property, of type boolean. Set it to true if you want to sort the records descendingly. The default value is false.

Resposta

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:21:22.771Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:21:22.771Z"
    }
  ]
}

Esquema Corporal de Resposta

O corpo da resposta do endpoint query tem os seguintes componentes:

• totalRecordCount - The total number of records matching the specified query filters.
• value - An array of entity records matching the specified query filters, limited by limit property.

401 não autorizado

Você não tem autenticação para acessar o Data Service. Verifique se seu Assistente ou Robô está conectado a uma pasta moderna em sua conta.

403 Forbidden

Você não tem permissão para acessar a entidade, o campo ou o registro, ou está usando um tipo de robô incompatível. Ou entre em contato com o administrador para obter as permissões necessárias.