- Data Service OpenAPI
- Obtener el registro de entidad por ID
- Obtener registros de entidad
- Consultar los registros de la entidad
- Eliminar registro de entidad por ID
- Actualizar registro de entidad por ID
- Crear registro de entidad
- Crear varios registros de entidad
- Actualizar varios registros de entidad
- Eliminar varios registros de entidad
- Descargar archivo desde el Campo de registro
- Cargar archivo en el campo de registro
- Eliminar el archivo desde el campo de registro
Consultar los registros de la entidad
Consulta los registros de la entidad.
Encabezado |
Valor |
---|---|
Autorización |
Bearer
<access_token> |
Tipo de contenido |
application/json |
<...>
con sus valores de caso de uso correspondientes.
<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ámetro de consulta |
Tipo de datos |
Descripción |
Valor predeterminado |
---|---|---|---|
ExpansionLevel (opcional) |
|
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 |
{
"selectedFields": [
"string"
],
"filterGroup": {
"logicalOperator": 0,
"queryFilters": [
{
"fieldName": "string",
"operator": "string",
"value": "string"
}
],
"filterGroups": [
null
]
},
"start": 0,
"limit": 0,
"sortOptions": [
{
"fieldName": "string",
"isDescending": true
}
]
}
{
"selectedFields": [
"string"
],
"filterGroup": {
"logicalOperator": 0,
"queryFilters": [
{
"fieldName": "string",
"operator": "string",
"value": "string"
}
],
"filterGroups": [
null
]
},
"start": 0,
"limit": 0,
"sortOptions": [
{
"fieldName": "string",
"isDescending": true
}
]
}
query
tiene los siguientes componentes:
selectedFields
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:
- OperadorLógico : esta es una propiedad GrupoDeFiltro opcional, de tipo
int32
. Especifica si se aplican a la consulta todos los filtros y grupos de filtros. Usa0
para aplicar todos los filtros y grupos de filtros. Utiliza1
para aplicar cualquiera de los filtros y grupos de filtros. El valor predeterminado es0
. -
FiltroDeConsulta : esta es una propiedad GrupoDeFiltro obligatoria que te ayuda a definir la expresión de filtrado. Tiene las siguientes propiedades:
Propiedad QueryFilter
Tipo de datos
Descripción
fieldName
string
Especifica el nombre del campo que se va a filtrar.
operator
string
Especifica el operador de filtro. Compatible con lo siguiente:
contains
,not contains
,startswith
,endswith
,=
,!=
,>
,<
,>=
,<=
,in
,not in
. Utilice el operador adecuado para el tipo de campo correspondiente.valor
string
Especifica el valor de filtrado.
- filterGroups : esta es una propiedad opcional filterGroup , en caso de que necesites establecer otra opción de filtrado para la consulta. Contiene todas las propiedades de filterGroup enumeradas anteriormente.
Iniciar
int32
. Especifica el número de registros que se deben omitir antes de recuperar los registros de la consulta. Se puede usar junto con la propiedad limit para implementar la paginación. Los registros están ordenados de forma ascendente por sus ID. Para modificar el orden de clasificación, utiliza la propiedad sortOptions . El valor predeterminado es 0
.
limit
int32
. Especifica el número máximo de registros que se leerán de la entidad. Se puede utilizar junto con la propiedad de inicio para implementar la paginación. El valor predeterminado es 100
y el valor máximo es 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:
- NombreDeCampo : esta es una propiedad de OpcionesDeOrganización obligatoria, de tipo
string
. Especifica el nombre del campo utilizado para ordenar los registros. El nombre debe corresponder a un campo válido y distingue entre mayúsculas y minúsculas. - isDescending : esta es una propiedad opcional de sortOptions , de tipo
boolean
. Establézcalo comotrue
si desea ordenar los registros de forma descendente. El valor predeterminado esfalse
.
{
"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"
}
]
}
{
"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"
}
]
}
query
tiene los siguientes componentes:
- totalRecordCount : el número total de registros que coinciden con los filtros de consulta especificados.
- valor : una matriz de registros de entidad que coinciden con los filtros de consulta especificados, limitados por la propiedad de límite .
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.