Consultar Registros de Entidade

Referência de API para consultar registros de entidade com condições de filtro no Data Service, com o URL do ponto de extremidade, parâmetros de solicitação e cargas de exemplo.

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
    }
  ]
}

Esquemas do corpo da solicitação

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:

• Lógica - Essa é uma propriedade opcional de GrupoDeFiltros , do tipo int32. Especifica se todos os filtros e grupos de filtros se aplicam à consulta. Use 0 para aplicar todos os filtros e grupos de filtros. Use 1 para aplicar qualquer um dos filtros e grupos de filtros. O valor padrão é 0.

• consultaFiltro - Essa é uma propriedade filtrarGrupo necessária, que ajuda você a definir a expressão de filtragem. Ele tem as seguintes propriedades:

  propriedade queryFilter	Tipo de dados	Description
  fieldName	string	Especifica o nome do campo a ser filtrado.
  operator	string	Especifica o operador do filtro. Suporta o seguinte: contains, not contains, startswith, endswith, =, !=, >, <,>=, <=, in, not in. Use o operador adequado para o tipo de campo correspondente.
  Value	string	Especifica o valor de filtragem.

• FilterGroups - Esta é uma propriedade opcional do FilterGroup , no caso de você precisar definir outra opção de filtragem para a consulta. Ele contém todas as propriedades FilterGroup listadas acima.

Iniciar

Esse é um componente opcional, do tipo int32. Especifica o número de registros a ignorar antes de recuperar os registros da consulta. Pode ser usado junto com a propriedade limit para implementar a paginação. Os registros são ordenados em ordem crescente por seus IDs. Para modificar a ordem de classificação, use a propriedade sortOptions . O valor padrão é 0.

limit

Esse é um componente opcional, do tipo int32. Especifica o número máximo de registros a serem lidos da entidade. Pode ser usado junto com a propriedade inicial para implementar a paginação. O valor padrão é 100 e o valor máximo é 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:

• NomeDoCampo - Essa é uma propriedade OpçõesDeClassificação obrigatória, do tipo string. Especifica o nome do campo usado para classificar os registros. O nome deve corresponder a um campo válido e diferencia maiúsculas de minúsculas.
• estáDescendente - Esta é uma propriedade opcional sortOptions , do tipo boolean. Defina-o como true se você quiser classificar os registros em ordem decrescente. O valor padrão é 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:

• ContagemDeRegistrostotal - O número total de registros correspondentes aos filtros de consulta especificados.
• valor - Uma matriz de registros de entidade correspondentes aos filtros de consulta especificados, limitados pela propriedade limit .

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.