Servicio IDocumentMetadataSignatureServicePortType

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 'createFolder'

Crea una carpeta en Documentum.

Ver detalles

Signatura

ResultCreateFolder createFolder(ParamCreateFolder paramCreateFolder).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateFolder(hereda de ParamBase)
folderType	String	No	Tipo Documental de la carpeta que se va a crear.
metadata	HashMap<String, Object>	No	Metadatos propios de la carpeta que se va a crear.
folderName	String	Si	Nombre de la carpeta que se quiere crear.
aclName	String	No	Nombre de la lista de control de accesos al fichero. En caso de no especificarse se utilizara la utilizado por defecto por CCSV.
folderId	String	No	Identificador de la carpeta donde se creará la subcarpeta. En caso de no especificarse se utilizara la utilizado por defecto por CCSV.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateFolder (hereda de ResultError)
id	String	Identificador en Documentum de la carpeta creada.

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateFolder

Código	Nombre	Descripción
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO
161	ERROR_FOLDERNAME_NULO	Debe especificar el nombre de la carpeta
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamCreateFolder paramCreateFolder = new ParamCreateFolder();
paramCreateFolder.setFolderName("Prueba");
paramCreateFolder.setFolderId("0c06fca38015e4aa");
ResultCreateFolder result = ccsvClient.createFolder(paramCreateFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
	String id = result.getId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getFolderContents'

Devuelve el contenido de una carpeta en Documentum.

Ver detalles

Signatura

ResultGetFolderContents getFolderContents(ParamGetFolderContents paramGetFolderContents).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetFolderContents(hereda de ParamBase)
folderId	String	Si	Id de la carpeta en Documentum cuyo contenido queremos obtener.
metadataNames	String[]	No(1)	Nombres de los metadatos que queremos recuperar de los contenidos de la carpeta.

NOTA : Si no se especifican los metadatos que se quieren devolver se devuelven todos(1).

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetFolderContents(hereda de ResultError)
folders	DocumentSearchResult[]	Listado de carpetas contenidos en la carpeta.
documents	DocumentSearchResult[]	Listado de documentos contenidos en la carpeta.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetFolderContents

Código	Nombre	Descripción
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
180	ERROR_FOLDERNAME_NULO	Debe especificar el Id de la carpeta.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamGetFolderContents paramGetFolderContents = new ParamGetFolderContents();
paramGetFolderContents.setFolderId("0c06fca38015e4aa");
ResultGetFolderContents result = ccsvClient.getFolderContents(paramGetFolderContents);
if(result.getReturnCode().equals(ReturnCode.OK){
	DocumentSearchResult[] folders = result.getFolders();
	DocumentSearchResult[] documents = result.getDocuments();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

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

Ver detalles

Signatura

ResultCreateDocument createDocument(ParamCreateDocument paramCreateDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateDocument(hereda de ParamBase)
document	Document	Si	Documento que se quiere almacenar en Documentum.
aclName	String	No	Nombre de la lista de control de accesos al fichero.
folderId	String	No	Identificador de la carpeta.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateDocument(hereda de ResultError)
id	String	Identificador en Documentum del documento creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateDocument

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.

Ver detalles

Signatura

ResultUpdateDocument updateDocumentAdv(ParamUpdateDocument paramUpdateDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocumentAdv
document	Document	Si	Documento con los nuevos datos que se van a actualizar en Documentum.
aclName	String	NO	Nombre de la lista de control de accesos al fichero.
updateContent	boolean	Si	Indica si actualiza el contenido del documento.
updateMetadata	boolean		Indica si se actualizan los metadatos del documento.
traceData	TraceData	Si	Información acerca de los cambios en el documento.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateDocument(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateDocument

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

Ver detalles

Signatura

ResultGetDocumentByCitizen getDocumentByCitizen(ParamGetDocumentByCitizen paramGetDocumentByCitizen).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentByCitizen(hereda de ParamBase)
csv	String	Si	Código seguro de verificación del documento que se desea recuperar.
attachSignatures	boolean	No	Indica si se quieres adjuntar las firmas asociadas al documento.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentByCitizen (hereda de ResultError)
document	Document	Documento devuelto por el servicio al realizar la consulta.
signatures	ArrayList<Signature>	Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentByCitizen

Código	Nombre	Descripción
126	ERROR_CSV_NOVALIDO	Debe especificar el CSV.
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.
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

ParamGetDocumentByCitizen paramGetDocumentByCitizen = new ParamGetDocumentByCitizen();
paramGetDocumentByCitizen.setCsv("CSV5478454446454CCSV");
paramGetDocumentByCitizen.setAttachSignatures(true);
paramGetDocumentByCitizen.setNif("17588888H");
ResultGetDocumentByCitizen result = ccsvClient.getDocumentByCitizen(paramGetDocumentByCitizen);
if(result.getReturnCode().equals(ReturnCode.OK){
	Document document = result.getDocument();
	ArrayList<Signatures> signatures = result.getSignatures();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocument'

Método deprecado, utilizar getDocumentAdv.

Método 'getDocumentAdv'

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.

Ver detalles

Signatura

ResultGetDocumentAdv getDocumentAdv(ParamGetDocumentAdv paramGetDocumentAdv).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentAdv(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en el gestor documental Documentum
csv	String	Si(1)	Código Seguro de Verificación del documento que se quiere recuperar.
addContent	boolean	No	Indica si adjunta el contenido del documento.
addMetadata	boolean	No	Indica si adjunta los metadatos del documento.
addSignatures	boolean	No	Indica si adjunta las firmas asociadas al documento.
addAgents	boolean	No(2)	Indica si adjunta los agentes asociados al documento
addTraces	boolean	No(2)	Indica si adjunta las trazas asociadas al documento.

NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

NOTA 2 : En caso de indicar addAgents o addTraces a true se debe indicar el parámetro addMetadata a true.(2)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocument(hereda de ResultError)
document	DocumentAdv	Documento devuelto por el servicio al realizar la consulta.
signatures	ArrayList<Signature>	Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentAdv

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 'getDocumentAndRegisterLog'

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. Almacena un registro del usuario que ha consultado el documento. Se complementa con el método updateRegisterLog que permite actualizar este registro para indicar si finalmente se ha mostrado el documento.

Ver detalles

Signatura

ResultGetDocumentAndRegisterLog getDocumentAndRegisterLog(ParamGetDocumentAndRegisterLog paramGetDocumentAndRegisterLog).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentAndRegisterLog (hereda de ParamBase)
id	String	Si(1)	Identificador del documento en el gestor documental Documentum
csv	String	Si(1)	Código Seguro de Verificación del documento que se quiere recuperar.
addContent	boolean	No	Indica si adjunta el contenido del documento.
addMetadata	boolean	No	Indica si adjunta los metadatos del documento.
addSignatures	boolean	No	Indica si adjunta las firmas asociadas al documento.
addAgents	boolean	No(2)	Indica si adjunta los agentes asociados al documento
addTraces	boolean	No(2)	Indica si adjunta las trazas asociadas al documento.
appModule	String	Si	Módulo de la aplicación
denomination	String	Si(3)	Denominación o razón social de la persona jurídica que realiza el acceso
name	String	Si(3)	Nombre de la persona física que realiza el acceso
nifPf	String	Si(3)	NIF de la persona física que realiza el acceso
nifPj	String	Si(3)	NIF de la persona jurídica que realiza el acceso
surname1	String	Si(3)	Apellido 1 de la persona física que realiza el acceso
surname2	String	No	Apellido 2 de la persona física que realiza el acceso

NOTA: En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

NOTA 2: En caso de indicar addAgents o addTraces a true se debe indicar el parámetro addMetadata a true.(2)

NOTA 3: Es necesario indicar nifPf o nifPj, en caso de indicar nifPj es obligatorio indicar denomination, en caso de indicar nifPf es obligatorio indicar name y surname1.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentAndRegisterLog (hereda de ResultError)
document	DocumentAdv	Documento devuelto por el servicio al realizar la consulta.
signatures	ArrayList<Signature>	Firmas asociadas al documento que se devuelve.
idRegisterLog	Long	Identificador del registro de acceso en CCSV.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentAndRegisterLog

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
218	ERROR_REGISTRO_DATOS	Error al almacenar el registro en la base de datos. Especificará el problema de registro.

Ejemplo de invocación

Invocación

ParamGetDocumentAndRegisterLog paramGetDocumentAndRegisterLog = new ParamGetDocumentAndRegisterLog();
paramGetDocumentAndRegisterLog.setId("0906fca3801922bb");
paramGetDocumentAndRegisterLog.addContent(true);
paramGetDocumentAndRegisterLog.setAttachSignatures(true);
paramGetDocumentAndRegisterLog.setAddMetadata(false);
paramGetDocumentAndRegisterLog.setAppModule("CORE");
paramGetDocumentAndRegisterLog.setNifPf("CIFXXXXXXX");
paramGetDocumentAndRegisterLog.setDenomintaion("XXXXXXXXXXXXXXXXXXXXX"):
ResultGetDocumentAndRegisterLog result = ccsvClient.getDocumentAndRegisterLog(paramGetDocumentAndRegisterLog);
if(result.getReturnCode().equals(ReturnCode.OK){
	DocumentAdv document = result.getDocument();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateRegisterLog'

Actualiza un registro de acceso generado con getDocumentAndRegisterLog, permite indicar si el documento ha sido mostrado al usuario, y el motivo por el que se ha mostrado o no al usuario.

Ver detalles

Signatura

ResultUpdateRegisterLog updateRegisterLog(ParamUpdateRegisterLog paramUpdateRegisterLog).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamUpdateRegisterLog (hereda de ParamBase)
accessResult	int	Si	0: No accedido por el usuario; 1: Sí accedido por el usuario
idRegisterLog	Long	Si	Identificador del registro de acceso
reason	String	No	Texto Libre. Motivo por el que no se ha mostrado el documento

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateRegisterLog (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateRegisterLog

Código	Nombre	Descripción
218	ERROR_REGISTRO_DATOS	Error al almacenar el registro en la base de datos. Especificará el problema de registro.

Ejemplo de invocación

Invocación

ParamUpdateRegisterLog paramUpdateRegisterLog = new ParamUpdateRegisterLog();
paramUpdateRegisterLog.setAccessResult(0);
paramUpdateRegisterLog.setIdRegisterLog(1L);
paramUpdateRegisterLog.setReason("La visibilidad del documento no permite su acceso");
ResultUpdateRegisterLog result = ccsvClient.updateRegisterLog(paramUpdateRegisterLog);
if(result.getReturnCode().equals(ReturnCode.OK){

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

Signatura

Ver detalles

ResultDeleteDocument deleteDocument(ParamDeleteDocument paramDeleteDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamDeleteDocument(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en el gestor documental Documentum
csv	String	Si(1)	Código Seguro de Verificación del documento que se quiere recuperar.

NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteDocument (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocument

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.

Ejemplo de invocación

Invocación

ParamDeleteDocument paramDeleteDocument = new ParamDeleteDocument();
paramDeleteDocument.setCsv("CSV3G2ZOOM5NGAG1CCSV");
ResultDeleteDocument result = ccsvClient.deleteDocument(paramDeleteDocument);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getSubstituteDocument'

Recupera el CSV del documento que sustituye al documento anulado que se indica en los parámetros.

Ver detalles

Signatura

ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetSubstituteDocument (hereda de ParamBase)
csvAnnulled	String	Si	CSV del documento anulado.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetSubstituteDocument (hereda de ResultError)
csvSubstitute	String	CSV del documento sustituto.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetSubstituteDocument

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

ParamGetSubstituteDocument paramGetSubstituteDocument = new ParamGetSubstituteDocument();
paramGetSubstituteDocument.setCsvAnnulled(“CCVXXXXXXXXXXXXXCCSV”);
ResultGetSubstituteDocument result = ccsvClient.getSubstituteDocument(paramGetSubstituteDocument)
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de gestión de enlaces de documentos.

Método 'createDocumentLink'

Permite crear un enlace de un documento existente en otra carpeta determinada.

Ver detalles

Signatura

ResultCreateDocumentLink createDocumentLink(ParamCreateDocumentLink paramCreateDocumentLink).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateDocumentLink(hereda de ParamBase)
csv	String	Si(1)	Csv del documento que se quiere enlazar en otra carpeta.
id	String	Si(1)	Identificador del documento que se quiere enlazar en otra carpeta.
folderId	String	Si	Identificador de la carpeta donde se creará el link del documento.

NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateDocumentLink(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateDocumentLink

Código	Nombre	Descripción
180	ERROR_FOLDERID_NULO	Debe especificar el Id de la carpeta.
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.
101	ERROR_CONEXION_PAPIRO	Error de conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamCreateDocumentLink paramCreateDocumentLink = new ParamCreateDocumentLink();
paramCreateDocumentLink.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramCreateDocumentLink.setFolderId("059874j45444fff4");
ResultCreateDocumentLink result = ccsvClient.createDocumentLink(paramCreateDocumentLink);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteDocumentLink'

Elimina un enlace de un documento existente a una carpeta determinada.

Ver detalles

Signatura

ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamDeleteDocumentLink(hereda de ParamBase)
csv	String	Si(1)	Csv del documento cuyo enlace se quiere borrar.
id	String	Si(1)	Identificador del documento cuyo enlace se quiere borrar.
folderId	String	Si	Identificador de la carpeta donde se borrará el enlace con el documento.

NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteDocumentLink(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocumentLink

Código	Nombre	Descripción
180	ERROR_FOLDERID_NULO	Debe especificar el Id de la carpeta.
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.
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

ParamDeleteDocumentLink paramDeleteDocumentLink = new ParamDeleteDocumentLink();
paramDeleteDocumentLink.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramDeleteDocumentLink.setFolderId("09f54646511418");
ResultDeleteDocumentLink result = ccsvClient.deleteDocumentLink(paramDeleteDocumentLink);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de búsqueda.

Método 'search'

Realiza la búsqueda de documentos y expedientes en el gestor documental filtrando por los metadatos de los mismos.

Ver detalles

Signatura

ResultSearch search(ParamSearch paramSearchDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamSearch (hereda de ParamBase)
searchType	SearchType	Si	Tipo de búsqueda que se quiere realizar.
fileFilter	FileFilter[]	Si	Tipos de documentos que se desea buscar.
metadataList	String[]	No	Lista de metadatos que se desea recuperar como resultado. Si no se especifica, se devolverá un listado de id's
int	pageNumber	No	Indica el número de página de los resultados que se quiere obtener
int	pageSize	No	Indica el tamaño de página de los resultados que se quieren obtener
sortMetadataName	String	No	Nombre del metadato por el que se quiere ordenar los resultados de la búsqueda
sortType	SortType	No	Tipo de ordenación de los resultados por el metadato especificado
historical	Boolean	No	Indica si tiene que buscarse por históricos del organismo.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultSearch(hereda de ResultError)
documentSearchResult	DocumentSearchResult[]	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
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 'executeDQL'

Realiza una consulta DQL sobre el 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.

Ver detalles

Signatura

ResultExecuteDQL executeDQL(ParamExecuteDQL paramExecuteDQL).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamExecuteDQL(hereda de ParamBase)
dql	String	Si	Sentencia DQL que se desea ejecutar.
metadata	ArrayList<String>	No	Metadatos que queremos que se devuelvan la búsqueda.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultExecuteDQL(hereda de ResultError)
resultDQL	ArrayList<HashMap<String, Object>>	Array con los datos que se han devuelto de realizar la consulta DQL.

Códigos de error

Los errores de la invocación se encapsulan en ResultExecuteDQL

Código	Nombre	Descripción
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.

Ejemplo de invocación

Invocación

ParamExecuteDQL paramExecuteDQL = new ParamExecuteDQL();
String id="0906fca3801922bb";
String dql = "select * from dm_document where r_object_id='"+id+"'";
paramExecuteDQL.setDql(dql);
ResultExecuteDQL result = ccsvClient.executeDQL(paramExecuteDQL);
if(result.getReturnCode().equals(ReturnCode.OK){
	ArrayList<HashMap<String, Object>> resultDQL = result.getResultDQL();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

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:

Ver detalles

Signatura

ResultSearchDQL searchDQL(ParamSearchDQL paramSearchDQL).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamSearchDQL (hereda de ParamBase)
codDQL	String	Si	Identificador de la DQL
attributesRecovered	String[]	Si	Metadatos que queremos que devuelva la búsqueda.
attributesSearch	SearchAttribute[]	Si	Filtros de búsqueda
sortAttributes	SortAttribute[]	Si	Filtros de ordenación
maxResults	int	Si	Numero máximo de resultados
pagination	boolean	Si	Activar/Desactivar la paginación
resultsPerPage	int	Si	Resultados por pagina
page	int	Si	Numero de pagina a recuperar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultSearchDQL(hereda de ResultError)
resultDQL	ArrayList<HashMap<String, Object>>	Array con los datos que se han devuelto de realizar la consulta DQL.
numRegistrosEncontrados	int	Número total de registros obtenidos de la consulta

Códigos de error

Los errores de la invocación se encapsulan en ResultSearchDQL

Código	Nombre	Descripción
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.

Ejemplo de invocación

Invocación

metodo = "searchDQL";
String codDQL = "ExpedientesPAEGA";
String[] atributosRecuperados = new String[13];
atributosRecuperados[0] = "r_object_id";
atributosRecuperados[1] = "dea_ident_csv";
atributosRecuperados[2] = "expediente_estado";
atributosRecuperados[3] = "expediente_fecha_apertura";
atributosRecuperados[4] = "expediente_num_expediente";
atributosRecuperados[5] = "dea_desc_descripcion";
atributosRecuperados[6] = "dea_cont_codprocedimiento";
atributosRecuperados[7] = "dea_cont_nom_procedimiento";
atributosRecuperados[8] = "expediente_csv_indice";
atributosRecuperados[9] = "expediente_fecha_cierre";
atributosRecuperados[10] = "dea_desc_tipo_documento";
atributosRecuperados[11] = "dea_desc_estado";
atributosRecuperados[12] = "dea_ident_fecha_captura";
AtributoBusqueda[] atributosBusqueda = new AtributoBusqueda[4];
AtributoBusqueda atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("expediente_fecha_apertura");
atributoBusqueda.setOperator(">=");
atributoBusqueda.setValue("2017-01-01T00:00:00");
atributosBusqueda[0] = atributoBusqueda;
atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("expediente_fecha_apertura");
atributoBusqueda.setOperator("<=");
atributoBusqueda.setValue("2017-01-31T23:59:59");
atributosBusqueda[1] = atributoBusqueda;
atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("agente_ident_identificacion");
atributoBusqueda.setOperator("IN");
atributoBusqueda.setValue("00000000T");
atributosBusqueda[2] = atributoBusqueda;
atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("relacion_rol");
atributoBusqueda.setOperator("=");
atributoBusqueda.setValue("APORTADOR");
atributosBusqueda[3] = atributoBusqueda;
AtributoOrdenacion[] atributosOrdenacion = new AtributoOrdenacion[1];
AtributoOrdenacion atributoOrdenacion = new AtributoOrdenacion();
atributoOrdenacion.setName("expediente_fecha_apertura");
atributoOrdenacion.setSentido(AtributoOrdenacion.ORDENACION_DESCENDENTE);
atributosOrdenacion[0] = atributoOrdenacion;
int maxResultados = 100000;
boolean paginacion = true;
int numResultadosPagina = 10;
int pagina = 1;
RetSearchDQL retsearchDQL = accesoSGCE.searchDQL(papiroSession, codDQL, atributosRecuperados, atributosBusqueda, atributosOrdenacion, paginacion, maxResultados, numResultadosPagina, pagina, idPeticion);

Métodos de gestión de firmas.

Método 'createAndVerifySignature'

Verifica y almacena una firma en el gestor documental almacenando adicionalmente el documento según los parámetros.

Ver detalles

Signatura

ResultCreateAndVerifySignature createAndVerifySignature(ParamCreateAndVerifySignature paramCreateAndVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateAndVerifySignature(hereda de ParamBase)
document	Document	Si(2)	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
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
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.

Ver detalles

Signatura

ResultCreateWithoutVerifySignature createWithoutVerifySignature(ParamCreateWithoutVerifySignature paramCreateWithoutVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateWithoutVerifySignature (hereda de ParamBase)
document	Document	Si(2)	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
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
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamCreateWithoutVerifySignature paramCreateWithoutVerifySignature = new ParamCreateWithoutVerifySignature();
paramCreateWithoutVerifySignature.setDocument(document);
paramCreateWithoutVerifySignature.setCreateDocument(true);
paramCreateWithoutVerifySignature.setAttachedSignature(false);
ResultCreateWithoutVerifySignature result = ccsvClient.createWithoutVerifySignature(paramCreateWithoutVerifySignature);
if(result.getReturnCode().equals(ReturnCode.OK){
	String documentId = result.getDocumentId();
	String signatureId = result.getSignatureId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteSignature'

Servicio que elimina una firma vinculada a un documento.

Ver detalles

Signatura

ResultDeleteSignature deleteSignature(ParamDeleteSignature paramDeleteSignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamDeleteSignature(hereda de ParamBase)
signatureId	String	Si	Identificador de la firma en Documentum.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteSignature(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteSignature

Código	Nombre	Descripción
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.

Ejemplo de invocación

Invocación

ParamDeleteSignature paramDeleteSignature = new ParamDeleteSignature();
paramDeleteSignature.setId("0906fca3801922bb");
ResultDeleteSignature result = ccsvClient.deleteSignature(paramDeleteSignature);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateAndVerifySignature'

Verifica y reemplaza una firma en el gestor documental.

Ver detalles

Signatura

ResultUpdateAndVerifySignature updateAndVerifySignature(ParamUpdateAndVerifySignature paramUpdateAndVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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
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
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamUpdateAndVerifySignature paramUpdateAndVerifySignature = new ParamUpdateAndVerifySignature();
paramUpdateAndVerifySignature.setCSV("CSV3G2ZOOM5NGAG1CCSV");
paramUpdateAndVerifySignature.setSignature(signature);
paramUpdateAndVerifySignature.setSignatureId("0906fca380173f47");
paramUpdateAndVerifySignature.setSignatureType(com.tbsolutions.asf.util.Constants.CADES_FORMAT);
paramUpdateAndVerifySignature.setInitFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_T));
paramUpdateAndVerifySignature.setFinalFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_A));
paramUpdateAndVerifySignature.setAttachedSignature(false);
ResultUpdateAndVerifySignature result = ccsvClient.updateAndVerifySignature(paramUpdateAndVerifySignature);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateWithoutVerifySignature'

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.

Ver detalles

Signatura

ResultUpdateWithoutVerifySignature updateWithoutVerifySignature(ParamUpdateWithoutVerifySignature paramUpdateWithoutVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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
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
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.

Ver detalles

Signatura

ResultUpdateAndSignDocument updateAndSignDocument(ParamUpdateAndSignDocument paramUpdateAndSignDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamUpdateAndSignDocument (hereda de ParamBase)
document	Document	Si	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
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
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamUpdateAndSignDocument paramUpdateAndSignDocument = new ParamUpdateAndSignDocument();
paramUpdateAndSignDocument.setDocument(document);
paramUpdateAndSignDocument.setSignature(signature);
paramUpdateAndSignDocument.setSignatureType(com.tbsolutions.asf.util.Constants.CADES_FORMAT);
paramUpdateAndSignDocument.setInitFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_T));
paramUpdateAndSignDocument.setFinalFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_A));
paramUpdateAndSignDocument.setAttachedSignature(false);
ResultUpdateAndSignDocument result = ccsvClient.updateAndSignDocument(paramUpdateAndSignDocument);
if(result.getReturnCode().equals(ReturnCode.OK){
	String documentId = result.getDocumentId();
	String signatureId = result.getSignatureId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentSignatures'

Recupera una firma del gestor documental.

Ver detalles

Signatura

ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentSignatures(hereda de ParamBase)
id	String	Si(1)	Código identificador de la firma en el repositorio documental.
csv	String	Si(1)	Código ccsv de la firma en el repositorio documental.

NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentSignatures(hereda de ResultError)
signatures	ArrayList<Signature>	Listado de firmas de un documento.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentSignatures.

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV.
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado.
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
2019	ERROR_FILE_TOO_LARGE	El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE.
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.

Ejemplo de invocación

Invocación

ParamGetDocumentSignatures paramGetDocumentSignatures = new ParamGetDocumentSignatures();
paramGetDocumentSignatures.setId("0906fca3801922bb");
ResultGetDocumentSignatures result = ccsvClient.getDocumentSignatures(paramGetDocumentSignatures);
if(result.getReturnCode().equals(ReturnCode.OK){
	ArrayList<Signature> signatures = result.getSignatures();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de gestión de metadatos.

Método 'initializeDocumentMetadata'

Inicializa los metadatos del Documento proporcionado en función del tipo de documento o del tipo documental al que pertenezca.

Ver detalles

Signatura

ResultInitializeDocumentMetadata initializeDocumentMetadata(ParamInitializeDocumentMetadata paramInitializeDocumentMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamInitializeDocumentMetadata(hereda de ParamBase)
document	Document	Si	Documento cuyos metadatos es preciso inicializar.
documentType	String	No(1)	Firma del documento sin codificar en base64.
procedureCode	String	No	Código de procedimiento.

NOTA: Se recomienda rellenar siempre que sea posible el tipo de dcumento(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultInitializeDocumentMetadata(hereda de ResultError)
document	Document	Documento con los metadatos inicializados.

Códigos de error

Los errores de la invocación se encapsulan en ResultInitializeDocumentMetadata

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.

Ver detalles

Signatura

ResultInitializeStructuredMetadata initializeStructuredMetadata(ParamInitializeStructuredMetadata paramInitializeStructuredMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamInitializeStructuredMetadata (hereda de ParamBase)
metadataName	String	si	Nombre del metadato estructurado que se quiere inicializar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultInitializeStructuredMetadata(hereda de ResultError)
document	Document	Documento con la estructura de metadatos del metadato estructurado correspondiente.

Códigos de error

Los errores de la invocación se encapsulan en ResultInitializeStructuredMetadata

Código	Nombre	Descripción
147	ERROR_NOT_STRUCTUREDMETADATAID	El id facilitado no pertenece a un metadato estructurado.
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

ParamInitializeStructuredMetadata paramInitializeStructuredMetadata = new ParamInitializeStructuredMetadata();
paramInitializeStructuredMetadata.setMetadataName("agente");
ResultInitializeStructuredMetadata result = ccsvClient.initializeStructuredMetadata(paramInitializeStructuredMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	Document document = result.getDocument();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'verifyMetadataValue'

Verifica si un valor es correcto para un metadato simple proporcionado.

Ver detalles

Signatura

ResultVerifyMetadataValue verifyMetadataValue(ParamVerifyMetadataValue paramVerifyMetadataValue);.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamVerifyMetadataValue(hereda de ParamBase)
metadataName	String	Si	Nombre del metadato simple que se va a verificar.
value	String	Si	Valor que se quiere validar para ese metadato.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultVerifyMetadataValue (hereda de ResultError)
metadataValueVerification	MetadataValueVerification	Indica el nombre del metadato y el error por el cual no es válido el valor verificado.

Códigos de error

Los errores de la invocación se encapsulan en ResultVerifyMetadataValue

Código	Nombre	Descripción
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

ParamVerifyMetadataValue paramVerifyMetadataValue = new ParamVerifyMetadataValue();
paramVerifyMetadataValue.setMetadataName("dea_desc_estado");
paramVerifyMetadataValue.setValue("0");
ResultVerifyMetadataValue result = ccsvClient.verifyMetadataValue(paramVerifyMetadataValue);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getMetadataValueVerification().getErrorMessage());
	if (resultVerifyMetadataValue.getMetadataValueVerification() != null){
		MetadataValueVerification error = resultVerifyMetadataValue.getMetadataValueVerification();
	}
}

Método 'verifyDocumentMetadata'

Verifica si la estructura de metadatos de un documento es correcta respecto al tipo de documento indicado.

Ver detalles

Signatura

ResultVerifyDocumentMetadata verifyDocumentMetadata(ParamVerifyDocumentMetadata paramVerifyDocumentMetadata);.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamVerifyDocumentMetadata(hereda de ParamBase)
document	Document	Si(1)	Documento cuyos metadatos se quiere verificar.
documentType	String	Si	Tipo de documento del documento cuyos metadatos se quiere verificar.

NOTA:El parámetro "content" debera ir obligatoriamente nulo.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultVerifyDocumentMetadata(hereda de ResultError)
metadataValueVerificationList	List<MetadataValueVerification >	En caso de producirse errores en la validación de los metadatos del documento, almacena la lista de errores de validación.

Códigos de error

Los errores de la invocación se encapsulan en ResultVerifyDocumentMetadata

Código	Nombre	Descripción
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos.
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)
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamVerifyDocumentMetadata paramVerifyDocumentMetadata = new ParamVerifyMetadataValue();
paramVerifyDocumentMetadata.setDocument(document);
paramVerifyDocumentMetadata.setDocumentType("DECLARACION");
ResultVerifyDocumentMetadata result = ccsvClient.verifyDocumentMetadata(paramVerifyDocumentMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getMetadataValueVerification().getErrorMessage());
}

Método 'getMetadataValueList'

Devuelve la lista de valores para ese metadato.

Ver detalles

Signatura

ResultGetMetadataValueList getMetadataValueList(ParamGetMetadataValueList paramGetMetadataValueList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetMetadataValueList(hereda de ParamBase)
metadataName	String	Si(1)	Nombre del metadato tal y como se está dado de alta en Documentum.
metadataNameNTI	String	Si(1)	Nombre del metadato según la norma técnica de interoperabilidad(NTI)).
defaultOnly	boolean	Si	Indica si sólo se desea obtener el valor por defecto o todos los valores.

NOTA: En caso de rellenar el metadataName no se indicará el metadataNameNTI y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataValueList(hereda de ResultError)
metadataValueList	List<MetadataValue>	Lista de valores posibles del metadato indicado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataValueList

Código	Nombre	Descripción
154	ERROR_METADATANAME_METADATANAMEID_NULO	Debe indicar el nombre del metadato en Documentum o el nombre del metadato según la NTI.
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado
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

ParamGetMetadataValueList paramGetMetadataValueList = new ParamGetMetadataValueList();
paramGetMetadataValueList.setMetadata("dea_desc_estado");
paramGetMetadataValueList.setDefaultOnly(false);
ResultGetMetadataValueList result = ccsvClient.getMetadataValueList(paramGetMetadataValueList);
if(result.getReturnCode().equals(ReturnCode.OK){
	List<MetadataValue> metadataValueList = result.getMetadataValueList();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadataList'

Permite obtener la lista de metadatos de un tipo documental.

Ver detalles

Signatura

ResultGetMetadataList getMetadataList(ParamGetMetadataList paramGetMetadataList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetMetadataList(hereda de ParamBase)
documentumTypeName	String	Si(1)	Nombre del tipo del documento tal y como se está dado de alta en Documentum.
documentumTypeNameNTI	String	Si(1)	Nombre del tipo del documento según la norma técnica de interoperabilidad(NTI)).

NOTA: En caso de rellenar el documentumTypeName no se indicará el documentumTypeNameNTI y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataList(hereda de ResultError)
metadataList	List<Metadata>	Lista de valores posibles del metadato indicado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataList

Código	Nombre	Descripción
159	ERROR_DOCUMENTUMTYPENAME_NULO	Faltan los parámetros para identificar al tipo documental.
160	ERROR_DOCUMENTUMTYPE_NOEXISTE	No existe el tipo de documento indicado.
722	ERROR_GET_METADATALIST	No existe ningún metadato para ese tipo documental.
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

ParamGetMetadataList paramGetMetadataList = new ParamGetMetadataList();
paramGetMetadataList.setDocumentumTypeName("dga_paega_relacion");
ResultGetMetadataList result = ccsvClient.getMetadataList(paramGetMetadataList);
if(result.getReturnCode().equals(ReturnCode.OK){
	List<Metadata> metadataList = result.getMetadataList();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadata'

Servicio que devuelve los valores de los metadatos indicados de un documento almacenado en el sistema de gestión documental.

Ver detalles

Signatura

ResultGetMetadata getMetadata(ParamGetMetadata paramGetMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetMetadataList(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
metadataNames	String	Si	Nombres de los metadatos cuyos valores se quieren recuperar.

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadata(hereda de ResultError)
metadata	HashMap<String,Object>	Estructura que almacena por cada clave o nombre del metadato, los valores de los mismos.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadata

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV
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.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamGetMetadata paramGetMetadata = new ParamGetMetadata();
paramGetMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
String[] metadataNames = new String[3];
metadataNames[0] = "dea_desc_descripcion";
metadataNames[1] = "dea_desc_descriptores";
metadataNames[2] = "relacion";
paramGetMetadata.setMetadataNames(metadataNames);
ResultGetMetadata result = ccsvClient.getMetadata(paramGetMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	HashMap<String,Object> metadata = result.getMetadata();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'changeState'

Modifica el valor de un metadato simple concreto state.

Ver detalles

Signatura

ResultChangeState changeState(ParamChangeState paramchangeState).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamChangeState(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
state	String	Si	Nuevo valor para el estado del documento.
typeCopy	String	No	Nuevo tipo de copia del documento en Documentum.
traceData	TraceData	Si(2)	Datos de traza del cambio

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

NOTA 2 : En caso de cambiarse el documento a estado anulado habrá que rellenar el parámetro traceData.(2)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultChangeState(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultChangeState

Código	Nombre	Descripción
169	ERROR_CHANGESTATE	No se puede modificar el estado
197	ERROR_COPIA_SIMPLE_SIGN	Error al firmar con sello de órgano el documento cuando es tipo de copia simple.
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
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
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

ParamChangeState paramChangeState = new ParamChangeState();
paramChangeState.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramChangeState.setState("P");
ResultChangeState result = ccsvClient.changeState(paramChangeState);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'changeExternalLock'

Modifica el valor de un metadato simple concreto Lock.

Ver detalles

Signatura

ResultChangeExternalLock changeExternalLock(ParamChangeExternalLock paramChangeExternalLock).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamChangeExternalLock(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
documentLock	String	Si	Nuevo valor para el metadato bloqueo del documento.

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultChangeExternalLock(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultChangeExternalLock

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 SIU
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
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

ParamChangeExternalLock paramChangeExternalLock = new ParamChangeExternalLock();
paramChangeExternalLock.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramChangeExternalLock.setDocumentLock("S");
ResultChangeExternalLock result =ccsvClient.changeExternalLock(paramChangeExternalLock);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'changeDocumentVisibility'

Servicio que modifica el valor del metadato que indica si el documento es visible desde los portales públicos de acceso al ciudadano.

Ver detalles

Signatura

ResultChangeDocumentVisibility changeDocumentVisibility(ParamChangeDocumentVisibility paramChangeDocumentVisibility).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamChangeDocumentVisibility(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
documentVisibility	String	Si	Nuevo valor para la visibilidad del documento.

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultChangeDocumentVisibility(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultChangeDocumentVisibility

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 SIU
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
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

ParamChangeDocumentVisibility paramChangeDocumentVisibility = new ParamChangeDocumentVisibility();
paramChangeDocumentVisibility.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramChangeDocumentVisibility.setDocumentVisibility("N");
ResultChangeDocumentVisibility result = ccsvClient.changeDocumentVisibility(paramChangeDocumentVisibility);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":”+result.getErrorMessage());
}

Método 'getDocumentTypeList'

Recupera una lista de tipos de documentos, toda la lista para el modelo de metadatos actual o sólo los destacados.

Ver detalles

Signatura

ResultGetDocumentTypeList getDocumentTypeList(ParamGetDocumentTypeList paramDocumentTypeList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentTypeList(hereda de ParamBase)
highlight	boolean	Si	Indica si se desea obtener sólo los tipos de documentos más utilizados o todos

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentTypeList(hereda de ResultError)
documentTypeList	List<DocumentTypeList>	Lista de tipos de documento devueltos por el servicio

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentTypeList

Código	Nombre	Descripción
130	ERROR_BASEDATOS_CSVPAPIRO	Error al conectar con la base de datos CCSV.
718	ERROR_GET_HIGHLIGHT	No existe ningún tipo de documento destacado para ese modelo de metadatos.
130	ERROR_BASEDATOS_CSVPAPIRO	Error al conectar con la base de datos CCSV.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamGetDocumentTypeList paramGetDocumentTypeList = new ParamGetDocumentTypeList();
paramGetDocumentTypeList.setHighlight(true);
ResultGetDocumentTypeList result = ccsvClient.getDocumentTypeList(paramGetDocumentTypeList);
if(result.getReturnCode().equals(ReturnCode.OK){
	List<DocumentTypeList> documentTypeList = result.getDocumentTypeList ();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentXml'

Recupera el fichero xml del documento en base64.

Ver detalles

Signatura

ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentXml (hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	Código seguro de verificación del documento en Documentum.

NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentXml(hereda de ResultError)
base64	String	String en base64 del fichero xml.
nombre	String	Nombre por defecto del fichero resultante.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentXml

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

ParamGetDocumentXml paramGetDocumentXml = new ParamGetDocumentXml();
paramGetDocumentXml.setCsv("CSV0B31WVP5O1A21CCSV");
ResultGetADocumentXml result = ccsvClient.getDocumentXml(paramGetDocumentXml);
if(result.getReturnCode().equals(ReturnCode.OK){
	String base64Xml = resultGetDocumentXml.getBase64Xml();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadata'

Modifica los valores de los metadatos informados independientemente del tipo que sean estos.

Ver detalles

Signatura

ResultUpdateMetadata updateMetadata(ParamUpdateMetadata paramUpdateMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamUpdateMetadata(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	Código seguro de verificación del documento en Documentum.
newMetadata	HashMap<String,Object>	Si	Contiene los metadatos a actualizar.
addValues	boolean	Si	Indica si los valores se añaden a los existentes: true o se sustituyen los existentes por los que se pasan: false. Solo para metadatos repetitivos.
traceData	TraceData	Si	Contiene los datos de la traza de los cambios que se realizan.

NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateMetadata (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateMetadata

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

Ver detalles

Signatura

ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamUpdateMetadata(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	Código seguro de verificación del documento en Documentum.
metadataName	String	Si	Nombre del metadato que se quiere eliminar.
deleteAll	boolean	Si	Para metadatos repetitivos indica si se desean borrar todos los valores.
position	String	No	Indica la posición del metadato repetitivo que queremos borrar.

NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateMetadata (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateMetadata

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.
134	ERROR_POSICIONMETADATONOEXISTE	No existe metadato con ese orden o posición
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

ParamDeleteMetadata paramDeleteMetadata = new ParamDeleteMetadata();
paramDeleteMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramDeleteMetadata.setMetadataName("dea_desc_descriptores");
paramDeleteMetadata.setDeleteAll(false);
paramDeleteMetadata.setPosition("1");
ResultDeleteMetadata result = ccsvClient.deleteMetadata(paramDeleteMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de gestión de relaciones.

Método 'createRelationship'

Crea una relación entre documentos, pudiéndose especificar el rol de la relación, fecha de inicio y fecha de fin de la misma.

Ver detalles

Signatura

ResultCreateRelationship createRelationship(ParamCreateRelationship paramCreateRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateRelationship (hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idChild	String	Si(2)	Identificador del documento hijo de la relación en Documentum.
csvChild	String	Si(2)	Csv del documento hijo de la relación.
relationship	DocumentRelation	si	Datos propios de la relación.

NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1)

NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateRelationship

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
151	ERROR_RELACION_DATOS_NULO	Falta el parámetro con la información de la relación
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato
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

ParamCreateRelationship paramCreateRelationship = new ParamCreateRelationship();
paramCreateRelationship.setCsvParent("CSV0B31WVP5O1A21CCSV");
paramCreateRelationship.setCsvChild("CSVVV3X02P6OXAK1CCSV");
DocumentRelation relationship = new DocumentRelation();
relationship.setRole("Autoriza a")
paramCreateRelationship.setRelationship(relationship);
ResultCreateRelationship result = ccsvClient.createRelationship(paramCreateRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'createRelationships'

Crea una relación entre varios documentos y un mismo documento padre, pudiéndose especificar el rol de la relación, fecha de inicio y fecha de fin.

Ver detalles

Signatura

ResultCreateRelationships createRelationships(ParamCreateRelationships paramCreateRelationships).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateRelationships (hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idsChild	String[]	Si(2)	Identificador de los documentos hijo de la relación en Documentum.
csvsChild	String[]	Si(2)	Csv de los documentos hijo de la relación.
relationship	DocumentRelation	Si	Datos propios de la relación.

NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1)

NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateRelationships(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateRelationships

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
151	ERROR_RELACION_DATOS_NULO	Falta el parámetro con la información de la relación
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato
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

ParamCreateRelationship paramCreateRelationship = new ParamCreateRelationship();
paramCreateRelationship.setCsvParent("CSV0B31WVP5O1A21CCSV");
paramCreateRelationship.setCsvChild("CSVVV3X02P6OXAK1CCSV");
DocumentRelation relationship = new DocumentRelation();
relationship.setRole("Autoriza a")
paramCreateRelationship.setRelationship(relationship);
ResultCreateRelationship result = ccsvClient.createRelationship(paramCreateRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteRelationship '

Servicio que elimina una relación entre documentos.

Ver detalles

Signatura

ResultDeleteRelationship deleteRelationship (ParamDeleteRelationship paramDeleteRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamDeleteRelationship(hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idChild	String	Si(2)	Identificador del documento hijo de la relación en Documentum.
csvChild	String	Si(2)	Csv del documento hijo de la relación.

NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1)

NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateRelationships

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
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

ParamDeleteRelationship paramDeleteRelationship = new ParamDeleteRelationship();
paramDeleteRelationship.setCsvParent("CSV0B31WVP5O1A21CCSV");
paramDeleteRelationship.setCsvChild("CSVVV3X02P6OXAK1CCSV");
ResultDeleteRelationship result =ccsvClient.deleteRelationship(paramDeleteRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getRelatedDocuments'

Recupera relaciones de primer nivel entre documentos según los parámetros especificados.

Ver detalles

Signatura

ResultGetRelatedDocuments getRelatedDocuments(ParamGetRelatedDocuments paramGetRelatedDocuments).

Parámetros de invocación

Nombre	Tipo		Descripción
ParamGetRelatedDocuments(hereda de ParamBase)
id	String	Si(1)	Id del documento en Documentum cuyas relaciones queremos obtener.
csv	String	Si(1)	CSV del documento cuyas relaciones queremos obtener.
role	String[]	No	Rol de las relaciones que queremos obtener.
dateStart	String	No	Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados.
dateEnd	String	No	Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados.
addContent	boolean	Si	Indica si se añaden los contenidos de los documentos.
metadataNames	String[]	No	Nombres de los metadatos que queremos que nos muestre el objeto Document de vuelta.
searchType	DocumentRelationSearchType	Si	Tipo de búsqueda a realizar: indica si queremos recuperar los documentos hijos relacionados o los documentos padre relacionados.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetRelatedDocuments(hereda de ResultError)
documentTreeNodes	DocumentTreeNode	Array de documentos relacionados encontrados con los datos de la relación

Códigos de error

Los errores de la invocación se encapsulan en ResultGetRelatedDocuments

Código	Nombre	Descripción
152	ERROR_RELACION_ID_NULO	Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO
153	ERROR_RELACION_TIPOBUSQUEDA_NULO	Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados
148	ERROR_DOCUMENTOS_RELACIONADOS	No se han encontrado documentos relacionados para el documento seleccionado.
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos 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 SIU
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

ParamGetRelatedDocuments paramGetRelatedDocuments = new ParamGetRelatedDocuments();
paramGetRelatedDocuments.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetRelatedDocuments.setSearchType(DocumentRelationSearchType.CHILD);
ResultGetRelatedDocuments result = ccsvClient.getRelatedDocuments(paramGetRelatedDocuments);
if(result.getReturnCode().equals(ReturnCode.OK){
	DocumentTreeNodes[] = result.getDocumentTreeNodes();
}else{
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Método 'getAllRelatedDocuments'

Recupera todas las relaciones entre documentos según los parámetros especificados.

Ver detalles

Signatura

ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetAllRelatedDocuments(hereda de ParamBase)
id	String	Si(1)	Id del documento en Documentum cuyas relaciones queremos obtener.
csv	String	si(1)	CSV del documento cuyas relaciones queremos obtener.
role	String[]	No	Rol de las relaciones que queremos obtener.
dateStart	String	No	Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados.
dateEnd	String	No	Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados.
addContent	boolean	Si	Indica si se añaden los contenidos de los documentos.
metadataNames	String[]	No	Nombres de los metadatos que queremos que nos muestre del el objeto Document de vuelta.
searchType	DocumentRelationSearchType	Si	Tipo de búsqueda a realizar: indica si queremos recuperar los documentos hijos relacionados o los documentos padre relacionados.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetAllRelatedDocuments(hereda de ResultError)
documentTreeNodes	DocumentTreeNode	Array de documentos relacionados encontrados con los datos de la relación

Códigos de error

Los errores de la invocación se encapsulan en ResultGetAllRelatedDocuments

Código	Nombre	Descripción
152	ERROR_RELACION_ID_NULO	Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO
153	ERROR_RELACION_TIPOBUSQUEDA_NULO	Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados
148	ERROR_DOCUMENTOS_RELACIONADOS	No se han encontrado documentos relacionados para el documento seleccionado.
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos 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 SIU
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

ParamGetAllRelatedDocuments paramGetAllRelatedDocuments = new ParamGetAllRelatedDocuments();
paramGetAllRelatedDocuments.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetAllRelatedDocuments.setSearchType(DocumentRelationSearchType.CHILD);
ResultGetAllRelatedDocuments result =ccsvClient.getAllRelatedDocuments(paramGetAllRelatedDocuments);
if(result.getReturnCode().equals(ReturnCode.OK){
	DocumentTreeNode = result.getDocumentTreeNode();
}else{
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Métodos de gestión de trazas.

Método 'getTraces'

Recupera las trazas de un documento o expediente.

Ver detalles

Signatura

ResultGetTraces getTraces(ParamGetTraces paramGetTraces).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetTraces (hereda de ParamBase)
csv	String	Si(1)	Código CSV asociado al documento del que se quieren recuperar las trazas.
id	String	Si(1)	Identificador del documento del que se quieren recuperar las trazas

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetTraces(hereda de ResultError)
metadata	HashMap<String, Object>	Información en documentum relativa a la traza

Códigos de error

Los errores de la invocación se encapsulan en ResultGetTraces

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
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

ParamGetTraces paramGetTraces = new ParamGetTraces();
paramGetTraces.setCsv("CSV0B31WVP5O1A21CCSV");
ResultGetTraces result = ccsvClient.getTraces(paramGetTraces);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de gestión de relaciones de agentes.

Método 'addAgentRelationship'

Añade una nueva relación al documento con id o csv indicado guardando el cambio en documentum.

Ver detalles

Signatura

ResultAddAgentRelationship addAgentRelationship(ParamAddAgentRelationship paramAddAgentRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamAddAgentRelationship(hereda de ParamBase)
csv	String	Si(1)	Código csv asociado al documento en el que se quiere añadir la relación.
id	String	Si(1)	Identificador del documento en el que se quiere agregar la relación.
agentRelationship	AgentRelationship	Si	Contiene todos los datos de la relación a crear
traceData	TraceData	Si	Datos sobre la traza de la agregación de una nueva relación.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddAgentRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultAddAgentRelationship

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamAddAgentRelationship paramAddAgentRelationship = new ParamAddAgentRelationship();
paramAddAgentRelationship.setCsv("CSV0B31WVP5O1A21CCSV");
paramAddAgentRelationship.setAgentRelationship(agentRelationship);
ResultAddAgentRelationship result = ccsvClient.addAgentRelationship(paramAddAgentRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addAgentRelationships'

Añade relaciones al documento con id o csv indicado guardando el cambio en documentum.

Ver detalles

Signatura

ResultAddAgentRelationships addAgentRelationships(ParamAddAgentRelationships paramAddAgentRelationships)

Parámetros de invocación

Nombre	Tipo	Descripción
ParamAddAgentRelationship(hereda de ParamBase)
csv	String	Código csv asociado al documento en el que se quiere n añadir las relaciones.
id	String	Identificador del documento en el que se quieren agregar las relaciones.
agentRelationships	AgentRelationship[]	Contiene todos los datos de la relación a crear
traceData	TraceData	Datos sobre la traza de la creación de nuevas relaciones para el documento.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddAgentRelationships(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultAddAgentRelationships

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamAddAgentRelationships paramAddAgentRelationships = new ParamAddAgentRelationships();
paramAddAgentRelationships.setCsv("CSV0B31WVP5O1A21CCSV");
paramAddAgentRelationships.setAgentRelationships(agentRelationships);
ResultAddAgentRelationships result = ccsvClient.addAgentRelationships(paramAddAgentRelationships);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteAgentRelationship'

Elimina una relación del documento con id o csv indicado guardando el cambio en documentum.

Ver detalles

Signatura

ResultDeleteAgentRelationship deleteAgentRelationship(ParamDeleteAgentRelationship paramDeleteAgentRelationship);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamDeleteAgentRelationship(hereda de ParamBase)
csv	String	Si(1)	Código csv asociado al documento del que se va a eliminar la relación.
id	String	Si(1)	Identificador del documento del que se va a eliminar la relación.
agentRelationship	AgentRelationship	Si	Contiene todos los datos de la relación a borrar
traceData	TraceData	Si	Datos sobre la traza del borrado de la relación.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteAgentRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteAgentRelationship

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
183	ERROR_AGENTRELATIONSHIPIDNULO	Debe especificar el identificador dentro del parámetro agentRelationship
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
185	ERROR_AGENTRELATIONSHIP_NOEXIST	No existe para el documento indicado esa relación agente
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamDeleteAgentRelationship paramDeleteAgentRelationship = new
ParamDeleteAgentRelationship();
paramDeleteAgentRelationship.setCsv("CSV0B31WVP5O1A21CCSV");
paramDeleteAgentRelationship.setAgentRelationships(agentRelationship);
ResultDeleteAgentRelationship result = ccsvClient.deleteAgentRelationship(paramDeleteAgentRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateAgentRelationship'

Reemplaza una relación del documento con id o csv indicado guardando el cambio en documentum.

Ver detalles

Signatura

ResultUpdateAgentRelationship updateAgentRelationship(ParamUpdateAgentRelationship paramUpdateAgentRelationship);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamUpdateAgentRelationship(hereda de ParamBase)
csv	String	Si(1)	Código csv asociado al documento en el que se va a modificar la relación.
id	String	Si(1)	Identificador del documento en el que se va a modificar la relación.
agentRelationship	AgentRelationship	Si	Contiene todos los datos de la relación a borrar
traceData	TraceData	Si	Datos sobre la traza del borrado de la relación.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateAgentRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateAgentRelationship

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
158	ERROR_VERIFY_NOT_VALUELIST	Debe especificar el identificador dentro del parámetro agentRelationship.
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
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

ParamUpdateAgentRelationship paramUpdateAgentRelationship = new ParamUpdateAgentRelationship ();
paramUpdateAgentRelationship.setCsv("CSV0B31WVP5O1A21CCSV");
paramUpdateAgentRelationship.setAgentRelationship(agentRelationship);
ResultUpdateAgentRelationship result = ccsvClient.updateAgentRelationship(paramUpdateAgentRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getAgentRelationship'

Devuelve la relación del documento con id o csv indicado que tenga ese role o identificationNumber o ambos

Ver detalles

Signatura

ResultGetAgentRelationship getAgentRelationship(ParamGetAgentRelationship paramGetAgentRelationship);;

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetAgentRelationship(hereda de ParamBase)
csv	String	Si(1)	Código csv asociado al documento del que se quiere recuperar una relación
id	String	Si(1)	Identificador del documento del que se quiere recuperar una relación
role	String	Si(2)	Contiene el rol que se quiere recuperar.
identificationNumber	String	Si(2)	Código de identificación del agente: Número de NIF,

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1)

NOTA 2 : Se debe indicar por lo menos el role o el identificación number para que se identifique una única relación de agente.(2)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetAgentRelationship(hereda de ResultError)
agentRelationship	AgentRelationship	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
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

Ver detalles

Signatura

ResultGetAgentRelationships getAgentRelationships(ParamGetAgentRelationships paramGetAgentRelationships)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetAgentRelationships (hereda de ParamBase)
csv	String	Si(1)	Código csv asociado al documento del que se quiere recuperar una relación
id	String	Si(1)	Identificador del documento del que se quiere recuperar una relación
roles	String[]	No	Contiene los roles a buscar, si es null son todos
current	booelan	No	true: devuelve sólo los que no tienen ficha fin de relación o si la tienen que aún no se haya llegado a esa fecha
identificationNumber	String	No	Código de identificación del agente: Número de NIF.

NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetAgentRelationships (hereda de ResultError)
agentRelationships	AgentRelationship[]	Array de objetos AgentRelationship con el contenido de las relaciones agente recuperadas

Códigos de error

Los errores de la invocación se encapsulan en ResultGetAgentRelationships

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
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

ParamGetAgentRelationships paramGetAgentRelationships = new ParamGetAgentRelationships();
String[] roles = {DocumentumConstants.RolRelacion.APORTADOR,DocumentumConstants.RolRelacion.INTERESADO}
paramGetAgentRelationship.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetAgentRelationship.setRoles(roles);
ResultGetAgentRelationships result = ccsvClient.getAgentRelationships(paramGetAgentRelationships);
if(result.getReturnCode().equals(ReturnCode.OK){
	AgentRelationship[] agentRelationships = result.getAgentRelationships();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'generateIframeToken'

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.

Ver detalles

Signatura

ResultGenerateIframeToken generateIframeToken(ParamGenerateIframeToken paramGenerateIframeToken)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGenerateIframeToken (hereda de ParamBase)
csv	String	Si(1)	Código csv asociado al documento del que se quiere recuperar una relación
idDocumentum	String	Si(1)	Identificador del documento del que se quiere recuperar una relación

NOTA : en caso de indicar el idDocumentum del documento no habrá que indicar el csv y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGenerateIframeToken (hereda de ResultError)
token	String	Token que se genera a partir de los datos que se facilitan

Códigos de error

Los errores de la invocación se encapsulan en ResultGenerateIframeToken

Código	Nombre	Descripción
1402	MESSAGE_ERROR_GENERATE_TOKEN	Error creando el token

Ejemplo de invocación

Invocación

ParamGenerateIframeToken paramGenerateIframeToken = new ParamGenerateIframeToken();
paramGenerateIframeToken.setCsv("CSV0B31WVP5O1A21CCSV");
ResultGenerateIframeToken result = ccsvClient.generateIframeToken(paramGenerateIframeToken);
if(result.getReturnCode().equals(ReturnCode.OK){
	String token = result.getToken();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'validateIframeToken'

Valida el token que se pasa en la llamada del iframe para que el portal privado deje acceso.

Ver detalles

Signatura

ResultValidateIframeToken validateIframeToken(ParamValidateIframeToken paramValidateIframeToken);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamValidateIframeToken (hereda de ParamBase)
token	String	Si	Token generado por el iframe que se va a validar que se correcto.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultValidateIframeToken(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultValidateIframeToken

Código	Nombre	Descripción
1400	MESSAGE_ERROR_EXPIRED_TOKEN	El tiempo de vida del token ha expirado
1401	MESSAGE_ERROR_INVALID_TOKEN	El token no es valido.
1402	MESSAGE_ERROR_GENERATE_TOKEN	Error creando el token

Ejemplo de invocación

Invocación

ParamValidateIframeToken paramValidateIframeToken = new ParamValidateIframeToken();
paramValidateIframeToken.setToken("CSV0B31WVP5O1A21CCSV");
ResultValidateIframeToken result =ccsvClient.validateIframeToken(paramValidateIframeToken);
if(result.getReturnCode().equals(ReturnCode.OK){
	log.info("OK");
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentSubtypeList'

Recupera una lista de subtipos de documentos según un tipo de documento, toda la lista para el modelo de metadatos actual o sólo los destacados.

Ver detalles

Signatura

ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentSubtypeList (hereda de ParamBase)
documentTypeName	String	Si	Nombre del tipo de documento.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentSubtypeList (hereda de ResultError)
documentSubtypeList	List<DocumentSubtypeList>	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
	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 getDocument ya 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.

Método 'getSimpleMetadata'

Se recomienda usar el método getMetadata.

Método 'getRepetitiveSimpleMetadata'

Se recomienda usar el método getMetadata.

Método 'getRepetitiveSimpleMetadata'

Se recomienda usar el método getMetadata.

Método 'updateSimpleMetadata'

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.

Servicio ISendAdminFileCloudWSPortType

El protocolo de Remisión en la Nube pretende ser un estándar para el intercambio de expedientes electrónicos en formato ENI (Esquema Nacional de Interoperabilidad) entre dos administraciones públicas cualesquiera, sean estas administrativas o judiciales.

Método 'createDocumentXml'

Crea un documento XML.

Ver detalles

Signatura

ResultCreateDocumentXml createDocumentXml(ParamCreateDocumentXml paramCreateDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateDocumentXml (hereda de ParamBase)
xml	DataHandler	Si	Xml del documento
agent	Agent	Si	Relación con meta-dato estructurado de tipo agente
name	String	No	Nombre del documento
procedureCode	String	No	Código de procedimiento

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateDocumentXml(hereda de ResultError)
csv	String	Código csv asociado al documento que se ha creado.
name	String	Nombre del documento que se ha creado.
extension	String	Extensión del documento que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateDocumentXml

Código	Nombre	Descripción
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte
1208	ERROR_PARSE_XML	Hubo un error al leer los datos recibidos
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum
1214	ERROR_INDEX_FILE_EXIST	El documento eni ya existe.

Ejemplo de invocación

Invocación

ParamCreateDocumentXml paramCreateDocumentXml = new ParamCreateDocumentXml();
paramCreateDocumentXml.setAgent(agent);//se entiende que agent es Agent correctamente creado
paramCreateDocumentXml.setXml(documento);//se entiende que document es el Datahandler de un documento xml
ResultCreateDocumentXml result= cssvClient.createDocumentXml(paramCreateDocumentXml);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'createIndexXml'

Crea un índice para documentos XML.

Ver detalles

Signatura

ResultCreateIndexXml createIndexXml(ParamCreateIndexXml paramCreateIndexXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripición
ParamCreateIndexXml (hereda de ParamBase)
xml	DataHandler	Si	Xml del índice.
agent	Agent	Si	Relación con metadato estructurado de tipo agente
name	String	No	Nombre del documento índice.
procedureCode	String	No	Código de procedimiento
type	String	Si	Tipo del expediente donde se crea el índice.
number	String	Si	Numero del expediente donde se crea el índice.
description	String	Si	Descripción del expediente donde se crea el índice.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateIndexXml (hereda de ResultError)
csv	String	Código csv asociado al documento índice que se ha creado.
name	String	Nombre del documento índice que se ha creado.
extension	String	Extensión del documento índice que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateIndexXml

Código	Nombre	Descripción
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte
1208	ERROR_PARSE_XML	Hubo un error al leer los datos recibidos
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum
1214	ERROR_INDEX_FILE_EXIST	El documento eni ya existe.

Ejemplo de invocación

Invocación

ParamCreateIndexXml paramCreateIndexXml = new ParamCreateIndexXml();
paramCreateIndexXml.setName(“Nombre”);
paramCreateDocumentXml.setXml(documento);
paramCreateDocumentXml.setType("Tipo del expediente donde se crea el indice");
paramCreateDocumentXml.setNumber("Número del expediente donde se crea el indice");
paramCreateDocumentXml.setDescription("Descripción del expediente donde se crea el indice");
ResultCreateIndexXml result= cssvClient.createIndexXml(paramCreateIndexXml);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'prepareXmlToInside'

Prepara el documento xml de un expediente para su remisión a terceros.

Ver detalles

Signatura

void prepareXmlToInside(ParamPrepareXmlToInside paramPrepareXmlToInside)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamPrepareXmlToInside (hereda de ParamBase)
expedienteCSV	String	Si	CSV del Expediente
codigoDir3	String	Si	Código dir3.
userNif	String	Si	Nif de la persona que realiza la petición.
asunto	String	No	Asunto del xml que se prepara para enviar. Máximo 150 caracteres
adjuntoCSV	String	No	Código csv adjunto al documento que se prepara para enviar.
Id de la peticion	String	No	Id de la petición.
description	String	No	Descripción del expediente donde se crea el índice.
motivacion	String	No	Motivación. Máximo 256
plazoDisponibilidad	Date	No	Fecha limite hasta la que el expediente//documento esta disponible
flagAdminFileJustice	boolean	Si	Indica si se remite o no a justicia
paramSendJustice	ParamSendJustice	Si	Parámetros adicionales para remitir a justicia.

NOTA: En caso de indicar como true el parametro flagAdminFileJustice habra que indicar el objeto paramSendJustice.

Parámetros de respuesta

Al ser un método void, no devolverá nada.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetAdministrativeFile

Código	Nombre	Descripción
1200	ERROR_INSIDE_ALTA_EXPEDIENTE	Se ha producido un error con el servicio Inside
193	ERROR_BASEDATOS_CCSV	Error al conectar con la Base de Datos CSVs
801	GENERIC_ERROR	Error genérico procesando la petición

Ejemplo de invocación

Invocación

ParamPrepareXmlToInside prepareXmlToInside= new ParamPrepareXmlToInside();
paramPrepareXmlToInside.setExpedienteCSV("CSV5422552326");
paramPrepareXmlToInside.setCodigoDir3("asdasd");
paramPrepareXmlToInside.setUserNif("0000000T");
paramPrepareXmlToInside.setFlagAdminFileJustice("false");
ResultPrepareXmlToInside result= cssvClient.prepareXmlToInside(paramPrepareXmlToInside);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'accessIndexFile'

Sistema peticionario pide al sistema remitente (a través del nodo central), el acceso al índice del expediente indicando el token.

Ver detalles

Signatura

RespuestaAccesoIndiceExpedienteType accessIndexFile(PeticionAccesoIndiceExpedienteType peticionAccesoIndiceExpedienteType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
PeticionAccesoIndiceExpedienteType
peticion	PeticionType	Si	Tipo de documento.
token	StringTokenType	Si	Tipo de token

Parámetros de respuesta

Nombre	Tipo	Descripción
RespuestaAccesoIndiceExpedienteType

Códigos de error

Los errores de la invocación se encapsulan en RespuestaAccesoIndiceExpedienteType

Código	Nombre	Descripción
601	PETICION_ERROR	Se esperaba objeto petición.
602	PETICION_NULL	Falta petición.
603	TOKEN_NULL	Falta token.
604	TOKEN_NOT_EXIST	El token no existe.
606	DIR3_ERROR	La unidad DIR3 peticionada es errónea.
607	USER_ERROR	Usuario peticionario erróneo para el token.
609	TOKEN_INVALID	El token no es válido para el expediente solicitado.
500	ERROR_INTERNO	Error interno de inside

Ejemplo de invocación

Invocación

RespuestaAccesoIndiceExpedienteType respuesta= cssvClient.accesoIndiceExpedienteType(peticionAccesoIndiceExpedienteType.getPeticion(), peticionAccesoIndiceExpedienteType.getToken().getIdexpEni(),peticionAccesoIndiceExpedienteType.getToken().getCsv(),peticionAccesoIndiceExpedienteType.getToken().getUuid());
log.info(respuesta.getRespuesta().getCodigo()+":"+respuesta.getRespuesta().getDescripcion());

Método 'accessDocumentFile'

Sistema peticionario solicita documento de expediente Sistema remitente (sin pasar por Punto Único Justicia, ya se hablan directamente).

Ver detalles

Signatura

RespuestaAccesoDocumentoExpedienteType accessDocumentFile(PeticionAccesoDocumentoExpedienteType peticionAccesoDocumentoExpediente.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
PeticionAccesoDocumentoExpedienteType
peticion	PeticionType	Si	Tipo de documento.
token	StringTokenType	Si	Tipo de token
idDocumento	String	Si	Identificador del documento.

Parámetros de respuesta

Nombre	Tipo	Descripción
RespuestaAccesoDocumentoExpedienteType

Códigos de error

Los errores de la invocación se encapsulan en RespuestaAccesoDocumentoExpedienteType

Código	Nombre	Descripción
601	PETICION_ERROR	Se esperaba objeto petición.
602	PETICION_NULL	Falta petición.
603	TOKEN_NULL	Falta token.
604	TOKEN_NOT_EXIST	El token no existe.
606	DIR3_ERROR	La unidad DIR3 peticionada es errónea.
607	USER_ERROR	Usuario peticionario erróneo para el token.
609	TOKEN_INVALID	El token no es válido para el expediente solicitado.
500	ERROR_INTERNO	Error interno de inside

Ejemplo de invocación

Invocación

RespuestaAccesoDocumentoExpedienteType respuesta= cssvClient.accesoDocumentoExpediente(peticionAccesoDocumentoExpediente.getPeticion(),peticionAccesoDocumentoExpediente.getIdDocumento(),
peticionAccesoDocumentoExpediente.getToken().getIndexEni(),peticionAccesoDocumentoExpediente.getToken().getCsv(),peticionAccesoDocumentoExpediente.getToken().getUuid());log.error(respuesta.getRespuesta().getCodigo()+":"+respuesta.getRespuesta().getDescripcion());

Servicio CSVConsumerService

A continuación se muestran todos los métodos referentes a la consulta de documentos a través de CSVBroker.

Método 'getDocument'

Permite descargar un documento de cualquier administración dado un csv y un dir3

Ver detalles

Signatura

ResultGetDocument getDocument(ParamGetDocument paramGetDocument)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocument
csv	String	Si	Código CSV
dir3	String	No	Organismo que puede estar asociado al CSV

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocument
csvBrokerDocument	CsvBrokerDocument	Estructura de datos que contiene los datos obtenidos del documento o bien la lista de organismos que pueden contener al organismo asociado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocument

Código	Nombre	Descripción
1505	ERROR_GENERAL_CSV_BROKER	Error genérico al invocar a CSVBroker
1506	ERROR_CSV_BROKER_NOT_FOUND	No se ha encontrado el CSV
1507	ERROR_CSV_BROKER_ENDPOINT_ERROR	Endpoint de CSVBroker no encontrado
1508	ERROR_CSV_BROKER_WAIT	El documento no puede recuperarse, pero puede consultarse de nuevo pasado un tiempo

Ejemplo de invocación

Invocación

ParamGetDocument getDocument = new ParamGetDocument();
getDocument.setCsv("123456abcdef987654zwyvijk");
getDocument.setDir3("E04583801");
ResultGetDocument result = cssvClient.getDocument(getDocument);

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 IDocumentMetadataSignatureServicePortType, por lo que el resto de aplicaciones que deseen acceder a esta funcionalidad deberán utilizar este último servicio.

Estos servicios están descritos en detalle en la documentación para integradores de INSIDE: https://administracionelectronica.gob.es/ctt/inside/descargas

ANEXOS

Objetos comunes

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

Nombre	Tipo	Descripción
adminFileContent	Object	Contenido del expediente. Se estable como object ya que puede ser Document , AdministrativeFile o AdministrativeFileFolder
relations	AdministrativeFileRelation[]	Relaciones del documento relacionado con el expediente. Puede venir vacío si el expediente no tiene relaciones.

Objeto 'AdministrativeFileFolder'

Clase utilizada para almacenar la información de una carpeta de expediente.

Nombre	Tipo	Descripción
code	String	Código de la carpeta
name	String	Nombre de la carpeta
id	String	Identificador de la carpeta en Documentum

Objeto 'Signature'

Clase con la información de la firma y sus firmantes.

Nombre	Tipo	Descripción
id	String	Identificado de la firma en documentum.
data	String	Firma en base64.
date	String	Sello de tiempo.
stampExpirationDate	String	Fecha hasta la cual el sello es válido.
signatureType	String	Indica que tipo de firma se esta almacenando.
csvValue	String	Si signatureType es CSV, aquí se almacena el valor del CSV.
csvGenerationRegulation	String	Si signatureType es CSV, aquí indica la referencia a la Orden, Resolución o documento que define la creación del CSV.
signers	List<Signer>	Listado de firmantes.
additionalMetadata	Hashmap<String,Object>	Metadatos adicionales.

Objeto 'Signer'

Clase que contiene la información de un firmante.

Nombre	Tipo	Descripción
subject	String	Asunto del certificado del firmante.
issuer	String	Emisor del certificado.
serialNumber	String	Número de serie del certificado.
subjectKeyId	String	Subject key identifier del certificado.
level	int	Nivel del firmante.
stampExpirationDate	String	Fecha hasta la que es válido el sello de tiempo.
date	String	Fecha y hora de la firma sin validez legal.
timeStamp	String	Timestamp de la firma realizada por el firmante.
signatureFormat	String	Formato final de la firma realizada por el firmante.
signaturePolicyId	String	Identificador de la política de firma de la DGA.
signaturePolicyHash	String	Hash del fichero donde se describe la política de firma de la DGA.
location	String	Localización geográfica del firmante.
delegationText	String	Texto de delegación de la firma.
role	String	Rol o acción del firmante en el acto de firma (Valida, supervisa...)
position	String[]	Cargo o rol del firmante en el acto de firma.
agent	Agent	Relación con metadato estructurado de tipo agente.
additionalMetadata	HashMap<String, Object>	Metadatos adicionales.

Objeto 'Agent'

Clase donde se almacenan los metadatos de un Documento tipo Agente.

Nombre	Tipo	Descripción
entityType	String	Especifica el tipo de entidad que se describe; en este caso AGENTE
category	String	Indica la categoría dentro de la entidad. Dentro de agente las categorías pueden ser CIUDADANO, EMPLEADO PUBLICO u ORGANISMO
identificationType	String	Tipo de identificación utilizado
identificationNumber	String	Código de identificación del agente : NIF,ORGCode...
name	String	Nombre del agente.
organismName	String	En caso de categoría=EMPLEADO PUBLICO, indicar en este elemento el organismo a que pertenece.
organismResponsible	String	En caso de categoría=ORGANISMO, indicar en este elemento el responsable del organismo.
position	String	En caso de categoría=EMPLEADO PUBLICO, indicar en este elemento el cargo del funcionario.
positionDescription	String	En caso de categoría=EMPLEADO PUBLICO, indicar en este elemento la descripción del cargo del funcionario.
organismDepartment	String	En caso de categoría=EMPLEADO PUBLICO, indicar en este elemento el departamento del funcionario.
contactData	AgentContactData[]	Campo que almacenar los datos de contacto del agente.

Objeto 'AgentContactData'

Clase utilizada para almacenar la información de la persona de contacto

Nombre	Tipo	Descripción
type	String	Medio por el cual se contacta con el agente
value	String	Dato para contactar con el agente. En función del canal, aquí se guardará un número de teléfono, una dirección e-mail, etc

Objeto 'AgentRelationship'

Clase donde se almacenan los metadatos de un Documento tipo relación

Nombre	Tipo	Descripción
id	String	Identificador de la relación en documentum
entityType	String	Especifica el tipo de entidad que se describe; en este caso RELACION
category	String	Indica la categoría dentro de la entidad; en este caso AGENTE
role	String	Tipo de rol de la relación
dateStart	String	Fecha de inicio de la relación
dateEnd	String	Fecha de fin de la relación
agent	Agent	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
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
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

Nombre	Tipo	Descripción
document	Document	Objeto que contiene los datos del documento.
signature	Signature	Objeto que contiene los datos de la firma asociada al documento.

Objeto 'MetadataModel'

Clase utilizada para el almacenar la información de las versiones de los modelos de metadatos.

Nombre	Tipo	Descripción
metadataModelId	Long	Identificador del modelo de metadatos.
name	String	Nombre del modelo de metadatos.
description	String	Descripción del modelo de metadatos.
current	boolean	Indica si es el modelo de metadatos vigente.
historical	boolean	Indica si la versión ha sido alguna vez modelo de metadatos

Objeto 'DocumentType'

Clase utilizada para almacenar un tipo de documento.

Nombre	Tipo	Descripción
documentTypeId	Long	Identificador del tipo de documento.
name	String	Nombre del tipo de documento.
highlight	boolean	Indica si es un tipo de documento destacado.
documentumTypeId	Long	Referencia al tipo documental al que está asociado el tipo de documento.
documentumTypeName	String	Nombre del tipo documental al que está asociado el tipo de documento
metadataModelId	Long	Identificador del modelo de metadatos al que pertenece el tipo de documento.
description	String	Descripción del tipo de documento.
cloned	boolean	Indica si el tipo de documento se ha clonado de una versión del modelo de metadatos ya existene.

Objeto 'DocumentSubtypeList'

Clase con la información de un subtipo de documento.

Nombre	Tipo	Descripción
name	String	Nombre del tipo de documento.
documentTypeName	String	Nombre del tipo documental al que está asociado el tipo de documento
description	String	Descripción del tipo de documento.

Objeto 'DocumentumType'

Clase que almacena los datos sobre tipos documentales.

Nombre	Tipo	Descripción
documentumTypeId	Long	Identificador del tipo documental.
name	String	Nombre del tipo documental.
nameNTI	String	Nombre del tipo documental según la NTI.
description	String	Descripción del tipo documental.
cloned	boolean	Indica si el tipo documental ha sido clonado de una versión del modelo de metadatos anterior.
metadataModelId	Long	Referencia al modelo de metadatos al que pertenece.
documentumTypeParentId	Long	Identificador del tipo documental padre.
documentumTypeParentName	String	Nombre del tipo documental padre.

Objeto 'Metadata'

Clase que almacena los metadatos de un tipo documental.

Nombre	Tipo	Descripción
metadataId	Long	Identificador del metadato.
name	String	Nombre del metadato en Documentum.
nameNTI	String	Nombre del metadato según la NTI.
label	String	Etiqueta corta del metadato para mostrar en formularios de edición.
description	String	Descripción del metadato.
type	String	Tipo de dato a almacenar en el metadato.
typeSize	Integer	En caso de que el metadato sea de tipo cadena de texto, indica el tamaño máximo permitido.
repetitive	boolean	Indica si el metadato es repetitivo.
compulsary	boolean	Indica si el metadato es obligatorio.
visibility	Integer	Visibilidad del metadato.
editable	Integer	Editabilidad del metadato.
traceable	boolean	Indica si el metadato es traceable, es decir si su modificación debe generar una traza.
dateType	boolean	Indica si el metadato es de tipo fecha.
cloned	boolean	Indica si el metadato se ha clonado de una versión del modelo de metadatos anterior.
documentumTypeId	Long	Referencia al tipo documental al que pertenece
metadataTypeId	Long	Identificador del tipo de metadato.
metadataTypeName	String	Nombre del tipo de metadato.

Objeto 'MetadataValue'

Clase que almacena los posibles valores un metadato.

Nombre	Tipo	Descripción
metadataValueId	Long	Identificador del valor de metadato.
value	String	Valor del metadato.
description	String	Descripción del valor del metadato.
defaultValue	boolean	Indica si el valor es el valor por defecto.
repetitiveCompulsaryValue	boolean	Indica si el valor es de un metadato repetitivo y debe ser obligatorio. Se utiliza para roles de relación
metadataId	Long	Identificador del metadato al que pertenece.
cloned	boolean	Indica si el valor del metadato se ha clonado de una versión del modelo de metadatos anterior.

Objeto 'DocumentSearchResult'

Clase que se utiliza para guardar la información del resultado de una búsqueda documental.

Nombre	Tipo	Descripción
documentumId	String	Identificador del documento en el gestor documental.
metadata	HashMap<String, Object>	Metadatos solicitados del documento.

Objeto 'TraceData'

Clase que almacena los datos a cerca de la traza de cambios que se producen en un documento.

Nombre	Tipo	Descripción
reason	String	Razón por la cual se realiza la acción de actualización del documento.

Objeto 'Filter'

Clase que permite almacenar los filtros de búsqueda en las búsquedas por metadatos.

Nombre	Tipo	Descripción
FilterType	FilterType	Tipo de operador que se quiere aplicar al filtro.
name	String	Nombre del metadato por el que se desea filtrar.
Object	value	Valor del filtro que se quiere aplicar.

Objeto 'DocumentFilter'

Clase utilizada para almacenar la información del filtro de documentos.

Nombre	Tipo	Descripción
filters	Filter[]	Conjunto de criterios de búsqueda que se van a utilizar(en una misma rama)

Objeto 'FileFilter'

Clase que se utiliza para guardar la infromacion del filtro de busqueda.

Nombre	Tipo	Descripción
documentFilterList	DocumentFilter[]	Filtros que se van a aplicar de búsqueda.
relationshipType	String	Tipo documental de la relación a buscar cuando tipo de búsqueda es expediente.
documentumType	String	Tipo documental que se quiere buscar.
contentFilter	String[]	Palabras clave de búsqueda en el contenido del documento.

Objeto 'MetadataValueVerification'

Clase que se utiliza para almacenar el nombre del metadato y el error que ha dado la validación con respecto al modelo de metadatos actual.

Nombre	Tipo	Descripción
metadataName	String	Nombre del metadato.
errorMessage	String	Posibles errores que han dado en la validación con respecto al modelo de metadatos actual.

Objeto 'DocumentTypeList'

Clase que contiene la información de un tipo de documento.

Nombre	Tipo	Descripción
name	String	Nombre del tipo del documento.
description	String	Descripción del tipo del documento.

Objeto 'DocumentTreeNode'

Clase que almacena la información de un nodo documental

Nombre	Tipo	Descripción
document	Document	Contiene los metadatos asociados al documento
documentRelation	DocumentRelation	Contiene la relación del documento con el documento con el padre.
documentTreeNodes	DocumentTreeNode[]	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
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
DOCUMENTO	documento	Tipo de búsqueda realizada por documentos.
EXPEDIENTE	expediente	Tipo de búsqueda realizada por expedientes.

Enum 'SortType'

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
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
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
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
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
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
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
identificationType	String	Tipo identificación: agente_ident_tipo_identif
objectName	String	Nombre del objeto: object_name
creationDate	Date	Fecha de creación del agente: r_creation_date
objectType	String	Tipo de objeto: r_object_type

Servicios para la gestión de documentos

Servicio IDocumentMetadataSignatureServicePortType

Métodos de manejo de documentos.

Método 'createFolder'

Invocación

Método 'getFolderContents'

Invocación

Método 'createDocument'

Invocación

Método 'updateDocument'

Método 'updateDocumentAdv'

Invocación

Método 'getDocumentByCitizen'

Invocación

Método 'getDocument'

Método 'getDocumentAdv'

Invocación

Método 'getDocumentAndRegisterLog'

Invocación

Método 'updateRegisterLog'

Invocación

Método 'deleteDocument'

Invocación

Método 'getSubstituteDocument'

Invocación

Métodos de gestión de enlaces de documentos.

Método 'createDocumentLink'

Invocación

Método 'deleteDocumentLink'

Invocación

Métodos de búsqueda.

Método 'search'

Invocación

Método 'executeDQL'

Invocación

Método 'searchDQL'

Invocación

Métodos de gestión de firmas.

Método 'createAndVerifySignature'

Invocación

Método 'createWithoutVerifySignature'

Invocación

Método 'deleteSignature'

Invocación

Método 'updateAndVerifySignature'

Invocación

Método 'updateWithoutVerifySignature'

Invocación

Método 'updateAndSignDocument'

Invocación

Método 'getDocumentSignatures'

Invocación

Métodos de gestión de metadatos.

Método 'initializeDocumentMetadata'

Invocación

Método 'initializeStructuredMetadata'

Invocación

Método 'verifyMetadataValue'

Método 'verifyDocumentMetadata'

Invocación

Método 'getMetadataValueList'

Invocación

Método 'getMetadataList'

Invocación

Método 'getMetadata'

Invocación

Método 'changeState'

Invocación

Método 'changeExternalLock'

Invocación

Método 'changeDocumentVisibility'

Invocación

Método 'getDocumentTypeList'

Invocación

Método 'getDocumentXml'

Invocación

Método 'updateMetadata'

Invocación

Método 'deleteMetadata'

Invocación