- 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
Referencia de la API para recuperar un único registro de entidad por ID en Data Service, con la URL del punto final, los parámetros de ruta y las cargas útiles de ejemplo.
Recupera un solo registro de entidad por ID.
Punto final de API
![]()
BaseURL/EntityService/<Entity>/read/{id}
- URLBase:
https://{yourDomain}/{organizationName}/{tenantName}/dataservice_
Solicitar encabezados.
| Encabezado | Valor |
|---|---|
| Autorización | Portador <access_token> |
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.
Variables de ruta
| Variable de ruta | Tipo de datos | Descripción | Valor predeterminado |
|---|---|---|---|
| ID (obligatorio) | string | El ID del registro de la entidad que desea recuperar de Data Service. | N/A |
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 |
Respuesta
200 OK
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:20:24.485Z",
"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:24.485Z"
}
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:20:24.485Z",
"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:24.485Z"
}
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.