En este apartado se exponen los servicios para integradores junto con parámetros de invocación, respuesta, errores y ejemplo de código java.

ÍNDICE DE SERVICIOS

Table of Contents

Servicio IAdministrativeFileServicePortType

A continuación se muestran todos los métodos referentes a la administración de expedientes. Los métodos que a continuación se definen permiten realizar las operaciones de apertura, recuperación, borrado de expedientes así como las operaciones necesarias para la incorporación de documentos o subexpedientes al expediente.

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

...

Recupera un expediente a partir del CSV u oid del mismo. Permite indicar los metadatos a devolver, si se desea recuperar todos los contenidos del expediente, si se desea recuperar el índice actual y si se desea la firma asociada al índice.

Expand

title	Ver detalles

Signatura

ResultGetAdministrativeFile getAdministrativeFile(ParamGetAdministrativeFile paramGetAdministrativeFile).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAdministrativeFile (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente a consultar.
id	String	Si(1)	OID del expediente a consultar.
metadata	String[]	No(por defecto añade todos)	Array de los metadatos que se quieren recuperar.
includeIndexContext	boolean	Si	Indica si se desea recuperar el índice actual del expediente.
includeContent	boolean	Si	Indica si se desean recuperar los contenidos de los documentos del expediente.
attachIndexSignature	boolean	Si	Indica si se desea recuperar la firma asociada al índice.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetAdministrativeFile (hereda de CCSV_3.5.0_Manual de integración#ResultError)
adminFile	CCSV_3.5.0_Manual de integración#AdministrativeFile	Documento con el índice y metadatos del expediente.
adminFileContents	CCSV_3.5.0_Manual de integración#AdministrativeFileRelation[]	Contenidos del expediente.
signatures	ArrayList<CCSV_3.5.0_Manual de integración#Signature>	Firmas asociadas al índice del expediente.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetAdministrativeFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	No se ha especificado el id o el CSV del expediente.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamGetAdministrativeFile paramGetAdministrativeFile = new
ParamGetAdministrativeFile();
paramGetAdministrativeFile.setId("0906fca3801922bb");
paramGetAdministrativeFile.setIncludeContent(false);
paramGetAdministrativeFile.setAttachIndexSignature(false);
ResultGetAdministrativeFile result =ccsvClient.getAdministrativeFile(paramGetAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFile adminFile =result.getAdminFile();
	AdministrativeFileRelation[] adminFileContents=result.getAdminFileContents();
	ArrayList<Signature> signatures=result.getSignatures();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentXml'

...

Recupera el documento xml del expediente codificado en Base64

Expand

title	Ver detalles

Signatura

ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentXml(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente a consultar.
id	String	Si(1)	OID del expediente a consultar.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocumentXml(hereda de CCSV_3.5.0_Manual de integración#ResultError)

base64Xml

String

Documento en xml de la respuesta codificado en base64.

id

String

Id del documento de la respuesta.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentXml

Código	Nombre	Descripción
148	ERROR_DOCUMENTOS_RELACIONADOS	No se han encontrado documentos relacionados para el documento seleccionado
1042	ERROR_XML_ADMINFILE_EMPTY	El expediente debe tener contenido
1206	THREAD_ERROR	Hubo un error al generar uno o más de los documentos Eni
193	ERROR_BASEDATOS_CCSV	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

Code Block


ParamGetDocumentXml paramGetDocumentXml = new ParamGetDocumentXml();
ParamGetDocumentXml.setCsv("CCSV54641878471CCSV");
ResultGetDocumentXml result =ccsvClient.getDocumentXml (paramGetDocumentXml);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'initializeAdministrativeFileMetadata'

...

Inicializa los metadatos del expediente electrónico en función de los parámetros aportados y, opcionalmente, de un documento ya existente en el gestor documental

Expand

title	Ver detalles

Signatura

ResultInitializeAdministrativeFileMetadata initializeAdministrativeFileMetadata(ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamInitializeAdministrativeFileMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
applicationCode	String	Si	Código de aplicación que da de alta el expediente
applicationName	String	Si	Nombre de aplicación que da de alta el expediente
type	String	Si	Tipo del expediente
number	String	Si	Número del expediente
name	String	Si	Nombre del expediente
description	String	Si	Descripción del expediente
date	Date	Si	Fecha de apertura del expediente
procedureCode	String	No	Código de procedimiento asociado al expediente
adminFileContentCsv	String	No(1)	CSV del documento contenido en el expediente si ya existe
adminFileContentId	String	No(1)	Id del documento contenido en el expediente si ya existe

NOTA: En caso de indicar el adminFileContentCsv no habrá que indicar el adminFileContentId y vicercersa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultInitializeAdministrativeFileMetadata(hereda de CCSV_3.5.0_Manual de integración#ResultError)
adminFile	CCSV_3.5.0_Manual de integración#AdministrativeFile	Documento con el índice y metadatos del expediente
adminFileContents	CCSV_3.5.0_Manual de integración#AdministrativeFileRelation[]	Contenidos del expediente
signatures	ArrayList<CCSV_3.5.0_Manual de integración#Signature>	Firmas asociadas al índice del expediente

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultInitializeAdministrativeFileMetadata

Código	Nombre	Descripción
1005	ERROR_ADMINFILE_NAMENULO	Debe especificar el parámetro name con el nombre del expediente
1006	ERROR_ADMINFILE_DESCRIPTIONNULO	Debe especificar el parámetro description con la descripción del expediente
1009	ERROR_ADMINFILE_APPLICODENULO	Debe especificar el código de aplicación
1010	ERROR_ADMINFILE_APPLINAMENULO	Debe especificar el nombre de aplicación
1011	ERROR_ADMINFILE_NUMBERNULO	Debe especificar el número del expediente
1012	ERROR_ADMINFILE_TYPERNULO	Debe especificar el tipo del expediente
1022	ERROR_ADMINFILE_DATENULO	Debe especificar la fecha de apertura del expediente
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata = new ParamInitializeAdministrativeFileMetadata ();
paramInitializeAdministrativeFileMetadata .setApplicationCode("CodigoAplicación");
paramInitializeAdministrativeFileMetadata .setApplicationId("IdAplicacion");
paramInitializeAdministrativeFileMetadata .setApplicationName("NombreAplicación");
paramInitializeAdministrativeFileMetadata .setType("tipoExpediente");
paramInitializeAdministrativeFileMetadata .setNumber("numeroExpediente");
paramInitializeAdministrativeFileMetadata .setName("nombreExpediente");
paramInitializeAdministrativeFileMetadata .setDescription("descripción");
paramInitializeAdministrativeFileMetadata .setDate(new Date());
ResultInitializeAdministrativeFileMetadata result = ccsvClient.initializeAdminFileMetadata(paramInitializeAdminFileMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFile administrativeFile =result.getAdministrativeFile();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
/**
* Faltarían metadatos obligatorios, esto es solo un ejemplo de uso.
*/
ParamVerifyDocumentMetadata paramVerifyDocumentMetadata = new ParamVerifyDocumentMetadata();
paramVerifyDocumentMetadata.setDocument(administrativeFile);
paramVerifyDocumentMetadata.setDocumentType("EXPEDIENTE");
ResultVerifyDocumentMetadata result2 = ccsvClient.verifyDocumentMetadata (paramVerifyDocumentMetadata);
if(result2.getReturnCode().equals(ReturnCode.ERROR){
	for (int i=0;i<result2.getMetadataValueVerificationList().size();i++){
		System.out.println(result2.getMetadataValueVerificationList().get(i));
	}
}

Método 'openAdministrativeFile'

...

Crea un nuevo expediente en estado "Abierto" proporcionándole un documento asociado al mismo

Expand

title	Ver detalles

Signatura

ResultOpenAdministrativeFile openAdministrativeFile(ParamOpenAdministrativeFile paramOpenAdministrativeFile)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamOpenAdministrativeFile(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
adminFile	CCSV_3.5.0_Manual de integración#AdministrativeFile	Si	Documento con el índice y metadatos del expediente
folderId	String	No	Identificador de la carpeta de Documentum
aclName	String	No	Nombre de la lista de control de accesos al fichero
signedDocument	CCSV_3.5.0_Manual de integración#SignedDocument	(1)	Documento contenido en el expediente
adminFileContentCsv	String	(2)	CSV del documento contenido en el expediente si ya existe
adminFileContentId	String	(2)	Id del documento contenido en el expediente si ya existe
createAdminFileContent	boolean	Si	Indica si el documento contenido en el expediente existe o hay que crearlo

NOTA : si createAdminFileContent es true signedDocument sera obligatorio (1) ,en caso de ser falso habrá que indicar o el Csv o el id en documentum(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultOpenAdministrativeFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

id

String

Identificador en Documentum del expediente creado.

adminFileContentId

String

Identificador en Documentum del documento contenido creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultOpenAdministrativeFile

Código	Nombre	Descripción
1021	ERROR_ADMINFILENULO	Debe especificar el adminFile con todos los datos del expediente.
1003	ERROR_ADMINFILE_CSVNULO	Debe especificar el valor del CSV del expediente
1005	ERROR_ADMINFILE_NAMENULO	Debe especificar el parametro name con el nombre del expediente
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1008	ERROR_ADMINFILE_DOC_CONTENIDO_NULO	Debe especificar un documento contenido y su firma
1009	ERROR_ADMINFILE_APPLICODENULO	Debe especificar el código de aplicación
1010	ERROR_ADMINFILE_APPLINAMENULO	Debe especificar el nombre de aplicación
1011	ERROR_ADMINFILE_NUMBERNULO	Debe especificar el número del expediente
1012	ERROR_ADMINFILE_TYPERNULO	Debe especificar el tipo del expediente
1019	ERROR_ADMINFILE_OPENORIGINALCOPIA	No se puede abrir un expediente con un documento que no esté en estado Original o Copia
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamOpenAdministrativeFile paramOpenAdministrativeFile = new ParamOpenAdministrativeFile();
//adminFile es un AdministrativeFile inicializado y ya con todos los datos.
paramOpenAdministrativeFile.setAdminFile(adminFile);
paramOpenAdministrativeFile.setCreateAdminFileContent(false);
paramOpenAdministrativeFile.setAdminFileContentCsv("CSV25754872574CCSV");
ResultOpenAdministrativeFile result =ccsvClient.openAdministrativeFile(paramOpenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	String id =result.getId();
	String adminFileContentId =result.getAdminFileContentId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'closeAdministrativeFile'

...

Pasa el expediente a estado "Cerrado". En caso de contener subexpedientes también realiza el cerrado de los mismos.

Expand

title	Ver detalles

Signatura

ResultCloseAdministrativeFile closeAdministrativeFile(ParamCloseAdministrativeFile paramCloseAdministrativeFile)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCloseAdministrativeFile (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente del expediente a cerrar.
id	String	Si(1)	Identificador del expediente a cerrar.
date	Date	No	Fecha de cierre del expediente.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultCloseAdministrativeFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCloseAdministrativeFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamCloseAdministrativeFile paramCloseAdministrativeFile = new ParamCloseAdministrativeFile();
paramCloseAdministrativeFile.setCsv("CSV6587268741454CCSV");
ResultCloseAdministrativeFile result = ccsvClient.closeAdministrativeFile(paramCloseAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'reopenAdministrativeFile'

...

Cambia el estado de un expediente a estado abierto (si esta cerrado). En caso de contener subexpedientes, tambien los vuelve a abrir.

Expand

title	Ver detalles

Signatura

ResultReopenAdministrativeFile reopenAdministrativeFile(ParamReopenAdministrativeFile paramReopenAdministrativeFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamReopenAdministrativeFile(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente del expediente a reabrir.
id	String	Si(1)	Identificador del expediente a reabrir.
date	Date	No	Fecha de reapertura del expediente.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultReopenAdministrativeFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultReopenAdministrativeFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
104	ERROR_REEMPLAZAR_PAPIRO	[PAPIRO] Error al intentar reemplazar el documento.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamReopenAdministrativeFile paramReopenAdministrativeFile = new ParamReopenAdministrativeFile();
paramReopenAdministrativeFile.setCsv("CCSV54641878471CCSV");
paramReopenAdministrativeFile.setDate(new Date());
ResultReopenAdministrativeFile result = ccsvClient.reopenAdministrativeFile(paramReopenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'changeAdministrativeFileState'

...

Permite cambiar el estado del expediente. Los cambios posibles serán:

De Abierto a Cerrado
De Abierto a Índice para Remisión Cerrado.

En ambos casos si el expediente contiene subexpedientes se cambiará el estado de los mismos al mismo estado que el expediente que los contiene.

Expand

title	Ver detalles

Signatura

ResultChangeAdministrativeFileState changeAdministrativeFileState(ParamChangeAdministrativeFileState paramChangeAdministrativeFileState);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeAdministrativeFileState(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente a cambiar de estado.
id	String	Si(1)	Identificador del expediente a cambiar de estado.
state	String	Si	Nuevo estado del expediente.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultChangeAdministrativeFileState(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultChangeAdministrativeFileState

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1013	ERROR_ADMINFILE_STATENULO	Debe especificar el estado del expediente
1024	ERROR_ADMINFILE_CHANGESTATE	El expediente sólo se puede cambiar a estado Cerrado o a Índice para Remisión Cerrado
1023	ERROR_ADMINFILE_CHANGESTATE_NOTOPEN	No se puede cambiar el estado si el expediente no está abierto
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamChangeAdministrativeFileState paramChangeAdministrativeFileState = new ParamChangeAdministrativeFileState();
paramChangeAdministrativeFileState.setCsv("CSV854546458461CCSV");
paramChangeAdministrativeFileState.setState(DocumentumConstants.EstadoExpediente.INDICE_REMISION_CERRADO);
ResultChangeAdministrativeFileState result = ccsvClient.changeAdministrativeFileState(paramChangeAdministrativeFileState);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos para la gestión de índices de expedientes.

Método 'getAdministrativeFileIndex'

...

Recupera el índice del expediente

Expand

title	Ver detalles

Signatura

ResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAdministrativeFileIndex (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del indice del expediente a consultar.
id	String	Si(1)	Identificador del indice del expediente a consultar.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetAdministrativeFileIndex(hereda de CCSV_3.5.0_Manual de integración#ResultError)

content

DataHandler

Contenido del índice electrónico del expediente electrónico administrativo

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetAdministrativeFileIndex

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1034	ERROR_ADMINFILE_STATENULO	El índice del expediente solicitado está pendiente de regenerarse
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex = new ParamGetAdministrativeFileIndex();
paramGetAdministrativeFileIndex.setId("0906fca3801922bb");
ResultGetAdministrativeFileIndex result = ccsvClient.getAdministrativeFileIndex(paramGetAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
	DataHandler content = result.getContent();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'regenerateAdministrativeFileIndex'

...

Regenera el índice del expediente dejando el índice antiguo en un documento aparte con relación con rol: "ES VERSIÓN DE". Recuperando si se indica en los parámetros, el objeto expediente con el índice regenerado o su firma.

Expand

title	Ver detalles

Signatura

ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamRegenerateAdministrativeFileIndex (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente del expediente del que se va a regenerar el indice.
id	String	Si(1)	Identificador del expediente del que se va a regenerar el indice.
includeAdminFile	boolean	No(2)	Indica si se desea recuperar el objeto expediente con el índice regenerado
attachIndexSignature	boolean	No(2)	Indica si se desea recuperar la firma asociada al índice

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

NOTA 2 : Si no se indican por defecto son falsos.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultRegenerateAdministrativeFileIndex (hereda de CCSV_3.5.0_Manual de integración#ResultError)

adminFile

CCSV_3.5.0_Manual de integración#AdministrativeFile

Documento con el índice y metadatos del expediente

signatures

ArrayList<CCSV_3.5.0_Manual de integración#Signature>

Firmas asociadas al índice del expediente

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultRegenerateAdministrativeFileIndex

Código	Nombre	Descripción
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex = new ParamRegenerateAdministrativeFileIndex();
paramRegenerateAdministrativeFileIndex.setId("0906fca3801922bb");
paramRegenerateAdministrativeFileIndex.setIncludeAdminFile(true);
ResultRegenerateAdministrativeFileIndex result = ccsvClient.regenerateAdministrativeFileIndex(paramRegenerateAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFile adminFile = result.getAdminFile();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos para la gestión de los contenidos de los expedientes.

Método 'addDocumentToAdminFile'

...

Añade un documento existente en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el documento con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo, siempre y cuando el estado del documento sea original o copia.

Expand

title	Ver detalles

Signatura

ResultAddDocumentToAdminFile addDocumentToAdminFile(ParamAddDocumentToAdminFile paramAddDocumentToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentToAdminFile(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente donde se va a añadir el documento.
id	String	Si(1)	Identificador del expediente donde se va a añadir el documento.
contentCsv	String	Si(2)	CSV del documento a añadir
contentId	String	Si(2)	Identificador del documento a añadir
adminFileFolderCode	String	No(3)	Código de la carpeta donde incluir el documento.
adminFileFolderId	String	No(3)	Identificador de la carpeta donde incluir el documento.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentCsv no se rellena el contentId y viceversa.(2)

NOTA 3: Si se rellena el adminFileFolderCodeno se rellena el adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddDocumentToAdminFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddDocumentToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1001	ERROR_OPEN_STATE	No existe esa carpeta en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamAddDocumentToAdminFile paramAddDocumentToAdminFile = new ParamAddDocumentToAdminFile();
paramAddDocumentToAdminFile.setId("0906fca3801922bb");
paramAddDocumentToAdminFile.setContentId("0907lca3801958jk");
ResultAddDocumentToAdminFile result = ccsvClient.addDocumentToAdminFile(paramAddDocumentToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addNewDocumentToAdminFile'

...

Archiva el documento proporcionado en Documentum y lo incorpora a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el documento con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encarge de regenerarlo, siempre y cuando el documento que se pasa al método venga junto con su firma.

Expand

title	Ver detalles

Signatura

ResultAddNewDocumentToAdminFile addNewDocumentToAdminFile(ParamAddNewDocumentToAdminFile paramAddNewDocumentToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddNewDocumentToAdminFile (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente donde se va a añadir el documento.
id	String	Si(1)	Identificador del expediente donde se va a añadir el documento.
signedDocument	CCSV_3.5.0_Manual de integración#SignedDocument	Si(3)	Documento que se desea incorporar al expediente junto con su firma.
folderId	String	No	Identificador de la carpeta de Documentum
aclName	String	No	Nombre de la lista de control de accesos al fichero
adminFileFolderCode	String	No(2)	Código de la carpeta donde incluir el documento.
adminFileFolderId	String	No(2)	Identificador de la carpeta donde incluir el documento.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el adminFileFolderCodeno se rellena el adminFileFolderId y viceversa.(2)

NOTA 3: Es obligatorio en el signedDocument el documento contenido, puede estar sin firmar ( no se añadirá al
índice hasta que no se firme).(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddNewDocumentToAdminFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

id

String

Identificador del documento creado

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddNewDocumentToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1008	ERROR_ADMINFILE_DOC_CONTENIDO_NULO	Debe especificar un documento contenido y su firma
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1001	ERROR_OPEN_STATE	No existe esa carpeta en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamAddNewDocumentToAdminFile paramAddNewDocumentToAdminFile = new ParamAddNewDocumentToAdminFile();
//signedDocument es un objeto SignedDocument que contiene todos los datos del documento
contenido que queremos crear y su firma
paramAddNewDocumentToAdminFile.setSignedDocument(signedDocument);
paramAddNewDocumentToAdminFile.setCsv("CSV545646546841456CCSV");
ResultAddNewDocumentToAdminFile result = ccsvClient.addNewDocumentToAdminFile(paramAddNewDocumentToAdminFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	String id = result.getId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addDocumentsToAdminFile'

...

Añade una relación de documentos existentes en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y los documentos con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultAddDocumentsToAdminFile addDocumentsToAdminFile(ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentsToAdminFile (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente donde se va a añadir el documento.
id	String	Si(1)	Identificador del expediente donde se va a añadir el documento.
contentsCsv	String[]	Si(2)	Array de CSV's de los documentos a añadir.
contentsId	String[]	Si(2)	Array de Identificadores de los documentos a añadir.
adminFileFolderCode	String	No(3)	Código de la carpeta donde incluir el documento.
adminFileFolderId	String	No(3)	Identificador de la carpeta donde incluir el documento.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentsCsv no se rellena el contentsId y viceversa.(2)

NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddDocumentsToAdminFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddDocumentsToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1014	ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS	Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente.
1015	ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP	Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente.
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado.
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile = new ParamAddDocumentsToAdminFile();
// añadimos 2 documentos ya existentes identificados por su id en una carpeta de un expediente
paramAddDocumentsToAdminFile.setId("0906fca3801922bb");
String[] ids = {"0907lca3801958jk", "0907lca3587459jk"}
paramAddDocumentsToAdminFile.setContentsId(ids);
paramAddDocumentsToAdminFile.setAdminFileFolderCode("codigoCarpeta");
ResultAddDocumentsToAdminFile result = ccsvClient.addDocumentsToAdminFile(paramAddDocumentsToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addNewDocumentsToAdminFile'

...

Archiva los documentos proporcionados en Documentum y los incorpora a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y los documentos con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo. Si ninguno de los documentos proporcionados va firmado no se regenerará el índice.

Expand

title	Ver detalles

Signatura

ResultAddNewDocumentsToAdminFile addNewDocumentsToAdminFile (ParamAddNewDocumentsToAdminFile paramAddNewDocumentsToAdminFile );

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddNewDocumentsToAdminFile (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente donde se va a añadir el documento.
id	String	Si(1)	Identificador del expediente donde se va a añadir el documento.
documents	CCSV_3.5.0_Manual de integración#SignedDocument[]	Si(2)	Array de documentos que se desean incorporar al expediente y sus firmas.
folderId	String	No	Identificador de la carpeta de Documentum.
aclName	String	No	Nombre de la lista de control de accesos al fichero.
adminFileFolderCode	String	No(3)	Código de la carpeta donde incluir el documento.
adminFileFolderId	String	No(3)	Identificador de la carpeta donde incluir el documento.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Es obligatorio en el signedDocument[] un mínimo de un documento contenido, los documentos pueden
estar sin firmar (no se añadirá al índice hasta que no se firme.)(2)

NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddNewDocumentsToAdminFile(hereda de CCSV_3.5.0_Manual de integración#ResultError)

id

String[]

Identificadores de los documentos creados

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddNewDocumentsToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1016	ERROR_ADMINFILE_DOC_CONTENIDOS_NULO	Debe especificar el array con los documentos que contiene el expediente
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado.
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamAddNewDocumentsToAdminFile paramAddNewDocumentsToAdminFile = new ParamAddNewDocumentsToAdminFile();
//signedDocuments es un objeto SignedDocument[] que contiene todos los datos de los documentos contenido que queremos crear y sus firmas
paramAddNewDocumentToAdminFile.setSignedDocument(signedDocuments);
paramAddNewDocumentToAdminFile.setCsv("CSV545646546841456CCSV");
ResultAddNewDocumentToAdminFile result = ccsvClient.addNewDocumentToAdminFile(paramAddNewDocumentToAdminFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	String[] id = result.getId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addAdministrativeFileToAdminFile'

...

Añade el expediente existente en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el subexpediente con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultAddAdministrativeFileToAdminFile addAdministrativeFileToAdminFile(ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddAdministrativeFileToAdminFile(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente donde se va a añadir el documento.
id	String	Si(1)	Identificador del expediente donde se va a añadir el documento.
contentCsv	String	Si(2)	CSV del expediente a añadir
contentId	String	Si(2)	Identificador del expediente a añadir
adminFileFolderCode	String	No(3)	Código de la carpeta donde incluir el documento.
adminFileFolderId	String	No(3)	Identificador de la carpeta donde incluir el documento.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2)

NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddAdministrativeFileToAdminFile (hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultAddAdministrativeFileToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1007	ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado.
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile = new ParamAddAdministrativeFileToAdminFile();
paramAddAdministrativeFileToAdminFile.setId("09587425558554jk");
paramAddAdministrativeFileToAdminFile.setContentId("098745255456654rr");
ResultAddAdministrativeFileToAdminFile result = ccsvClient.AddAdministrativeFileToAdminFile(paramAddAdministrativeFileToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteDocumentFromAdminFile'

...

Borra un documento como contenido de un expediente en estado "Abierto". Para ello se deberá eliminar la relación entre el expediente y el documento con rol "CONTIENE". Sólo se podrán eliminar documentos en estado borrador o pendiente de firma.

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentFromAdminFile deleteDocumentFromAdminFile(ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile );

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocumentFromAdminFile (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente donde se va a buscar el documento a borrar.
id	String	Si(1)	Identificador del expediente donde se va a buscar el documento a borrar.
contentCsv	String	Si(2)	CSV del documento a borrar.
contentId	String	Si(2)	Identificador del documento a borrar.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteDocumentFromAdminFile (hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocumentFromAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1018	ERROR_STATEORIGINALCOPIA	No se puede borrar del expediente documentos en estado Original o Copia
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1029	ERROR_NOTEXIST_DOCINADMINFILE	No existe ese documento en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile = new ParamDeleteDocumentFromAdminFile();
paramDeleteDocumentFromAdminFile.setId("0925745454564gf");
paramDeleteDocumentFromAdminFile.setContentId("09254654446586ff");
ResultDeleteDocumentFromAdminFile result = ccsvClient.deleteDocumentFromAdminFile(paramDeleteDocumentFromAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'moveDocumentToRecycleFolder'

...

Servicio que elimina la relación entre un documento en cualquier estado y un expediente abierto, moviendo físicamente el documento a la carpeta dmFolder de “Papelera de reciclaje”. Si el documento se encuentra dentro de una carpeta en el expediente también eliminará la relación. El documento puede estar en cualquier estado. Se añadirá el expediente a la lista de expedientes pendientes de regeneración de su índice por el proceso nocturno.

Expand

title	Ver detalles

Signatura

ResultMoveDocumentToRecycleFolder moveDocumentToRecycleFolder(ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamMoveDocumentToRecycleFolder(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
adminFileCsv	String	Si(1)	csv del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente
adminFileId	String	Si(1)	Identificador en Documentum del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente
documentCsv	String	Si(2)	csv del documento a mover
documentId	String	Si(2)	Identificador en Documentum del documento a mover
reasonToMove	String	Si	Razón por la que se solicita el movimiento a la papelera de reciclaje.

NOTA: Si se rellena el adminFileCsv no se rellena el campo adminFileId y viceversa.(1)

NOTA 2: Si se rellena el documentCsv no se rellena el campo documentId y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultMoveDocumentToRecycleFolder(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultMoveDocumentToRecycleFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1039	ERROR_ADMINFILE_NIF_USER_REQUESTING_MOVE_NULL	El nif del usuario que solicita el movimiento es obligatorio
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1040	ERROR_ADMINFILE_REASON_TO_MOVE_NULL	La razón por la que solicita el movimiento es obligatoria
1029	ERROR_NOTEXIST_DOCINADMINFILE	No existe ese documento en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder = new ParamMoveDocumentToRecycleFolder();
paramMoveDocumentToRecycleFolder.setAdminFileCsv("CCSV54641878471CCSV");
paramMoveDocumentToRecycleFolder.setNif("00000000T");
ResultMoveDocumentToRecycleFolder result = ccsvClient.moveDocumentToRecycleFolder(paramMoveDocMétodos para la gestión de carpetas.umentToRecycleFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos para la gestión de carpetas.

Método 'createAdministrativeFileFolder'

...

Crea una carpeta dentro del expediente, para ello habrá que relacionar el expediente con la carpeta con una relación con rol CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultCreateAdministrativeFileFolder createAdministrativeFileFolder(ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateAdministrativeFileFolder (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
adminFileFolder	CCSV_3.5.0_Manual de integración#AdministrativeFileFolder	Si(2)	Carpeta que se desea crear.

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Necesitaremos el code y el name del AdminFileFolder que queremos crear..(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultCreateAdministrativeFileFolder (hereda de CCSV_3.5.0_Manual de integración#ResultError)

adminFileFolderId

String

Identificador de la carpeta que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCreateAdministrativeFileFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1030	ERROR_ADMINFILEFOLDER_CREATE	Faltan datos de la carpeta que se desea crear
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto
1035	ERROR_ADMINFILEFOLDER_CREATE_CODE	El código de la carpeta no puede tener más de 20 caracteres
1036	ERROR_ADMINFILEFOLDER_CREATE_NAME	El nombre de la carpeta no puede tener más de 80 caracteres
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder = new ParamCreateAdministrativeFileFolder();
// adminFileFolder es un objeto de la clase AdminFileFolder que contiene el code y el name de la carpeta que queremos crear.
paramCreateAdministrativeFileFolder.setAdminFileFolder(adminFileFolder);
paramCreateAdministrativeFileFolder.setId("09254644654456hk");
ResultCreateAdministrativeFileFolder result = ccsvClient.createAdministrativeFileFolder(paramCreateAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
	String adminFileFolderId = result.getAdminFileFolderId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteAdministrativeFileFolder'

...

Elimina una carpeta dentro del expediente. Deberá mover las relaciones con los documentos contenidos en la carpeta directamente sobre el expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultDeleteAdministrativeFileFolder deleteAdministrativeFileFolder(ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamDeleteAdministrativeFileFolder (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String(1)	CSV del expediente.
id	String(1)	Identificador del expediente.
adminFileFolderCode	String(2)	Código de la carpeta que se desea eliminar
adminFileFolderId	String(2)	Identificador de la carpeta que se desea eliminar

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteAdministrativeFileFolder(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteAdministrativeFileFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1031	ERROR_ADMINFILEFOLDER_CREATE	Faltan datos de la carpeta que se desea crear
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder = new ParamDeleteAdministrativeFileFolder();
paramDeleteAdministrativeFileFolder.setCsv("CCSV54641878471CCSV");
paramDeleteAdministrativeFileFolder.setAdminFileFolderId("095464654564j");
ResultDeleteAdministrativeFileFolder result = ccsvClient.deleteAdministrativeFileFolder(paramDeleteAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Método 'getAdministrativeFileFolder'

...

Obtiene una carpeta del expediente y los documentos contenidos en ella.

Expand

title	Ver detalles

Signatura

ResultGetAdministrativeFileFolder getAdministrativeFileFolder(ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAdministrativeFileFolder (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
adminFileFolderCode	String	Si(2)	Código de la carpeta que se desea eliminar
adminFileFolderId	String	Si(2)	Identificador de la carpeta que se desea eliminar
metadata	String[]	No(3)	Lista de atributos que se desean recuperar de los documentos de la carpeta
includeContent	boolean	Si	Indica se se desean recuperar los contenidos de los documentos de la carpeta

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.

NOTA 2: Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.

NOTA 3:Por defecto añade los metadatos: código de la carpeta, nombre de la carpeta, descripción tipo
documento, CSV, estado del documento, fecha captura, estado del expediente, fecha apertura del
expediente y número de expediente.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetAdministrativeFileFolder(hereda de CCSV_3.5.0_Manual de integración#ResultError)

adminFileFolder

CCSV_3.5.0_Manual de integración#AdministrativeFileFolder

Carpeta del expediente

folderContents

CCSV_3.5.0_Manual de integración#AdministrativeFileRelation[]

Contenidos de la carpeta

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetAdministrativeFileFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1031	ERROR_ADMINFILEFOLDER_CREATE	Faltan datos de la carpeta que se desea crear
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder = new ParamGetAdministrativeFileFolder();
paramGetAdministrativeFileFolder.setCsv("CCSV54641878471CCSV");
paramGetAdministrativeFileFolder.setAdminFileFolderId("095464654564j");
paramGetAdministrativeFileFolder.setIncludeContent(true);
ResultGetAdministrativeFileFolder result = ccsvClient.getAdministrativeFileFolder(paramGetAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFileFolder adminFileFolder = result.getAdminFileFolder();
	AdministrativeFileRelation[] folderContents = result.getFolderContents();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'moveDocumentToFolder'

...

Mueve un documento a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultMoveDocumentToFolder moveDocumentToFolder(ParamMoveDocumentToFolder paramMoveDocumentToFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamMoveDocumentToFolder(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
contentCsv	String	Si(2)	CSV del documento que se va a mover
contentId	String	Si(2)	Identificador del documento que se va a mover
adminFileFolderCode	String	Si(3)	Código de la carpeta a la que se desea mover el documento
adminFileFolderId	String	Si(3)	Identificador de la carpeta a la que se desea mover el documento

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2)

NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultMoveDocumentToFolder(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultMoveDocumentToFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1031	ERROR_ADMINFILEFOLDER_CREATE	Faltan datos de la carpeta que se desea crear
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1029	ERROR_NOTEXIST_DOCINADMINFILE	No existe ese documento en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamMoveDocumentToFolder paramMoveDocumentToFolder = new ParamMoveDocumentToFolder();
paramMoveDocumentToFolder.setCsv("CCSV54641878471CCSV");
paramMoveDocumentToFolder.setContentCsv("CCSV54646484849CCSV");
paramMoveDocumentToFolder.setAdminFileFolderId("095464654564j");
ResultMoveDocumentToFolder result = ccsvClient.moveDocumentToFolder(paramMoveDocumentToFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Método 'moveDocumentsToFolder'

...

Mueve un grupo de documentos a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultMoveDocumentsToFolder moveDocumentsToFolder(ParamMoveDocumentsToFolder paramMoveDocumentsToFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamMoveDocumentsToFolder (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
contentsCsv	String[]	Si(2)	Lista de CSV's de los documentos que se va a mover
contentsId	String[]	Si(2)	Lista de Identificadores de los documentos que se va a mover
adminFileFolderCode	String	Si(3)	Código de la carpeta a la que se desea mover el documento
adminFileFolderId	String	Si(3)	Identificador de la carpeta a la que se desea mover el documento

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentsCsv no se rellena el campo contentsId y viceversa.(2)

NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultMoveDocumentsToFolder(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultMoveDocumentsToFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1031	ERROR_ADMINFILEFOLDER_CREATE	Faltan datos de la carpeta que se desea crear
1014	ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS	Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente
1015	ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP	Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1029	ERROR_NOTEXIST_DOCINADMINFILE	No existe ese documento en el expediente especificado
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamMoveDocumentsToFolder paramMoveDocumentsToFolder = new ParamMoveDocumentsToFolder();
paramMoveDocumentsToFolder.setCsv("CCSV54641878471CCSV");
// contentsCsv es un String[] que contiene los csv's de los documentos que queremos mover
paramMoveDocumentsToFolder.setContentsCsv(contentsCsv);
paramMoveDocumentsToFolder.setAdminFileFolderId("095464654564j");
ResultMoveDocumentsToFolder result =ccsvClient.moveDocumentsToFolder(paramMoveDocumentsToFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Método 'removeDocumentFromFolder'

...

Mueve un documento de una carpeta a la raíz del expediente, cambiando la relación "CONTIENE" al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Expand

title	Ver detalles

Signatura

ResultRemoveDocumentFromFolder removeDocumentFromFolder(ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamRemoveDocumentFromFolder (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
contentsCsv	String[]	Si(2)	CSV del documento que se va a eliminar
contentsId	String[]	Si(2)	Identificador del documento que se va eliminar
adminFileFolderCode	String	Si(3)	Código de la carpeta de la que se desea quitar el documento
adminFileFolderId	String	Si(3)	Identificador de la carpeta de la que se desea quitar el documento

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

NOTA 2: Si se rellena el contentsCsv no se rellena el campo contentsId y viceversa.(2)

NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultRemoveDocumentFromFolder (hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultRemoveDocumentFromFolder

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1031	ERROR_ADMINFILEFOLDER_CREATE	Faltan datos de la carpeta que se desea crear
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS	Debe especificar el id o el CSV del documento contenido del expediente
1001	ERROR_OPEN_STATE	No se puede modificar la estructura de un expediente que no esté en estado Abierto
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1029	ERROR_NOTEXIST_DOCINADMINFILE	No existe ese documento en el expediente especificado
1027	ERROR_NOTEXIST_DOCINFOLDER	No existe ese documento en la carpeta especificada
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder = new ParamRemoveDocumentFromFolder();
paramRemoveDocumentFromFolder.setCsv("CCSV54641878471CCSV");
paramRemoveDocumentFromFolder.setContentCsv("CCSV1984991484CCSV");
paramRemoveDocumentFromFolder.setAdminFileFolderId("095464654564j");
ResultRemoveDocumentFromFolder result = ccsvClient.removeDocumentFromFolder (paramRemoveDocumentFromFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'lastAddedContents'

...

Recupera los últimos documentos, expedientes, carpetas, añadidos desde la fecha indicada.

Expand

title	Ver detalles

Signatura

ResultLastAddedContents lastAddedContents(ParamLastAddedContents paramLastAddedContents);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamLastAddedContents (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
dateStart	Date	No	Devolverá expedientes, documentos y carpetas, añadidos a partir de esa fecha
metadata	String[]	No	Array de nombres de los metadatos que deseamos recuperar
includeContent	boolean	No	Indica si se desean recuperar los contenidos de los documentos del expediente

NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultLastAddedContents (hereda de CCSV_3.5.0_Manual de integración#ResultError)

contents

Object[]

Devuelve los últimos objetos que se han añadido puede ser un CCSV_3.5.0_Manual de integración#Document,CCSV_3.5.0_Manual de integración#AdministrativeFileFolder,CCSV_3.5.0_Manual de integración#AdministrativeFile

Códigos de error

Los errores de la invocación se encapsulan en ResultLastAddedContents

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamLastAddedContents paramLastAddedContents = new ParamLastAddedContents();
paramLastAddedContents.setApplicationId("CCSV");
paramLastAddedContents.setDateStart(Calendar.getInstance().getTime());//fecha desde la que se desean recoger los datos.
paramLastAddedContents.setIncludeContent(true);
paramLastAddedContents.setNif("00000000T");
ResultLastAddedContents result = ccsvClient.lastAddedContents(paramLastAddedContents);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Servicio IMetadataModelServicePortType

A continuación se muestran todos los métodos referentes a la administración del modelo de metadatos existente o anteriores, la gestión de tipos de documentos y documentales y la administración de los metadatos existentes.

Métodos para la gestión de modelos de metadatos.

Método 'getMetadataModelList'

...

Permite obtener un listado de los modelos de metadatos existentes en el sistema.

Expand

title	Ver detalles

Signatura

ResultGetMetadataModelList getMetadataModelList(ParamGetMetadataModelList paramGetMetadataModelList).

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamGetMetadataModelList(hereda de CCSV_3.5.0_Manual de integración#ParamBase)

NOTA: Los parámetros de invocación se encapsulan en el objeto ParamGetMetadataModelList y no tiene atributos adicionales a los de la clase padre.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadataModelList (hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataModelList

List<CCSV_3.5.0_Manual de integración#MetadataModel>

Lista con todos los modelos de metadatos

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataModelList

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

Code Block


ParamGetMetadataModelList param = new ParamGetMetadataModelList();
ResultGetMetadataModelList result = cssvClient.getMetadataModelWs().getMetadataModelList(param);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error( result.getErrorCode()+":"+ result.getErrorMessage());
}

Método 'getCurrentMetadataModel'

...

Permite obtener el modelo de metadatos actual.

Expand

title	Ver detalles

Signatura

ResultGetCurrentMetadataModel getCurrentMetadataModel(ParamGetCurrentMetadataModel paramGetCurrentMetadataModel).

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamGetCurrentMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ParamBase)

NOTA: Los parámetros de invocación se encapsulan en el objeto ParamGetCurrentMetadataModel y no tiene atributos adicionales a los de la clase padre.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetCurrentMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataModel

CCSV_3.5.0_Manual de integración#MetadataModel

Modelo de metadatos actual.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetCurrentMetadataModel

Código	Nombre	Descripción
718	ERROR_GET_CURRENT	No existe ningún modelo de datos actual.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetCurrentMetadataModel paramGetCurrentMetadataModel = new ParamGetCurrentMetadataModel();
ResultGetCurrentMetadataModel result = cssvClient.getMetadataModelWs().getCurrentMetadataModel(paramGetCurrentMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+ result .getErrorMessage());
}

Método 'getMetadataModel'

...

Permite obtener un modelo de metadatos a partir de su identificador.

Expand

title	Ver detalles

Signatura

ResultGetMetadataModel getMetadataModel(ParamGetMetadataModel paramGetMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModelId	Long	Si	Identificador del modelo de metadatos a recuperar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataModel

CCSV_3.5.0_Manual de integración#MetadataModel

Modelo de metadatos recuperado a partir del id.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId
702	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetMetadataModel paramGetMetadataModel = new ParamGetMetadataModel();
paramGetMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultGetMetadataModel result = cssvClient.getMetadataModelWs().getMetadataModel(paramGetMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'createMetadataModel'

...

Da de alta un nuevo modelo de metadatos.

Expand

title	Ver detalles

Signatura

ResultCreateMetadataModel createMetadataModel(ParamCreateMetadataModel paramCreateMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModel	CCSV_3.5.0_Manual de integración#MetadataModel	Si	Modelo de metados que se quiere crear nuevo.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultCreateMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataModelId

Long

Identificador del modelo de metadatos creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataModel

Código	Nombre	Descripción
725	ERROR_CREATE_METADATAMODEL	EL nombre del modelo de metadatos ya existe
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV

Ejemplo de invocación

Invocación

Code Block


ParamCreateMetadataModel paramCreateMetadataModel = new ParamCreateMetadataModel();
paramCreateMetadataModel.setMetadataModel(metadataModel);
ResultCreateMetadataModel result=cssvClient.getMetadataModelWs().createMetadataModel(paramCreateMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'cloneMetadataModel'

...

Permite clonar un modelo de metadatos ya existente.

Expand

title	Ver detalles

Signatura

ResultCloneMetadataModel cloneMetadataModel(ParamCloneMetadataModel paramCloneMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCloneMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModelId	Long	Si	Identificador del modelo que se va a clonar.
newName	String	Si	Nombre del nuevo modelo de metadatos.
newDescription	String	SI	Descripción del nuevo modelo de metadatos.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultCloneMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataModelId

Long

Identificador del modelo de metadatos creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCloneMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
725	ERROR_CREATE_METADATAMODEL	EL nombre del modelo de metadatos ya existe.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamCloneMetadataModel paramCloneMetadataModel = new ParamCloneMetadataModel();
paramCloneMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultCloneMetadataModel result = cssvClient.getMetadataModelWs().cloneMetadataModel(paramCloneMetadataModel);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadataModel'

...

Actualiza las propiedades de un modelo de metadatos ya existente.

Expand

title	Ver detalles

Signatura

ResultUpdateMetadataModel updateMetadataModel(ParamUpdateMetadataModel paramUpdateMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModel	CCSV_3.5.0_Manual de integración#MetadataModel	Si	Modelo de metadatos que se quiere actualizar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultUpdateMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ResultError)

list

List<String>

Listado con errores de validación del
modelo de metadatos.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
717	ERROR_UPDATE_METADATAMODEL_HISTORICAL	No se puede modificar un modelo de metadatos actual o que ya ha utilizado Papiro.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamUpdateMetadataModel paramUpdateMetadataModel = new ParamUpdateMetadataModel();
paramUpdateMetadataModel.setMetadataModel(metadataModel);
ResultUpdateMetadataModel result = ccsvClient.getMetadataModelWs().updateMetadataModel(paramUpdateMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteMetadataModel'

...

Elimina un modelo de metadatos del sistema.

Expand

title	Ver detalles

Signatura

ResultUpdateMetadataModel updateMetadataModel(ParamUpdateMetadataModel paramUpdateMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModelId	Long	Si	Identidicador del modelo de metadatos a eliminar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteMetadataModel(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
716	ERROR_DELETE_METADATAMODEL_HISTORICAL	No se puede borrar un modelo de metadatos actual o que ya ha utilizado Papiro.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


ParamDeleteMetadataModel paramDeleteMetadataModel = new ParamDeleteMetadataModel();
paramDeleteMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultDeleteMetadataModel result = cssvClient.getMetadataModelWs().deleteMetadataModel(paramDeleteMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de tipos de documentos.

Método 'getDocumentTypeList'

...

Permite obtener la lista de tipos de documentos de un modelo de metadatos indicándole un identificador del modelo de metadatos y si debemos devolver todos los tipos de documento o sólo los destacados.

Expand

title	Ver detalles

Signatura

ResultGetDocumentTypeList getDocumentTypeList(ParamGetDocumentTypeList paramGetDocumentTypeList)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModelId	Long	Si	Identidicador del modelo de metadatos
hightlight	boolean	Si	Indica si se devuelven todos los tipos de documento o sólo los destacados

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocumentTypeList (hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentTypeList

List<CCSV_3.5.0_Manual de integración#DocumentType>

Lista de Tipos de documento recuperados para un modelo de metadatos indicado

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentTypeList

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
719	ERROR_GET_HIGHLIGHT	No existe ningún tipo de documento destacado para ese modelo de metadatos.
721	ERROR_GET_DOCUMENTTYPELIST	No existe ningún tipo de documento para ese modelo de metadatos.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetDocumentTypeList paramGetDocumentTypeList = new ParamGetDocumentTypeList();
ResultGetDocumentTypeList result = cssvClient.getMetadataModelWs().getDocumentTypeList(paramGetDocumentTypeList);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentType'

...

Permite obtener las propiedades de un tipo de documento.

Expand

title	Ver detalles

Signatura

ResultGetDocumentType getDocumentType(ParamGetDocumentType paramGetDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentTypeId	Long	Si	Identidicador del tipo de documento a recuperar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocumentType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentType

CCSV_3.5.0_Manual de integración#DocumentType

Tipo de documento recuperado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetDocumentType paramGetDocumentType = new ParamGetDocumentType();
ResultGetDocumentType result = cssvClient.getMetadataModelWs().getDocumentType(paramGetDocumentType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addDocumentType'

...

Da de alta un nuevo tipo de documento dentro del modelo de metadatos.

Expand

title	Ver detalles

Signatura

ResultAddDocumentType addDocumentType(ParamAddDocumentType paramAddDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentType	DocumentType	Si	Tipo de documento a añadir

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddDocumentType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentTypeId

Long

Identificador del tipo de documento creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddDocumentType

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
704	ERROR_DOCUMENTUMTYPEID_NULO	Debe especificar un documentumTypeId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamAddDocumentType paramAddDocumentType = new ParamAddDocumentType();
paramAddDocumentType.setDocumentType(documenType);
ResultAddDocumentType result = cssvClient.getMetadataModelWs().addDocumentType(paramAddDocumentType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result .getErrorCode()+":"+ result.getErrorMessage());
}

Método 'updateDocumentType'

...

Actualiza las propiedades de un tipo de documento.

Expand

title	Ver detalles

Signatura

ResultUpdateDocumentType updateDocumentType(ParamUpdateDocumentType paramUpdateDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocumentType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentType	CCSV_3.5.0_Manual de integración#DocumentType	Si	Tipo de documento que queremos actualizar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultUpdateDocumentType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateDocumentType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
704	ERROR_DOCUMENTUMTYPEID_NULO	Debe especificar un documentumTypeId.
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamUpdateDocumentType paramUpdateDocumentType = new ParamUpdateDocumentType();
paramUpdateDocumentType.setDocumentType(documentType);
ResultUpdateDocumentType result = cssvClient.getMetadataModelWs().updateDocumentType(paramUpdateDocumentType);
if (result .getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result .getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteDocumentType'

...

Elimina un tipo de documento.

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentType deleteDocumentType(ParamDeleteDocumentType paramDeleteDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocumentType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentTypeId	Long	Si	Identidicador del tipo de documento a eleminar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteDocumentType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocumentType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamDeleteDocumentType paramDeleteDocumentType = new ParamDeleteDocumentType();
ResultDeleteDocumentType result = cssvClient.getMetadataModelWs().deleteDocumentType(paramDeleteDocumentType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de tipos documentales.

Método 'getDocumentumTypeList'

...

Permite obtener la lista de tipos documentales del modelo de metadatos seleccionado.

Expand

title	Ver detalles

Signatura

ResultGetDocumentumTypeList getDocumentumTypeList(ParamGetDocumentumTypeList paramGetDocumentumTypeList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataModelId	Long	Si	Identificador del modelo de metadatos de los tipos documentales a recuperar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocumentTypeList (hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentumTypeList

List<CCSV_3.5.0_Manual de integración#DocumentumType>

Lista de Tipos documentales para un modelo de metadatos indicado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentTypeList

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
720	ERROR_GET_DOCUMENTUMTYPELIST	No existe ningún tipo documental para ese modelo de metadatos.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetDocumentumTypeList paramGetDocumentumTypeList = new ParamGetDocumentumTypeList();
ResultGetDocumentumTypeList result = cssvList.getMetadataModelWs().getDocumentumTypeList(paramGetDocumentumTypeList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentumType'

...

Permite obtener un tipo documental del modelo de metadatos.

Expand

title	Ver detalles

Signatura

ResultGetDocumentumType getDocumentumType(ParamGetDocumentumType paramGetDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentumTypeId	Long	Si	Identificador del tipo documental a recuperar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentumType

CCSV_3.5.0_Manual de integración#DocumentumType

Tipo documental recuperado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentumType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetDocumentumType paramGetDocumentumType = new ParamGetDocumentumType();
ResultGetDocumentumType result = cssvClient.getMetadataModelWs().getDocumentumType(paramGetDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addDocumentumType'

...

Da de alta un nuevo tipo documental.

Expand

title	Ver detalles

Signatura

ResultAddDocumentumType addDocumentumType(ParamAddDocumentumType paramAddDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentumType	CCSV_3.5.0_Manual de integración#DocumentumType	Si	Tipo documental que se quiere añadir.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentumTypeId

Long

Identificador del tipo documental creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddDocumentumType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamAddDocumentumType paramAddDocumentumType = new ParamAddDocumentumType();
paramAddDocumentumType.setDocumentumType(documentumType);
ResultAddDocumentumType result = cssvClient.getMetadataModelWs().addDocumentumType(paramAddDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'cloneDocumentumType'

...

Permite clonar un tipo documental ya existente, copiando así los metadatos y los valores

Expand

title	Ver detalles

Signatura

ResultCloneDocumentumType cloneDocumentumType(ParamCloneDocumentumType paramCloneDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCloneDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentumTypeId	Long	Si	Identificador del tipo documental que se va a clonar
newName	String	Si	Nombre del nuevo tipo documental
newNameNTI	String	Si	Nombre NTI del nuevo tipo documental
newDescription	String	Si	Descripción del nuevo tipo documental

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultCloneDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentumTypeId

Long

Identificador del tipo documental clonado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCloneDocumentumType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
703	ERROR_DOCUMENTUMTYPEID_NOEXISTE	No existe un tipo documental con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamCloneDocumentumType paramCloneDocumentumType = new ParamCloneDocumentumType();
ResultCloneDocumentumType result = metadataModel.cloneDocumentumType(paramCloneDocumentumType);
cssvClient.setClonedDocumentumType(true);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Método 'updateDocumentumType'

...

Actualiza las propiedades de un tipo documental del modelo de metadatos

Expand

title	Ver detalles

Signatura

ResultUpdateDocumentumType updateDocumentumType(ParamUpdateDocumentumType paramUpdateDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentumType	CCSV_3.5.0_Manual de integración#DocumentumType	Si	Tipo de documental que queremos actualizar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultUpdateDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateDocumentumType

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
703	ERROR_DOCUMENTUMTYPEID_NOEXISTE	No existe un tipo documental con el identificador especificado.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamUpdateDocumentumType paramUpdateDocumentumType = new ParamUpdateDocumentumType();
paramUpdateDocumentumType.setDocumentumType(documentumType);
ResultUpdateDocumentumType result = cssvClient.getMetadataModelWs().updateDocumentumType(paramUpdateDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+ result.getErrorMessage());
}

Método 'deleteDocumentumType'

...

Elimina un tipo documental del modelo de metadato.

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentumType deleteDocumentumType(ParamDeleteDocumentumType paramDeleteDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentumTypeId	Long	Si	Identificador del tipo de documental a eliminar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteDocumentumType(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocumentumType

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
711	ERROR_DELETE_DOCUMENTUMTYPE_DOCUMENTUMTYPE	Existe algún tipo documental hijo, asociado al tipo documental que ha intentado borrar.
712	ERROR_DELETE_DOCUMENTUMTYPE_DOCUMENTTYPE	Existe algún tipo de documento asociado al tipo documental que ha intentado borrar.
713	ERROR_DELETE_DOCUMENTUMTYPE_METADATATYPE	Existe algún metadato asociado al tipo documental que ha intentado borrar.
714	ERROR_DELETE_CLONED	No se puede borrar porque afecta una versión anterior.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamDeleteDocumentumType paramDeleteDocumentumType = new ParamDeleteDocumentumType();
paramDeleteDocumentumType.setDocumentumTypeId(documentumType.getDocumentumTypeId());
ResultDeleteDocumentumType result = cssvClient.getMetadataModelWs().deleteDocumentumType(paramDeleteDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+ result.getErrorMessage());
}

Métodos de metadatos.

Método 'getMetadataList'

...

Permite obtener la lista de metadatos de un tipo documental.

Expand

title	Ver detalles

Signatura

ResultGetMetadataList getMetadataList(ParamGetMetadataList paramGetMetadataList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataList(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentumTypeId	Long	Si	Identificador del tipo documental de los metadatos a recuperar.
addMetadataParent	Boolean	Si	Indica si devuelve también los metadatos de los tipos documentales padre

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadataList(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataList

List<CCSV_3.5.0_Manual de integración#Metadata>

Lista de metadatos para un determinado tipo documental.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataList

Código	Nombre	Descripción
722	ERROR_GET_METADATALIST	No existe ningún metadato para ese tipo documental.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetMetadataList paramGetMetadataList = new ParamGetMetadataList();
paramGetMetadataList.setDocumentumTypeId(metadata.getDocumentumTypeId());
paramGetMetadataList.setAddMetadataParent(Boolean.FALSE);
ResultGetMetadataList result = cssvClient.getMetadataModelWs().getMetadataList(paramGetMetadataList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadata'

...

Permite obtener las propiedades de un metadato de un tipo documental

Expand

title	Ver detalles

Signatura

ResultGetMetadata getMetadata(ParamGetMetadata paramGetMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataId	Long	Si	Identificador del metadato a recuperar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadata(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadata

CCSV_3.5.0_Manual de integración#Metadata

Datos del metadato recuperado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadata

Código	Nombre	Descripción
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado
708	ERROR_METADATAID_NULO	Debe especificar un metadataId.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetMetadata paramGetMetadata = new ParamGetMetadata();
paramGetMetadata.setMetadataId(metadata);
ResultGetMetadata result = cssvClient.getMetadataModelWs().getMetadata(paramGetMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addMetadata'

...

Da de alta un nuevo metadato dentro de un tipo documental

Expand

title	Ver detalles

Signatura

ResultAddMetadata addMetadata(ParamAddMetadata paramAddMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddMetadata (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadata	CCSV_3.5.0_Manual de integración#Metadata	Si	Datos del metadato que se quiere añadir.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddMetadata(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataId

Long

Identificador del metadato que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddMetadata

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamAddMetadata paramAddMetadata = new ParamAddMetadata();
paramAddMetadata.setMetadata(metadata);
ResultAddMetadata result = metadataModelBL.getMetadataModelWs().addMetadata(paramAddMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadata'

...

Actualiza las propiedades de un metadato.

Expand

title	Ver detalles

Signatura

ResultUpdateMetadata updateMetadata(ParamUpdateMetadata paramUpdateMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadata	CCSV_3.5.0_Manual de integración#Metadata	Si	Datos del metadato que se quiere actualizar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultUpdateMetadata(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateMetadata

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
703	ERROR_DOCUMENTUMTYPEID_NOEXISTE	No existe un tipo documental con el identificador especificado
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamUpdateMetadata paramUpdateMetadata = new ParamUpdateMetadata();
paramUpdateMetadata.setMetadata(metadata);
ResultUpdateMetadata result = cssvClient.getMetadataModelWs().updateMetadata(paramUpdateMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteMetadata'

...

Elimina un metadato dentro de un tipo documental.

Expand

title	Ver detalles

Signatura

ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataId	Long	Si	Identidicador del metadato a eleminar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteMetadata(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteMetadata

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
714	ERROR_DELETE_CLONED	No se puede borrar porque afecta una versión anterior
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamDeleteMetadata paramDeleteMetadata = new ParamDeleteMetadata();
paramDeleteMetadata.setMetadataId(metadata.getMetadataId());
ResultDeleteMetadata result = cssvClient.getMetadataModelWs().deleteMetadata(paramDeleteMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de valores de metadatos.

Método 'getMetadataValueList'

...

Permite obtener la lista de posibles valores para un metadato.

Expand

title	Ver detalles

Signatura

ResultGetMetadataValueList getMetadataValueList(ParamGetMetadataValueList paramGetMetadataValueList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataValueList(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataId	Long	Si	Identificador del metadato del que queremos recuperar sus posibles valores.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadataValueList (hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataValueList

List<CCSV_3.5.0_Manual de integración#MetadataValue>

Lista de posibles valores para un metadato específico.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataValueList

Código	Nombre	Descripción
723	ERROR_GET_METADATAVALUELIST	Debe especificar un metadataId.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetMetadataValueList paramGetMetadataValueList = new ParamGetMetadataValueList();
paramGetMetadataValueList.setMetadataId(metadata.getMetadataId());
ResultGetMetadataValueList result = cssvClient.getMetadataModelWs().getMetadataValueList(paramGetMetadataValueList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadataDefaultValue'

...

Permite obtener las propiedades del valor por defecto de un determinado metadato.

Expand

title	Ver detalles

Signatura

ResultGetMetadataDefaultValue getMetadataDefaultValue(ParamGetMetadataDefaultValue paramGetDefaultValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataDefaultValue(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataId	Long	Si	Identificador del metadato del que se quiere recuperar su valor por defecto.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadataDefaultValue (hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataValue

CCSV_3.5.0_Manual de integración#MetadataValue

MetadataValue por defecto para un determinado metadato.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataDefaultValue

Código	Nombre	Descripción
708	ERROR_METADATAID_NULO	Debe especificar un metadataId.
724	ERROR_GET_METADATADEFAULTVALUE	No existe ningún valor por defecto para ese metadato.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetMetadataDefaultValue paramGetDefaultValue= new ParamGetMetadataDefaultValue();
paramGetDefaultValue.setMetadataId(metadata.getMetadataId());
ResultGetMetadataDefaultValue result = cssvClient.getMetadataModelWs().getMetadataValueList(paramGetMetadataValueList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadataValue'

...

Permite obtener las propiedades de uno de los valores posibles de un metadato.

Expand

title	Ver detalles

Signatura

ResultGetMetadataValue getMetadataValue(ParamGetMetadataValue paramGetMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataValueId	Long	Si	Identificador del metadataValue a recuperar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataValue

CCSV_3.5.0_Manual de integración#MetadataValue

Metadatavalue recuperado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataValue

Código	Nombre	Descripción
709	ERROR_METADATAVALUEID_NOEXISTE	No existe un valor de metadato con el identificador especificado.
710	ERROR_METADATAVALUEID_NULO	Debe especificar un metadataValueId.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamGetMetadataValue paramGetMetadataValue = new ParamGetMetadataValue();
paramGetMetadataValue.setMetadataValueId(metadataValue.getMetadataValueId());
ResultGetMetadataValue result = cssvClient.getMetadataModelWs().getMetadataValue(paramGetMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+ result.getErrorMessage());
}

Método 'addMetadataValue'

...

Da de alta un nuevo valor para un determinado metadato.

Expand

title	Ver detalles

Signatura

ResultAddMetadataValue addMetadataValue(ParamAddMetadataValue paramAddMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataValue	CCSV_3.5.0_Manual de integración#MetadataValue	Si	MetadataValue que se quiere añadir

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultAddMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ResultError)

metadataValueId

Long

Identificador del MetadataValue creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultAddMetadataValue

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamAddMetadataValue paramAddMetadataValue = new ParamAddMetadataValue();
paramAddMetadataValue.setMetadataValue(metadataValue);
ResultAddMetadataValue result = cssvClient.getMetadataModelWs().addMetadataValue(paramAddMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadataValue'

...

Actualiza las propiedades del valor de un metadato.

Expand

title	Ver detalles

Signatura

ResultUpdateMetadataValue updateMetadataValue(ParamUpdateMetadataValue paramUpdateMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataValue	CCSV_3.5.0_Manual de integración#MetadataValue	Si	MetadataValue que queremos actualizar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultUpdateMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateMetadataValue

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado.
709	ERROR_METADATAVALUEID_NOEXISTE	No existe un valor de metadato con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamUpdateMetadataValue paramUpdateMetadataValue = new ParamUpdateMetadataValue();
paramUpdateMetadataValue.setMetadataValue(metadataValue);
ResultUpdateMetadataValue result = cssvClient.getMetadataModelWs().updateMetadataValue(paramUpdateMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteMetadataValue'

...

Elimina uno de los posibles valores de un metadato.

Expand

title	Ver detalles

Signatura

ResultDeleteMetadataValue deleteMetadataValue(ParamDeleteMetadataValue paramDeleteMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataValueId	Long	Si	Identidicador del valor del metadato que se va a eleminar

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteMetadataValue(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteMetadataValue

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe eMspecificar un metadataModelId.
709	ERROR_METADATAVALUEID_NOEXISTE	No existe un valor de metadato con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

Code Block


ParamDeleteMetadataValue paramDeleteMetadataValue = new ParamDeleteMetadataValue();
paramDeleteMetadataValue.setMetadataValueId(metadataId);
ResultDeleteMetadataValue result =
cssvClient.getMetadataModelWs().deleteMetadataValue(paramDeleteMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

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.

Expand

title	Ver detalles

Signatura

ResultCreateFolder createFolder(ParamCreateFolder paramCreateFolder).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateFolder(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetFolderContents getFolderContents(ParamGetFolderContents paramGetFolderContents).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetFolderContents(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

folders

CCSV_3.5.0_Manual de integración#DocumentSearchResult[]

Listado de carpetas contenidos en la carpeta.

documents

CCSV_3.5.0_Manual de integración#DocumentSearchResult[]

Listado de documentos contenidos en la carpeta.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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 (CCSV_3.5.0_Manual de integración#initializeDocumentMetadata) sin enviar el contenido del documento.

Para crear expedientes o índices habría que usar los métodos referentes al servicio AdministrativeFileService

Expand

title	Ver detalles

Signatura

ResultCreateDocument createDocument(ParamCreateDocument paramCreateDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateDocument(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

id

String

Identificador en Documentum del documento creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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'

...

Actualiza un documento en el gestor documental Documentum.

Expand

title	Ver detalles

Signatura

ResultUpdateDocument updateDocument(ParamUpdateDocument paramUpdateDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocument (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#TraceData	Si	Información acerca de los cambios en el documento.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultUpdateDocument(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetDocumentByCitizen getDocumentByCitizen(ParamGetDocumentByCitizen paramGetDocumentByCitizen).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentByCitizen(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

document

CCSV_3.5.0_Manual de integración#Document

Documento devuelto por el servicio al realizar la consulta.

signatures

ArrayList<CCSV_3.5.0_Manual de integración#Signature>

Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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'

...

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

Expand

title	Ver detalles

Signatura

ResultGetDocument getDocument(ParamGetDocument paramGetDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocument(hereda de CCSV_3.5.0_Manual de integración#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	Si(2)	Indica si adjunta el contenido del documento.
addMetadata	boolean	Si(2)	Indica si adjunta los metadatos del documento.
addSignatures	boolean	Si	Indica si adjunta las firmas asociadas al documento.

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

NOTA 2 : Si no se indican los datos que quieren devolverse se devuelven por defecto el contenido y los metadatos.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocument(hereda de CCSV_3.5.0_Manual de integración#ResultError)

document

CCSV_3.5.0_Manual de integración#Document

Documento devuelto por el servicio al realizar la consulta.

signatures

ArrayList<CCSV_3.5.0_Manual de integración#Signature>

Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocument

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

Code Block


ParamGetDocument paramGetDocument = new ParamGetDocument();
paramGetDocument.setId("0906fca3801922bb");
paramGetDocument.addContent(true);
paramGetDocument.setAttachSignatures(true);
paramGetDocument.setAddMetadata(false);
ResultGetDocument result = ccsvClient.getDocument(paramGetDocument);
if(result.getReturnCode().equals(ReturnCode.OK){
	Document document = result.getDocument();
	// en este caso document.getMetadata será nulo ya que no lo hemos recuperado
	ArrayList<Signatures> signatures = result.getSignatures();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteDocument'

...

Elimina un documento almacenado en el gestor documental a partir del identificador de Documentum o de su csv.

Signatura

Expand

title	Ver detalles

ResultDeleteDocument deleteDocument(ParamDeleteDocument paramDeleteDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocument(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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étodos de gestión de enlaces de documentos.

Método 'createDocumentLink'

...

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

Expand

title	Ver detalles

Signatura

ResultCreateDocumentLink createDocumentLink(ParamCreateDocumentLink paramCreateDocumentLink).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateDocumentLink(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocumentLink(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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 conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultSearch search(ParamSearch paramSearchDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamSearch (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
searchType	CCSV_3.5.0_Manual de integración#SearchType	Si	Tipo de búsqueda que se quiere realizar.
fileFilter	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

documentSearchResult

CCSV_3.5.0_Manual de integración#DocumentSearchResult[]

Listado de documentos que coinciden con la búsqueda.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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 conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultExecuteDQL executeDQL(ParamExecuteDQL paramExecuteDQL).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamExecuteDQL(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

Code Block


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:

Expand

title	Ver detalles

Signatura

ResultSearchDQL searchDQL(ParamSearchDQL paramSearchDQL).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamSearchDQL (hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultCreateAndVerifySignature createAndVerifySignature(ParamCreateAndVerifySignature paramCreateAndVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateAndVerifySignature(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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 CCSV_3.5.0_Manual de integración#createAndVerifySignature es que no se verifican las firmas que se van a insertar.

Expand

title	Ver detalles

Signatura

ResultCreateWithoutVerifySignature createWithoutVerifySignature(ParamCreateWithoutVerifySignature paramCreateWithoutVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateWithoutVerifySignature (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultDeleteSignature deleteSignature(ParamDeleteSignature paramDeleteSignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteSignature(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
signatureId	String	Si	Identificador de la firma en Documentum.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultDeleteSignature(hereda de CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultUpdateAndVerifySignature updateAndVerifySignature(ParamUpdateAndVerifySignature paramUpdateAndVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateAndVerifySignature(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

signatureId

String

Identificador en Documentum de la firma reemplazada.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultUpdateWithoutVerifySignature updateWithoutVerifySignature(ParamUpdateWithoutVerifySignature paramUpdateWithoutVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateWithoutVerifySignature (hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

signatureId

String

Identificador en Documentum de la firma reemplazada.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultUpdateAndSignDocument updateAndSignDocument(ParamUpdateAndSignDocument paramUpdateAndSignDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateAndSignDocument (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentSignatures(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
id	String	Si(1)	Codigo 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 CCSV_3.5.0_Manual de integración#ResultError)

signatures

ArrayList<CCSV_3.5.0_Manual de integración#Signature>

Listado de firmas de un documento.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultInitializeDocumentMetadata initializeDocumentMetadata(ParamInitializeDocumentMetadata paramInitializeDocumentMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamInitializeDocumentMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

document

CCSV_3.5.0_Manual de integración#Document

Documento con los metadatos inicializados.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultInitializeStructuredMetadata initializeStructuredMetadata(ParamInitializeStructuredMetadata paramInitializeStructuredMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamInitializeStructuredMetadata (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
metadataName	String	si	Nombre del metadato estructurado que se quiere inicializar.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultInitializeStructuredMetadata(hereda de CCSV_3.5.0_Manual de integración#ResultError)

document

CCSV_3.5.0_Manual de integración#Document

Documento con la estructura de metadatos del metadato estructurado correspondiente.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultVerifyMetadataValue verifyMetadataValue(ParamVerifyMetadataValue paramVerifyMetadataValue);.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamVerifyMetadataValue(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

metadataValueVerification

CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultVerifyDocumentMetadata verifyDocumentMetadata(ParamVerifyDocumentMetadata paramVerifyDocumentMetadata);.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamVerifyDocumentMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
document	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetMetadataValueList getMetadataValueList(ParamGetMetadataValueList paramGetMetadataValueList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataValueList(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

metadataValueList

List<CCSV_3.5.0_Manual de integración#MetadataValue>

Lista de valores posibles del metadato indicado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetMetadataList getMetadataList(ParamGetMetadataList paramGetMetadataList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataList(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

metadataList

List<CCSV_3.5.0_Manual de integración#Metadata>

Lista de valores posibles del metadato indicado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetMetadata getMetadata(ParamGetMetadata paramGetMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataList(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultChangeState changeState(ParamChangeState paramchangeState).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeState(hereda de CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultChangeExternalLock changeExternalLock(ParamChangeExternalLock paramChangeExternalLock).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeExternalLock(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultChangeDocumentVisibility changeDocumentVisibility(ParamChangeDocumentVisibility paramChangeDocumentVisibility).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeDocumentVisibility(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetDocumentTypeList getDocumentTypeList(ParamGetDocumentTypeList paramDocumentTypeList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

documentTypeList

List<CCSV_3.5.0_Manual de integración#DocumentTypeList>

Lista de tipos de documento devueltos por el servicio

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentXml (hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultUpdateMetadata updateMetadata(ParamUpdateMetadata paramUpdateMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadata(hereda de CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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

Expand

title	Ver detalles

Signatura

ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadata(hereda de CCSV_3.5.0_Manual de integración#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 posicion 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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultCreateRelationship createRelationship(ParamCreateRelationship paramCreateRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateRelationship (hereda de CCSV_3.5.0_Manual de integración#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 relacion.
relationship	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultCreateRelationships createRelationships(ParamCreateRelationships paramCreateRelationships).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateRelationships (hereda de CCSV_3.5.0_Manual de integración#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 relacion.
relationship	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultDeleteRelationship deleteRelationship (ParamDeleteRelationship paramDeleteRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteRelationship(hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetRelatedDocuments getRelatedDocuments(ParamGetRelatedDocuments paramGetRelatedDocuments).

Parámetros de invocación

Nombre	Tipo		Descriprición
ParamGetRelatedDocuments(hereda de CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

documentTreeNodes

CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAllRelatedDocuments(hereda de CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

documentTreeNodes

CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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 relaciones de agentes.

Método 'addAgentRelationship'

...

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

Expand

title	Ver detalles

Signatura

ResultAddAgentRelationship addAgentRelationship(ParamAddAgentRelationship paramAddAgentRelationship).

Parámetros de invocación

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

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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultAddAgentRelationships addAgentRelationships(ParamAddAgentRelationships paramAddAgentRelationships)

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamAddAgentRelationship(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Codigo 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	CCSV_3.5.0_Manual de integración#AgentRelationship[]	Contiene todos los datos de la relación a crear
traceData	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultDeleteAgentRelationship deleteAgentRelationship(ParamDeleteAgentRelationship paramDeleteAgentRelationship);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteAgentRelationship(hereda de CCSV_3.5.0_Manual de integración#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 relacion.
agentRelationship	CCSV_3.5.0_Manual de integración#AgentRelationship	Si	Contiene todos los datos de la relación a borrar
traceData	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultUpdateAgentRelationship updateAgentRelationship(ParamUpdateAgentRelationship paramUpdateAgentRelationship);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateAgentRelationship(hereda de CCSV_3.5.0_Manual de integración#ParamBase)
csv	String	Si(1)	Código csv asociado al documento en el que se va a modificar la relacion.
id	String	Si(1)	Identificador del documento en el que se va a modificar la relación.
agentRelationship	CCSV_3.5.0_Manual de integración#AgentRelationship	Si	Contiene todos los datos de la relación a borrar
traceData	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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

Expand

title	Ver detalles

Signatura

ResultGetAgentRelationship getAgentRelationship(ParamGetAgentRelationship paramGetAgentRelationship);;

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAgentRelationship(hereda de CCSV_3.5.0_Manual de integración#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 identificacion number para que se identifique una unica relacion de agente.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetAgentRelationship(hereda de CCSV_3.5.0_Manual de integración#ResultError)

agentRelationship

CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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

Expand

title	Ver detalles

Signatura

ResultGetAgentRelationships getAgentRelationships(ParamGetAgentRelationships paramGetAgentRelationships)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAgentRelationships (hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

agentRelationships

CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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.

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGenerateIframeToken generateIframeToken(ParamGenerateIframeToken paramGenerateIframeToken)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGenerateIframeToken (hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultGenerateIframeToken

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

Ejemplo de invocación

Invocación

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultValidateIframeToken validateIframeToken(ParamValidateIframeToken paramValidateIframeToken);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamValidateIframeToken (hereda de CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentSubtypeList (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
documentTypeName	String	Si	Nombre del tipo de documento.

Parámetros de respuesta

Nombre

Tipo

Descripción

ResultGetDocumentSubtypeList (hereda de CCSV_3.5.0_Manual de integración#ResultError)

documentSubtypeList

List<CCSV_3.5.0_Manual de integración#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

Code Block


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 CCSV_3.5.0_Manual de integración#getDocument ya que devuelve los mismos datos si rellenamos el csv y ademas podemos indicar los datos que queremos que se nos devuelvan.

Método 'getDocumentContentByCSV'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#getDocument ya que devuelve los mismos datos si rellenamos el csv y ademas 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 CCSV_3.5.0_Manual de integración#getDocument ya que devuelve los mismos datos si rellenamos el id y ademas podemos indicar los datos que queremos que se nos devuelvan.

Método 'getDocumentContentById'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#getDocument que devuelve los mismos datos si rellenamos el id y ademas 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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#updateAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.

Método 'getSimpleMetadata'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#getMetadata.

Método 'getRepetitiveSimpleMetadata'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#getMetadata.

Método 'getRepetitiveSimpleMetadata'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#getMetadata.

Método 'updateSimpleMetadata'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.

Método 'updateStructuredMetadata'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.

Método 'updateSimpleMetadata'

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#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.

Expand

title	Ver detalles

Signatura

ResultCreateDocumentXml createDocumentXml(ParamCreateDocumentXml paramCreateDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateDocumentXml (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
xml	DataHandler	Si	Xml del documento
agent	CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#ResultError)
csv	String	Código csv asociado al documento que se ha creado.
name	String	Nombre del documento que se ha creado.
extension	String	Extension del documento que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

ResultCreateIndexXml createIndexXml(ParamCreateIndexXml paramCreateIndexXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateIndexXml (hereda de CCSV_3.5.0_Manual de integración#ParamBase)
xml	DataHandler	Si	Xml del indice.
agent	CCSV_3.5.0_Manual de integración#Agent	Si	Relación con metadato estructurado de tipo agente
name	String	No	Nombre del documento indice.
procedureCode	String	No	Código de procedimiento
type	String	Si	Tipo del expediente donde se crea el indice.
number	String	Si	Numero del expediente donde se crea el indice.
description	String	Si	Descripcion del expediente donde se crea el indice.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateIndexXml (hereda de CCSV_3.5.0_Manual de integración#ResultError)
csv	String	Código csv asociado al documento indice que se ha creado.
name	String	Nombre del documento indice que se ha creado.
extension	String	Extension del documento indice que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

void prepareXmlToInside(ParamPrepareXmlToInside paramPrepareXmlToInside)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamPrepareXmlToInside (hereda de CCSV_3.5.0_Manual de integración#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	Codigo csv adjunto al documento que se prepara para enviar.
Id de la peticion	String	No	Id de la peticio.
description	String	No	Descripcion del expediente donde se crea el indice.
motivacion	String	No	Motivación. Maximo 256
plazoDisponibilidad	Date	No	Fecha limite hata la que el expediente//documento esta disponible
flagAdminFileJustice	boolean	Si	Indica si se remite o no a justicia
paramSendJustice	CCSV_3.5.0_Manual de integración#ParamSendJustice	Si	Parametros 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 CCSV_3.5.0_Manual de integración#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

Code Block


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.

Expand

title	Ver detalles

Signatura

RespuestaAccesoIndiceExpedienteType accessIndexFile(PeticionAccesoIndiceExpedienteType peticionAccesoIndiceExpedienteType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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 CCSV_3.5.0_Manual de integración#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

Code Block


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

Expand

title	Ver detalles

Signatura

RespuestaAccesoDocumentoExpedienteType accessDocumentFile(PeticionAccesoDocumentoExpedienteType peticionAccesoDocumentoExpediente.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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 CCSV_3.5.0_Manual de integración#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

Code Block


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

Expand

title	Ver detalles

Signatura

ResultGetDocument getDocument(ParamGetDocument paramGetDocument)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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

CCSV_3.5.0_Manual de integración#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

Code Block


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 CCSV_3.5.0_Manual de integración#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 rebida 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 CCSV_3.5.0_Manual de integración#DocumentBase.

Nombre	Tipo	Descripción
metadata	HashMap<String,Object>	Almacena las propiedades o metadatos de un 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 CCSV_3.5.0_Manual de integración#Document , CCSV_3.5.0_Manual de integración#AdministrativeFile o CCSV_3.5.0_Manual de integración#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 almacenamdo.
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<CCSV_3.5.0_Manual de integración#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 politica 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	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#Document	Objeto que contiene los datos del documento.
signature	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#Document	Contiene los metadatos asociados al documento
documentRelation	CCSV_3.5.0_Manual de integración#DocumentRelation	Contiene la relación del documento con el documento con el padre.
documentTreeNodes	CCSV_3.5.0_Manual de integración#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.

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Servicio IAdministrativeFileServicePortType

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Invocación

Método 'getDocumentXml'

Invocación

Método 'initializeAdministrativeFileMetadata'

Invocación

Método 'openAdministrativeFile'

Invocación

Método 'closeAdministrativeFile'

Invocación

Método 'reopenAdministrativeFile'

Invocación

Método 'changeAdministrativeFileState'

Invocación

Métodos para la gestión de índices de expedientes.

Método 'getAdministrativeFileIndex'

Invocación

Método 'regenerateAdministrativeFileIndex'

Invocación

Métodos para la gestión de los contenidos de los expedientes.

Método 'addDocumentToAdminFile'

Invocación

Método 'addNewDocumentToAdminFile'

Invocación

Método 'addDocumentsToAdminFile'

Invocación

Método 'addNewDocumentsToAdminFile'

Invocación

Método 'addAdministrativeFileToAdminFile'

Invocación

Método 'deleteDocumentFromAdminFile'

Invocación

Método 'moveDocumentToRecycleFolder'

Invocación

Métodos para la gestión de carpetas.

Método 'createAdministrativeFileFolder'

Invocación

Método 'deleteAdministrativeFileFolder'

Invocación

Método 'getAdministrativeFileFolder'

Invocación

Método 'moveDocumentToFolder'

Invocación

Método 'moveDocumentsToFolder'

Invocación

Método 'removeDocumentFromFolder'

Invocación

Método 'lastAddedContents'

Invocación

Servicio IMetadataModelServicePortType

Métodos para la gestión de modelos de metadatos.

Método 'getMetadataModelList'

Invocación

Método 'getCurrentMetadataModel'

Invocación

Método 'getMetadataModel'

Invocación

Método 'createMetadataModel'

Invocación

Método 'cloneMetadataModel'

Invocación

Método 'updateMetadataModel'

Invocación

Método 'deleteMetadataModel'

Invocación

Métodos de tipos de documentos.

Método 'getDocumentTypeList'

Invocación

Método 'getDocumentType'

Invocación

Método 'addDocumentType'

Invocación

Método 'updateDocumentType'

Método 'updateDocument'

Método 'getDocument'