Upnify API Docs
CRM · /sistema/documentos/:tk

Sistema

Documentos - Detalle

GET/sistema/documentos/:tk

Permite obtener el detalle de un documento específico.

Parámetros

NombreTipoValidaciónDescripción
tkDocumentoUUIDRequeridoCódigo token que identifica de forma única a un documento en el sistema.

Respuesta

NombreTipoDescripción
descripcionStringDescripción o título del registro de documento.
tieneProductosIntegerIndica si el documento se encuentra asociado a productos.
tkDocumentoUUIDCódigo token que identifica de forma única a un documento en el sistema.
compartirIntegerCódigo que indica si el documento se encuentra compartido.
fechaModificadoStringContiene un formato compuesto de fecha y hora, que indica la última vez que se modificó el documento.
verIntegerIndica si el usuario tiene permisos para visualizar el documento.
archivoStringAlmacena la ruta física del documento dentro el sistema.
cuerpoStringGuarda el contenido del documento, una imagen o xml.
amazonIntegerCódigo que indica si el documento se encuentra alojado en Amazon.
etiquetasStringContiene las etiquetas relacionadas al documento.
editarIntegerCódigo que indica si el documento puede editarse.
tipoArchivoIntegerContiene un código que indica que tipo de documento está almacenado.
documentosIntegerCódigo que indica si existen documentos asociados.
imagenesIntegerCódigo que indica si existen imágenes asociados.
plantillasIntegerCódigo que indica si existen plantillas asociados.
urlFijaStringLa ruta o dirección URL que corresponde al documento alojado en Amazon.
previewIntegerCódigo que indica si el tipo de docuemento puede ser previsualizado.
esImagenIntegerCódigo que indica si el tipo de documento es una imagen.
esPdfIntegerCódigo que indica si el tipo de documento es un pdf.
esTxtIntegerCódigo que indica si el tipo de documento es un archivo txt.
esZipIntegerCódigo que indica si el tipo de documento es un archivo zip.
esDocIntegerCódigo que indica si el tipo de documento es un documento.
esXlsIntegerCódigo que indica si el tipo de documento es un Xls.
esPptIntegerCódigo que indica si el tipo de documento es un presentación ppt.
inicialesStringContiene las iniciales del nombre de usuario al que pertenece el documento.
usuarioStringContiene el nombre del usuario al que pertenece el documento.
dtfFloatGuarda una fecha comvertida a número, con el fin de agilizar búsquedas.
miniaturaStringEn caso de que el tipo de documento pueda previsualizarse, se guarda una imagen .png que corresponde a una miniatura del documento codificado en base 64.