Consultar los registros de la entidad

Consulta los registros de la entidad.

Punto final de API

BaseURL/EntityService/<Entity>/query

• URLBase: https://{yourDomain}/{organizationName}/{tenantName}/dataservice_

Solicitar encabezados.

Encabezado	Valor
Autorización	Portador <access_token>
Tipo de contenido	application/json

Nota:

Reemplaza todos los valores entre corchetes angulares <...> con sus valores de caso de uso correspondientes.

El <access_token> es el que recibió cuando autorizó la aplicación externa. Está disponible durante 1 hora; luego debes generar uno nuevo o solicitar un token de actualización.

Parámetros de consulta

Parámetro de consulta	Tipo de datos	Descripción	Valor predeterminado
nivelDeExpansión (Opcional)	int32	Especifica la profundidad de los registros relacionados que se van a recuperar. El valor de este parámetro puede ser 1, 2 o 3.	2

Cuerpo de solicitud (requerido)

{
  "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 cuerpo

El cuerpo de la solicitud del punto final query tiene los siguientes componentes:

selectedFields

Este es un componente opcional, de tipo string. Especifica la lista de campos que se devolverán para cada registro de la consulta. Si se deja vacía o si la lista de consulta está vacía, se devuelven todos los campos de registros. El valor predeterminado es null.

GrupoDeFiltro

Este es un componente obligatorio que te ayuda a establecer las propiedades de filtrado para la consulta. Combina las siguientes propiedades:

• 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:

  Propiedad QueryFilter	Tipo de datos	Descripción
  fieldName	string	Especifica el nombre del campo que se va a filtrar.
  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.
  valor	string	Especifica el valor de filtrado.

• 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 es un componente opcional que te ayuda a ordenar los registros consultados por una lista de campos. Si se deja vacío, los registros se ordenan de forma ascendente por sus ID. Combina las siguientes propiedades:

• 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.

Respuesta

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 del cuerpo de respuesta

El cuerpo de respuesta del punto final query tiene los siguientes 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 No autorizado

No se ha autenticado para acceder a Data Service. Asegúrese de que su Asistente o Robot está conectado a una carpeta moderna en su cuenta.

403 Forbidden

No tiene permiso para acceder a la entidad, campo o registro, o está utilizando un tipo de robot no compatible. Póngase en contacto con su administrador para obtener los permisos necesarios.