Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
A continuación se muestran todos los métodos referentes a la gestión de documentos, carpetas , relaciones etc.
Métodos de manejo de documentos.
Método 'createDocument'
Almacena un documento en el gestor Documental Documentum.
NOTA: Se recomienda antes de crear un documento usando este método llamar al método de inicializacion de metadatos (initializeDocumentMetadata) sin enviar el contenido del documento.
Para crear expedientes o índices habría que usar los métodos referentes al servicio AdministrativeFileService
Los errores de la invocación se encapsulan en ResultCreateDocument
Código
Nombre
Descripción
Código
Nombre
Descripción
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
128
ERROR_CSV_YAEXISTE
Ya existe un documento con el CSV especificado.
130
ERROR_BASEDATOS_CSVPAPIRO
Error al conectar con la base de datos CCSV.
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
155
ERROR_VERIFYDOCUMENTMETADATA
Hay errores en la validación de metadatos
168
ERROR_CREAR_ANULADO
No se puede crear un documento con estado Anulado
169
ERROR_CREAR_COPIA_SIMPLE
No se puede crear un documento con Tipo de Copia = Copia Simple y Estado distinto a Copia
181
ERROR_CREAR_SINFIRMA
No se puede crear un documento sin firmar en estado Original o Copia.
197
MENSAJE_ERROR_COPIA_SIMPLE_SIGN
Error al firmar con sello de órgano el documento cuando es tipo de copia simple
209
ERROR_MESSAGE_DIGEST
Error al generar el SHA-1
2009
ERROR_METADATA_HASH
El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado
2010
ERROR_UPDATE_METADATA_HASH
No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamCreateDocument paramCreateDocument = new ParamCreateDocument();
paramCreateDocument.setDocument(document);//se entiende que el "document" es un documento con sus metadatos ya inicializados.
ResultCreateDocument result = ccsvClient.createDocument(paramCreateDocument);
if(result.getReturnCode().equals(ReturnCode.OK){
String id = result.getId();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'updateDocument'
Método deprecado, utilizar updateDocumentAdv.
Método 'updateDocumentAdv'
Actualiza un documento en el gestor documental Documentum. No permite la actualización de trazas ni agentes.
No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido.
2009
ERROR_METADATA_HASH
El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado.
123
ERROR_NOMBREDOCUMENTO_NOVALIDO
Debe especificar el nombre del documento.
162
ERROR_TIPO_DOCUMENTAL_NOVALIDO
Debe especificar el tipo documental del documento.
124
ERROR_FORMATO_NOVALIDO
Debe especificar el formato del documento.
125
ERROR_CODIGOAPLICACION_NOVALIDO
Debe especificar el código de la aplicación.
155
ERROR_VERIFYDOCUMENTMETADATA
Hay errores en la validación de metadatos.
209
ERROR_MESSAGE_DIGEST
Se ha producido un error al generar el hash del documento.
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del nif solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el nif del solicitante del servicio
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum
130
ERROR_BASEDATOS_CSVPAPIRO
Error al conectar con la base de datos CCSV
127
ERROR_CSV_NOEXISTE
No existe documento con el CSV especificado
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732
ERROR_DOCUMENTO_ANULADO
No se puede recuperar un documento anulado
Ejemplo de invocación
Invocación
ParamUpdateDocument paramUpdateDocument = new ParamUpdateDocument();
paramUpdateDocument.setDocument(document);//se entiende que el "document" es un documento que ya está creado.
paramUpdateDocument.setAddMetadata(true);
ResultUpdateDocument result = ccsvClient.updateDocument(paramCreateDocument);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'getDocumentByCitizen'
Recupera un documento desde portales públicos a partir de su identificador.
Recupera un documento almacenado en el gestor documental a partir del identificador de Documentum o de su CSV. Da la opción de indicar si se quiere devolver el contenido del documento, los metadatos o las firmas. En el caso de indicar que nos devuelva los metadatos podemos indicar si queremos que nos devuelva los agentes y las trazas.
Los errores de la invocación se encapsulan en ResultGetDocumentAdv
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el identificador del documento o su CSV.
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del NIF solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el NIF del solicitante del servicio
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU.
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con PAU
127
ERROR_CSV_NOEXISTE
No existe documento con el CSV especificado
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO
130
ERROR_BASEDATOS_CSVPAPIRO
Error al conectar con la base de datos CCSV
2019
ERROR_FILE_TOO_LARGE
El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732
ERROR_DOCUMENTO_ANULADO
No se puede recuperar un documento anulado
Ejemplo de invocación
Invocación
ParamGetDocumentAdv paramGetDocumentAdv = new ParamGetDocumentAdv();
paramGetDocumentAdv.setId("0906fca3801922bb");
paramGetDocumentAdv.addContent(true);
paramGetDocumentAdv.setAttachSignatures(true);
paramGetDocumentAdv.setAddMetadata(false);
ResultGetDocumentAdv result = ccsvClient.getDocumentAdv(paramGetDocumentAdv);
if(result.getReturnCode().equals(ReturnCode.OK){
DocumentAdv document = result.getDocument();
// en este caso document.getMetadata será nulo ya que no lo hemos recuperado
ArrayList<Signatures> signatures = result.getSignatures();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'deleteDocument'
Elimina un documento almacenado en el gestor documental a partir del identificador de Documentum o de su csv.
Listado de documentos que coinciden con la búsqueda.
Códigos de error
Los errores de la invocación se encapsulan en ResultSearch
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el id de Documentum o el CSV.
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamSearch paramSearchDocument = new ParamSearch();
paramSearchDocument.setSearchType(SearchType.DOCUMENTO);
String[] metadataList = new String [5]; //Metadatos a devolver
metadataList[0]= DocumentumConstants.NombreMetadatos.PAEGA_IDENT_CSV;
metadataList[1]= DocumentumConstants.NombreMetadatos.PAEGA_DESC_DESCRIPCION;
metadataList[2]= DocumentumConstants.NombreMetadatos.PAEGA_IDENT_FECHA_CAPTURA;
metadataList[3]= DocumentumConstants.NombreMetadatos.PAEGA_DESC_NOMBRE;
metadataList[4]= DocumentumConstants.NombreMetadatos.PAEGA_DESC_TIPO_DOCUMENTO;
paramSearchDocument.setMetadataList(metadataList);//Se crea una lista de filtros de tipos documentales
FileFilter[] fileFilterList= new FileFilter[1];//Se crea un filtro para tipos documentales DEA
FileFilter fileFilter = new FileFilter();//Se establece como tipo documental de búsqueda el DEA
fileFilter.setDocumentumType(DocumentumConstants.TipoDocumental.DEA);//Se inicializa la lista de filtros de rama de metadatos
DocumentFilter[] documentFilterList = new DocumentFilter[1];//Se inicializa un filtro de rama
DocumentFilter documentFilter = new DocumentFilter();//Se inicializa la lista de filtros de cada filtro de rama de metadatos
Filter[] filterList = new Filter[1];//Se define un filtro
Filter filter = new Filter();
filter.setName(DocumentumConstants.NombreMetadatos.PAEGA_IDENT_CSV);//CSV
filter.setFilterType(FilterType.IN);
filter.setValue(new String[]{"CSVSJ074D05PZAK1SCDE","CSV6B41D7L4OUA801SSS"});//Se asigna el filtro por lista de CSV's a la lista de filtros
filterList[0] = filter;//Se asigna la lista de filtros al filtro de rama de metadatos
documentFilter.setFilters(filterList);//Se asigna el filtro de rama a la lista de filtros
documentFilterList[0] = documentFilter;//Se asigna la lista de filtros de rama al filtro por tipo documental
fileFilter.setDocumentFilterList(documentFilterList);//Al ser una búsqueda de documentos sólo se informa un elemento de tipo FileFilter
fileFilterList[0]= fileFilter;//Se asigna la lista de filtros de tipos documentales
paramSearchDocument.setFileFilter(fileFilterList);
paramSearch.setPageNumber(1);//Valores de paginación
paramSearch.setPageSize(10);//Valores de ordenación
paramSearch.setSortMetadataName(DocumentumConstants.NombreMetadatos.PAEGA_IDENT_FECHA_CAPTURA);
paramSearch.setSortType(SortType.ASCENDING);
ResultSearch resultSearchDocument = documentMetadataSignatureBL.getDocumentMetadataSignatureWs().search(paramSearchDocument);
if (resultSearchDocument.getReturnCode().equals(ReturnCode.ERROR)){
log.error("Error al recuperar documentos: "+resultSearchDocument.getErrorMessage());
}else{
DocumentSearchResult[] results = resultSearchDocument.getDocumentSearchResult();
}
Método 'searchDQL'
Realiza una búsqueda a partir de una dql previamente almacenada gestor documental. Este método solo debe utilizarse en casos en los que sea estrictamente necesario y no haya ninguna otra manera de realizar las consultas. Consultar el siguiente enlace para obtener información de como crear la dql:
Documento con la firma que se va a archivar en el repositorio documental.
signature
DataHandler
Si
Firma del documento sin codificar en base64.
id
String
Si(1)
Identificador del documento en Documentum si no hay que crearlo nuevo.
csv
String
Si(1)
CSV del documento si no hay que crearlo de nuevo.
createDocument
boolean
Si(2)
Indica si queremos crear el documento o no.
signatureType
int
Si
Tipo de firma.
initFormat
int
Si
Subformato de la firma.
finalFormat
int
No
Se indica al subformato de firma si se quiere elevar.
attachedSignature
boolean
Si
Indica si se trata de una firma adjunta.
aclName
String
No
Nombre de la lista de control de accesos al fichero.
folderId.
String
No
Identificador de la carpeta.
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.
NOTA 2 : En caso de marcar createDocument como true habrá que proporcionar el documento completo en caso contrario o habrá que indicar el CSV o el id.
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultCreateAndVerifySignature(hereda de ResultError)
signatureId
String
id de la firma guardada en documentum
documentumId
String
id del documento guardado en documentum
Códigos de error
Los errores de la invocación se encapsulan en ResultSearch
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el id de Documentum o el CSV.
136
ERROR_FIRMA_FORMATONULO
Debe especificar el formato de la firma para su verificación.
177
ERROR_SIGNATURETYPE_INVALID
El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada.
178
ERROR_SUBFORMAT_INVALID_FOR_FORMAT
El formato de firma no se puede elevar al subformato indicado.
179
ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT
El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada.
2005
ERROR_SUBFORMAT_INVALID
El subformato de la firma es inferior al permitido.
203
ERROR_DATAHANDLER_ARRAYBYTE_CSV
Error al pasar dataHandler a ArrayByte
138
ERROR_DOCUMENTONULO
Debe especificar el parámetro documento.
139
ERROR_FIRMANULA
Debe especificar el parámetro firma.
2010
ERROR_UPDATE_METADATA_HASH
No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido .
2009
ERROR_METADATA_HASH
El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del nif solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el nif del solicitante del servicio.
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU.
1131
ERROR_ASF_VALIDATE_SIGNATURE
Error al validar la firma.
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732
ERROR_DOCUMENTO_ANULADO
No se puede recuperar un documento anulado
Ejemplo de invocación
Invocación
ParamCreateAndVerifySignature paramCreateAndVerifySignature = new ParamCreateAndVerifySignature();
paramCreateAndVerifySignature.setDocument(document);//se entiende que el objeto document es un objeto completo de un documento.
paramCreateAndVerifySignature.setSignature(signature);
paramCreateAndVerifySignature.setCreateDocument(true);//al indicar esta propiedad como verdadera no se pasan el csv y el id.
paramCreateAndVerifySignature.setSignatureType(com.tbsolutions.asf.util.Constants.CADES_FORMAT);
paramCreateAndVerifySignature.setInitFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_T));
paramCreateAndVerifySignature.setFinalFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_A));
paramCreateAndVerifySignature.setAttachedSignature(false);
ResultCreateAndVerifySignature result = ccsvClient.createAndVerifySignature(paramCreateAndVerifySignature);
if(result.getReturnCode().equals(ReturnCode.OK){
String documentId = result.getDocumentId();
String signatureId = result.getSignatureId();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'createWithoutVerifySignature'
Este método del servicio almacena y asocia la firma de un documento en Documentum. El documento puede estar ya almacenado o ser almacenado a la vez. La diferencia con con el createAndVerifySignature es que no se verifican las firmas que se van a insertar.
Documento que se desea almacenar junto con la firma proporcionada.
id
String
Si(1)
Identificador del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
csv
String
Si(1)
CSV del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
createDocument
boolean
Si(2)
Indica si hay que almacenar primero el documento pasado por parámetro o la firma se debe vincular al documento cuyo id se proporciona.
attachedSignature
boolean
Si
Indica si se trata de una firma adjunta
aclName
String
No
Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV.
folderId
String
No
Identificador de la carpeta donde se quiere almacenar el documento. En caso de no rellenarse se almacenará en la carpeta proporcionada por CCSV.
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1)
NOTA 2 : En caso de marcar createDocument como true habrá que proporcionar el documento completo en caso contrario o habrá que indicar el CSV o el id.(2)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultCreateWithoutVerifySignature(hereda de ResultError)
documentId
String
Identificador en Documentum del documento almacenado.
signatureId
String
Identificador en Documentum de la firma asociada al documento-
Códigos de error
Los errores de la invocación se encapsulan en ResultCreateWithoutVerifySignature
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el identificador del documento o su CSV.
203
ERROR_DATAHANDLER_ARRAYBYTE_CSV
Error al pasar dataHandler a ArrayByte.
138
ERROR_DOCUMENTONULO
Debe especificar el parámetro documento.
2010
ERROR_UPDATE_METADATA_HASH
No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido.
2009
ERROR_METADATA_HASH
El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado.
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del nif solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el nif del solicitante del servicio.
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU.
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU.
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
ParamUpdateAndVerifySignature(hereda de ParamBase)
aclName
String
No
Nombre de la lista de control de accesos al fichero.
folderId
String
No
Identificador de la carpeta.
csv
String
Si(1)
CSV del documento en Documentum.
id
String
Si(1)
Identificador del documento en Documentum.
signatureId
String
Si
Identificador de la firma.
attachedSignature
boolean
Si
Indica si se trata de una firma adjunta.
signatureType
int
Si
Indica el tipo de firma.
initFormat
int
Si
Subformato de la firma.
finalFormat
int
No
Se indica al subformato de firma si se quiere elevar.
signature
DataHandler
Si
Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado sustituyendo a la firma indicada.
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultUpdateAndVerifySignature(hereda de ResultError)
signatureId
String
Identificador en Documentum de la firma reemplazada.
Códigos de error
Los errores de la invocación se encapsulan en ResultUpdateAndVerifySignature.
Código
Nombre
Descripción
Código
Nombre
Descripción
175
ERROR_IDFIRMANULA
Debe especificar el parámetro ID de la firma.
156
ERROR_CSV_E_ID_NULOS
Debe especificar el identificador del documento o su CSV.
177
ERROR_SIGNATURETYPE_INVALID
El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada.
178
ERROR_SUBFORMAT_INVALID_FOR_FORMAT
El formato de firma no se puede elevar al subformato indicado.
179
ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT
El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada.
2005
ERROR_SUBFORMAT_INVALID
El subformato de la firma es inferior al permitido.
203
ERROR_DATAHANDLER_ARRAYBYTE_CSV
Error al pasar dataHandler a ArrayByte.
176
ERROR_SIGNATUREID_NOTFOUND
No existe la firma indicada para el documento cuyo identificador o csv se ha proporcionado.
139
ERROR_FIRMANULA
Debe especificar el parámetro firma
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del nif solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el nif del solicitante del servicio
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU
1131
ERROR_ASF_VALIDATE_SIGNATURE
Error al validar firma
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
Este método actualiza una firma existente de un documento almacenado en Documentum. La firma puede estar adjunta en el documento, entonces el contenido de éste será reemplazado por el de la firma en Documentum.
ParamUpdateWithoutVerifySignature (hereda de ParamBase)
id
String
Si(1)
Identificador del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
csv
String
Si(1)
CSV del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
signature
DataHandler
Si
Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado sustituyendo a la firma indicada.
attachedSignature
boolean
Si
Indica si se trata de una firma adjunta.
aclName
String
No
Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV.
folderId
String
No
Identificador de la carpeta.
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultUpdateWithoutVerifySignature (hereda de ResultError)
signatureId
String
Identificador en Documentum de la firma reemplazada.
Códigos de error
Los errores de la invocación se encapsulan en ResultUpdateWithoutVerifySignature.
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el identificador del documento o su CSV.
203
ERROR_DATAHANDLER_ARRAYBYTE_CSV
Error al pasar dataHandler a ArrayByte
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del nif solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el nif del solicitante del servicio
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU
1131
ERROR_ASF_VALIDATE_SIGNATURE
Error al validar firma
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732
ERROR_DOCUMENTO_ANULADO
No se puede recuperar un documento anulado
Ejemplo de invocación
Invocación
ParamUpdateWithoutVerifySignature paramUpdateWithoutVerifySignature = new ParamUpdateWithoutVerifySignature();
paramUpdateWithoutVerifySignature.setCSV("CSV3G2ZOOM5NGAG1CCSV");
paramUpdateWithoutVerifySignature.setAttachedSignature(false);
ResultUpdateWithoutVerifySignature result = ccsvClient.updateWithoutVerifySignature(paramUpdateWithoutVerifySignature);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'updateAndSignDocument'
Servicio que recupera las firmas asociadas a un documento.
Documento que se desea almacenar junto con la firma proporcionada.
signature
DataHandler
Si
Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado..
signatureType
int
Si
Tipo de firma.
initFormat
int
Si
Subformato de la firma.
finalFormat
int
No
Se indica al subformato de firma si se quiere elevar.
attachedSignature
boolean
Si
Indica si la firma es adjunta.
updateMetadata
boolean
No
Indica si se tienen que actualizar los metadatos del documento. En este caso, el objeto document debe venir relleno con los mismos.
aclName
String
No
Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV.
folderId
String
No
Identificador de la carpeta donde se quiere almacenar el documento. En caso de no rellenarse se almacenará en la carpeta proporcionada por CCSV.
traceData
TraceData
Si
Metadatos de la traza
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultUpdateAndSignDocument (hereda de ResultError)
signatureId
String
id de la firma guardada en documentum.
documentumId
String
id del documento guardado en documentum.
Códigos de error
Los errores de la invocación se encapsulan en ResultUpdateAndSignDocument.
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el id de Documentum o el CSV.
126
ERROR_CSV_NOVALIDO
Debe especificar el CSV.
2010
ERROR_UPDATE_METADATA_HASH
No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido.
123
ERROR_NOMBREDOCUMENTO_NOVALIDO
Debe especificar el nombre del documento.
162
ERROR_TIPO_DOCUMENTAL_NOVALIDO
Debe especificar el tipo documental del documento.
124
ERROR_FORMATO_NOVALIDO
Debe especificar el formato del documento.
125
ERROR_CODIGOAPLICACION_NOVALIDO
Debe especificar el código de la aplicación.
155
ERROR_VERIFYDOCUMENTMETADATA
Hay errores en la validación de metadatos.
209
ERROR_MESSAGE_DIGEST
Se ha producido un error al generar el hash del documento.
130
ERROR_BASEDATOS_CSVPAPIRO
Error al conectar con la base de datos CCSV
127
ERROR_CSV_NOEXISTE
No existe documento con el CSV especificado
136
ERROR_FIRMA_FORMATONULO
Debe especificar el formato de la firma para su verificación.
177
ERROR_SIGNATURETYPE_INVALID
El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada.
178
ERROR_SUBFORMAT_INVALID_FOR_FORMAT
El formato de firma no se puede elevar al subformato indicado.
179
ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT
El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada.
2005
ERROR_SUBFORMAT_INVALID
El subformato de la firma es inferior al permitido.
203
ERROR_DATAHANDLER_ARRAYBYTE_CSV
Error al pasar dataHandler a ArrayByte
138
ERROR_DOCUMENTONULO
Debe especificar el parámetro documento.
139
ERROR_FIRMANULA
Debe especificar el parámetro firma.
2009
ERROR_METADATA_HASH
El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones.
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del NIF solicitante al documento indicado.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el NIF del solicitante del servicio.
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU.
1131
ERROR_ASF_VALIDATE_SIGNATURE
Error al validar la firma.
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
Los errores de la invocación se encapsulan en ResultInitializeDocumentMetadata
Código
Nombre
Descripción
Código
Nombre
Descripción
144
ERROR_INITIALIZE_DOCUMENTTYPE_NOEXISTE
No existe el tipo de documento indicado
145
ERROR_INITIALIZE_DOCUMENTUMTYPE_NOEXISTE
No existe el tipo documental indicado
146
ERROR_INITIALIZE_DOCUMENTTYPE_DOCUMENTUMTYPE_NULO
Debe indicar el tipo de documento (documentType) o el tipo documental (document.type)
143
ERROR_METADATA_MODEL
Error al recuperar la información del modelo de metadatos
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
Document document = new Document();// Establecemos el código de la aplicación
document.setApplicationCode("CCSV");// Establecemos el nombre de la aplicación
document.setApplicationName("Sistema de Comprobación de Documentos mediante CSV");
//documentContent es el DataHandler con el contenido del documento y no nos interesa pasarlo para la inicialización de metadatos
// Establecemos la extensión
document.setExtension("pdf");
/* Si no se sabe el tipo documental se puede indicar el tipo de documento documentType
dentro del ParamInitializeDocument */
document.setType("dga_doc_dea");
//Formato del documento según el catálogo de estándares
document.setFormat("PDF/A");
// Establecemos el nombre del documento
document.setName("solicitud1232243434343.pdf");
ParamInitializeDocumentMetadata paramInitializeDocumentMetada = new ParamInitializeDocumentMetadata();
paramInitializeDocumentMetadata.setDocument(document);
paramInitializeDocumentMetadata.setDocumentType("DECLARACION");
paramInitializeDocumentMetadata.setApplicationId("CCSV");
ResultInitializeDocumentMetadata result = ccsvClient.initializeDocumentMetadata(paramInitializeDocumentMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
document = result.getDocument();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'initializeStructuredMetadata'
Inicializa la estructura de un documento con el nombre del metadato proporcionado.
Los errores de la invocación se encapsulan en ResultUpdateMetadata
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Se ha producido un error con PAPIRO.
127
ERROR_CSV_NOEXISTE
No existe documento con el CSV especificado.
133
ERROR_METADATONOEXISTE
No existe el metadato buscado para ese documento.
158
ERROR_VERIFY_NOT_VALUELIST
El valor indicado no está entre los valores válidos para ese metadato.
189
ERROR_INTERNALACCESSCONTROL_NIFINVALID
Debe especificar el NIF del solicitante del servicio
190
ERROR_INTERNALACCESS_NOTALLOWED
No está permitido el acceso del NIF solicitante al documento indicado
191
ERROR_INTEGRATIONAPPLICATION
Error al recuperar la información de la integración de aplicaciones
192
ERROR_CONEXION_PAU
Se ha producido un error al realizar la conexión con PAU
141
ERROR_CONEXION_SIU
Se ha producido un error al realizar la conexión con SIU
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732
ERROR_DOCUMENTO_ANULADO
No se puede recuperar un documento anulado
Ejemplo de invocación
Invocación
ParamUpdateMetadata paramUpdateMetadata = new ParamUpdateMetadata();
paramUpdateMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
// creamos un metadata con todos los metadatos que queremos modificar
HashMap<String, Object> metadata = new HashMap<String, Object> ();
// modificaremos el metadato de la descripción
metadata.put("dea_desc_descripcion", "Nueva descripción");
// y modificaremos un metadato repetitivo estructurado por ejemplo el de verificación
Object[] verificacion = new Object[2];
Document verifi1 = new Document();
verifi1.setType("dga_paega_verificacion");
verifi1.setName("verificacion");
HashMap<String, Object> metadataVerif1 = new HashMap<String, Object>();
metadataVerif1.put("verificacion_nombre","Nombre1");
metadataVerif1.put("verificacion_valor", "Valor1");
verifi1.setMetadata(metadataVerif1);
Document verifi2 = new Document();
verifi2.setType("dga_paega_verificacion");
verifi2.setName("verificacion");
HashMap<String, Object> metadataVerif2 = new HashMap<String, Object>();
metadataVerif2.put("verificacion_nombre","Nombre2");
metadataVerif2.put("verificacion_valor", "Valor2");
verifi2.setMetadata(metadataVerif2);
verificacion[0]=verifi1;
verificacion[1]=verifi2;
metadata.put("verificacion", verificacion);
paramUpdateMetadata.setNewMetadata(metadata);
paramUpdateMetadata.setAddValues(false);
ResultUpdateMetadata result = ccsvClient.updateMetadata (paramUpdateMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'deleteMetadata'
Borra o resetea los valores de un metadato (sea repetitivo o no).
Objeto AgentRelationship con el contenido de la relación agente recuperado
Códigos de error
Los errores de la invocación se encapsulan en ResultAddAgentRelationships
Código
Nombre
Descripción
Código
Nombre
Descripción
156
ERROR_CSV_E_ID_NULOS
Debe especificar el id de Documentum o el CSV
184
ERROR_ADD_ROLEORIDENTIFICATIONNUMBER
Debe especificar otro criterio de búsqueda, ya que existen varias relaciones que cumplen el indicado
127
ERROR_CSV_NOEXISTE
No existe documento con el CSV especificado
131
ERROR_GENERICO_PAPIRO
Se ha producido un error con PAPIRO.
101
ERROR_CONEXION_PAPIRO
Error de conexión con documentum.
801
GENERIC_ERROR
Error genérico procesando la petición.
733
ERROR_DOCUMENTO_SUSTITUIDO
El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732
ERROR_DOCUMENTO_ANULADO
No se puede recuperar un documento anulado
Ejemplo de invocación
Invocación
ParamGetAgentRelationship paramGetAgentRelationship = new ParamGetAgentRelationship();
paramGetAgentRelationship.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetAgentRelationship.setRole(DocumentumConstants.RolRelacion.APORTADOR);
paramGetAgentRelationship.setIdentificationNumber("17258369T");
ResultGetAgentRelationship result = ccsvClient.getAgentRelationship(paramGetAgentRelationship);
if(result.getReturnCode().equals(ReturnCode.OK){
AgentRelationship agentRelationship = result.getAgentRelationship();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'getAgentRelationships'
Devuelve los datos de las relaciones del documento con id o csv indicado que sean de los roles indicados, estén activas o no o tengan el identificador de agente identificationNumber. Si no se indican roles, devuelve todas las relaciones
Genera un token firmado para los integradores del iframe del portal privado. Este token deberá ser devuelto para comprobar que el que carga el iframe es el mismo que lo ha pedido.
Listado de los subtipos de documentos que se han recuperado a partir de los parámetros de búsqueda.
Códigos de error
Los errores de la invocación se encapsulan en ResultGetDocumentSubtypeList
Código
Nombre
Descripción
Código
Nombre
Descripción
ERROR_GET_DOCUMENTSUBTYPELIST
No existe ningún subtipo de documento para ese tipo de documento.
130
ERROR_BASEDATOS_CSVPAPIRO
Error al conectar con la Base de Datos CSV.
801
GENERIC_ERROR
Error genérico procesando la petición
Ejemplo de invocación
Invocación
ParamGetDocumentSubtypeList paramGetDocumentSubtypeList = new ParamGetDocumentSubtypeList();
paramGetDocumentSubtypeList.setDocumentTypeName("documentTypeName");
ResultGetDocumentSubtypeList result = ccsvClient.documentSubtypeList(paramGetDocumentSubtypeList);
if(result.getReturnCode().equals(ReturnCode.OK){
List<DocumentSubtypeList> documentSubtypeList = result.getDocumentSubtypeList();
}
Métodos obsoletos
Debido a la definición actual del servicio de gestión documentos existen varios métodos que han quedado obsoletos ya que pueden realizarse esas mismas tareas desde un método general cambiando ciertos parámetros. Con el fin de mejorar la mantenibilidad y el soporte del sistema se ha decidido que en próximas versiones se eliminaran los siguientes métodos.(En cada uno de los métodos se marca aquel que se recomienda usar en lugar del que se ha marcado como obsoleto)
Método 'getDocumentByCSV'
Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el csv y además podemos indicar los datos que queremos que se nos devuelvan.
Método 'getDocumentContentByCSV'
Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el csv y además podemos indicar los datos que queremos que se nos devuelvan en este caso pasando el atributo addContent como true.
Método 'getDocumentById'
Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el id y además podemos indicar los datos que queremos que se nos devuelvan.
Método 'getDocumentContentById'
Se recomienda usar el método getDocument que devuelve los mismos datos si rellenamos el id y además podemos indicar los datos que queremos que se nos devuelvan en este caso pasando el atributo addContent como true.
Método 'getDocumentMetadata'
Se recomienda usar el método getDocumentya que podemos obtener los metadatos de un documento pasando el atributo addMetadata como true.
Método 'updateDocumentMetadata'
Se recomienda usar el método updateDocument ya que en caso de querer actualizar los metadatos marcaremos el atributo updateMetadata como true.
Método 'updateDocumentContent'
Se recomienda usar el método updateDocument ya que en caso de querer actualizar los metadatos marcaremos el atributo updateContent como true.
Método 'createSignature'
Se recomienda usar el método createAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.
Método 'updateSignature'
Se recomienda usar el método updateAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.
Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.
Método 'updateStructuredMetadata'
Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.
Método 'updateSimpleMetadata'
Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.
Servicios CSVQueryDocumentService, CSVQueryDocumentWSService y CSVQueryDocumentCertificateService
Los servicios productores para CSVBroker son exclusivos para esta aplicación y, por tanto, no deben ser integrados por otras aplicaciones. La finalidad que implementan, obtener documentos de CCSV, es igualmente implementada en DocumentMetadataSignatureService, por lo que el resto de aplicaciones que deseen acceder a esta funcionalidad deberán utilizar este último servicio.
A continuación se detallas aquellos objetos o tipos de datos que se utilizan en más de un método.
Objeto 'AdministrativeFile'
Este objeto se utiliza para almacenar la información de un expediente. Este objeto hereda las propiedades de Document.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
number
String
Número del expediente.
administrativeFileType
String
Tipo del expediente.
state
String
Estado en el que se encuentra el expediente.
indexCsv
String
Csv del índice asociado al expediente.
date
Date
Fecha de apertura del expediente.
closeDate
Date
Fecha de cierre del expediente.
Objeto 'CsvBrokerDocument'
Clase donde se almacena la información de los documentos electrónicos recibida a través de CSVBroker.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
documentName
String
Nombre del documento.
documentMime
String
Mime-type del documento
documentContent
byte[]
Contenido del documento
organizationList
List<String>
Lista de organismos que pueden contener el documento asociado al CSV.
Objeto 'DocumentBase'
Clase donde se almacena la información de los documentos electrónicos con el contenido.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
id
String
Identificador del documento en Documentum.
csv
String
Csv del documento.
type
String
Nombre del tipo documental en Documentum.
name
String
Nombre del documento.
content
DataHandler
Contenido del documento.
format
String
Formato del documento.
applicationCode
String
Código de la aplicación.
applicationName
String
Nombre de la aplicación.
extension
String
Extensión del documento.
Objeto 'Document'
Clase donde se almacena la información de los documentos electrónicos con el contenido y sus metadatos. Este objeto hereda las propiedades de DocumentBase.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
metadata
HashMap<String,Object>
Almacena las propiedades o metadatos de un documento.
Objeto 'DocumentAdv'
Clase donde se almacena la información de los documentos electrónicos con el contenido y sus metadatos. Este objeto hereda las propiedades de DocumentBase.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
metadata
HashMap<String,Object>
Almacena las propiedades o metadatos de un documento.
visibility
String
Indica la visibilidad del documento.
Objeto 'DocumentRelation'
Clase donde se almacena la información de metadatos propios de una relación entre documentos.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
role
String
Nombre del rol de la relación que existe.
dateStart
String
Fecha de inicio de la relación.
dateEnd
String
Fecha de fin de la relación.
metadata
HashMap<String,Object>
Propiedades o metadatos adicionales de la relación.
Objeto 'AdministrativeFileRelation'
Clase utilizada para almacenar la información de la relación entre un expediente y su contenido.
Metadato estructurado para almacenar el agente relacionado
additionalMetadata
HashMap<String, Object>
Metadatos adicionales
Objeto 'ParamBase'
Clase utilizada como base para la creación de objetos que encapsulen datos de parámetros de entrada a los servicios Web.
Nombre
Tipoe
Descripción
Nombre
Tipoe
Descripción
applicationId
String
Identificador de la aplicación que llama al servicio.
ip
String
IP de la aplicación que llama al web service.
nif
String
Nif del usuario de PAU con el que se va a hacer la petición.
Objeto 'ResultError'
Clase utilizada como base para la encapsulación de errores en las invocaciones a los servicios Web. Los objetos que encapsulan los resultados de las llamadas a los servicios heredan de esta clase para devolver los errores en caso de que se presenten.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
errorCode
int
Código del error en CCSV
errorMessage
String
Mensaje del error en CCSV
exception
String
Excepción completa ocurrida durante la invocación al servicio.
returnCode
String
Código que se devuelve de la invocación al servicio.
Objeto 'SignedDocument'
Clase utilizada para almacenar un documento y su firma asociada
Contiene el resto de nodos documentales asociados al actual.
Objeto 'ParamSendJustice'
Clase que contiene parámetros adicionales para remitir a justicia.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
justiciaProcedimientoAnio
string
Año del procedimiento
justiciaProcedimientoClase
string
Clase de procedimiento
justiciaDescripcion
string
Descripción
justiciaDir3OrganoRemite
string
Órgano remitente
justiciaNig
string
justicioaProcedimientoNumero
string
Número de procedimiento
Enum 'SearchType'
Nombre
Valor
Descripción
Nombre
Valor
Descripción
DOCUMENTO
documento
Tipo de búsqueda realizada por documentos.
EXPEDIENTE
expediente
Tipo de búsqueda realizada por expedientes.
Enum 'SortType'
Nombre
Valor
Descripción
Nombre
Valor
Descripción
ASCENDING
A
Realiza una ordenación ascendente de los resultados obtenidos.
DESCENDING
D
Realiza una ordenación descendente de los resultados obtenidos.
Enum 'FilterType'
Nombre
Valor
Descripción
Nombre
Valor
Descripción
LIKE
LIKE
Se usa para comparación de cadenas de texto interpretando algunos caracteres.
EQUAL
=
Se usa para filtrar aquellos objetos que cumplan la condición de igualdad.
NOT_EQUAL
<>
Se usa para filtrar aquellos objetos que cumplan la condición de desigualdad.
GREATER
>
Se usa para filtrar aquellos objetos que cumplan la condición de ser mayor.
LESS
<
Se usa para filtrar aquellos objetos que cumplan la condición de ser menor.
GREATER_OR_EQUAL
>=
Se usa para filtrar aquellos objetos que cumplan la condición de ser mayor o igual.
LESS_OR_EQUAL
<=
Se usa para filtrar aquellos objetos que cumplan la condición de ser menor o igual.
IN
IN
Filtra aquellos objetos que estén en un listado.
Enum 'DocumentRelationSearchType'
Nombre
Valor
Descripción
Nombre
Valor
Descripción
PARENT
PARENT
Indica que se quieren buscar todos documentos “padre” del documento indicado. Es decir, que se quieren obtener todas las relaciones en las que el documento indicado figure como hijo en la relación.
CHILD
CHILD
Indica que se quieren buscar todos documentos “hijo” del documento indicado. Es decir, que se quieren obtener todas las relaciones en las que el documento indicado figure como padre en la relación.
Objeto 'AdministrativeFileLite'
Clase que se utiliza para guardar los datos básicos de un expediente.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
id
String
Identificador del documento en el gestor documental.
csv
String
CSV del expediente
csvIndex
String
CSV del documento de índice
description
String
Descripción del expediente
number
String
Número de expedientenumber
openDate
Date
Fecha de apertura del expediente
state
String
Estado del expediente
objectName
String
Nombre del objeto: object_name
name
String
Nombre del objeto: dea_desc_nombre
creationDate
Date
Fecha de creación: r_creation_date
procedureCode
String
Código del procedimiento del expediente: dea_cont_codprocedimiento
Objeto 'AdministrativeFileDocumentLite'
Clase que se utiliza para guardar los datos básicos de los documentos de un expediente.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
id
String
Identificador del documento en el gestor documental.
csv
String
CSV del documento
description
String
Descripción del documento
name
String
Nombre del documento
openDate
Date
Fecha de creación del documento
path
String
Ruta virtual de carpetas en la que se encuentra el documento (nombres de carpetas con separador pipe '|')
objectName
String
Nombre del objeto: object_name
creationDate
Date
Fecha de creación: r_creation_date
objectType
String
Tipo de objeto: r_object_type
documentType
String
Tipo de documento: dea_desc_tipo_documento
Objeto 'AdministrativeFileFolderLite'
Clase que se utiliza para guardar la información de los datos básicos de una carpeta de un expediente.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
id
String
Identificador del documento en el gestor documental.
code
String
Código de la carpeta.
name
String
Nombre de la carpeta
path
String
Ruta virtual de carpetas (nombres de carpetas con separador pipe '|') Para una CARPETA que cuelga directamente de un expediente la ruta es "|CARPETA" Para una CARPETA2 que cualga de otra CARPETA1 la ruta es "|CARPETA1|CARPETA2"
objectName
String
Nombre del objeto: object_name
Fecha de creación: r_creation_date
Date
creationDate
Objeto 'AdministrativeFileAgentLite'
Clase que se utiliza para guardar la información básica de un agente de un expediente.
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
id
String
Identificador del documento en el gestor documental.
rol
String
Rol del agente: relacion_rol
category
String
Categoría del agente: agente_nti_categoria
entityType
String
Tipo identidad del agente: agente_nti_tipo_entidad
name
String
Nombre del agente: agente_desc_nombre
identification
String
Identificación del agente: agente_ident_identificacion
