Obter registros de entidade

Lista todos os registros de entidade.

Ponto de Extremidade da API

BaseURL/EntityService/<Entity>/read

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

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <access_token>

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
início (opcional)	int32	Especifica o número de registros a ignorar antes de recuperar os registros da consulta. Pode ser usado junto com o parâmetro limit para implementar a paginação. Os registros são ordenados em ordem crescente por seus IDs.	0
Limite (opcional)	int32	Especifica o número máximo de registros que serão lidos da entidade. Pode ser usado junto com o parâmetro inicial para implementar a paginação. O valor máximo é 1000.	100
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

Resposta

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:20:47.791Z",
      "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:20:47.791Z"
    }
  ]
}

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.