Table of Contents

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

ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument)

Parámetros de invocación

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

Parámetros de respuesta

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

Códigos de error

Los errores de la invocación se encapsulan en ResultGetSubstituteDocument

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV.
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con PAU
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO
130	ERROR_BASEDATOS_CSVPAPIRO	Error al conectar con la base de datos CCSV
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

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

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

Método 'createDocumentLink'

...

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink).

Parámetros de invocación

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

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultDeleteDocumentLink
	ResultDeleteDocumentLink

ResultDeleteDocumentLink(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocumentLink

Código	Nombre	Descripción
180	ERROR_FOLDERID_NULO	Debe especificar el Id de la carpeta.
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV.
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

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

ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentSignatures(hereda de 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

Anchor

	ResultGetDocumentSignatures
	ResultGetDocumentSignatures

ResultGetDocumentSignatures(hereda de ResultError)

signatures

ArrayList<Signature>

Listado de firmas de un documento.

Códigos de error

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV.
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado.
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU
2019	ERROR_FILE_TOO_LARGE	El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE.
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

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
Anchor
initializeDocumentMetadata
initializeDocumentMetadata
'initializeDocumentMetadata'

...

Expand

title	Ver detalles

Signatura

ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadata(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	Código seguro de verificación del documento en Documentum.
metadataName	String	Si	Nombre del metadato que se quiere eliminar.
deleteAll	boolean	Si	Para metadatos repetitivos indica si se desean borrar todos los valores.
position	String	No	Indica la 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

Anchor

	ResultUpdateMetadata
	ResultUpdateMetadata

ResultUpdateMetadata (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateMetadata

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Se ha producido un error con PAPIRO.
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado.
133	ERROR_METADATONOEXISTE	No existe el metadato buscado para ese documento.
134	ERROR_POSICIONMETADATONOEXISTE	No existe metadato con ese orden o posición
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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'

...

Expand

title	Ver detalles

Signatura

ResultCreateRelationships createRelationships(ParamCreateRelationships paramCreateRelationships).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateRelationships (hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idsChild	String[]	Si(2)	Identificador de los documentos hijo de la relación en Documentum.
csvsChild	String[]	Si(2)	Csv de los documentos hijo de la relacion.
relationship	CCSV_3.5.0_Manual de integración#DocumentRelation 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

Anchor

	ResultCreateRelationships
	ResultCreateRelationships

ResultCreateRelationships(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateRelationships

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
151	ERROR_RELACION_DATOS_NULO	Falta el parámetro con la información de la relación
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAllRelatedDocuments(hereda de ParamBase)
id	String	Si(1)	Id del documento en Documentum cuyas relaciones queremos obtener.
csv	String	si(1)	CSV del documento cuyas relaciones queremos obtener.
role	String[]	No	Rol de las relaciones que queremos obtener.
dateStart	String	No	Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados.
dateEnd	String	No	Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados.
addContent	boolean	Si	Indica si se añaden los contenidos de los documentos.
metadataNames	String[]	No	Nombres de los metadatos que queremos que nos muestre del el objeto Document de vuelta.
searchType	CCSV_3.5.0_Manual de integración#DocumentRelationSearchType 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

Anchor

	ResultGetRelatedDocuments
	ResultGetRelatedDocuments

ResultGetAllRelatedDocuments(hereda de ResultError)

documentTreeNodes

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

Código	Nombre	Descripción
152	ERROR_RELACION_ID_NULO	Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO
153	ERROR_RELACION_TIPOBUSQUEDA_NULO	Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados
148	ERROR_DOCUMENTOS_RELACIONADOS	No se han encontrado documentos relacionados para el documento seleccionado.
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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'

...

Expand

title	Ver detalles

Signatura

ResultAddAgentRelationship addAgentRelationship(ParamAddAgentRelationship paramAddAgentRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddAgentRelationship(hereda de 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 AgentRelationship	Si	Contiene todos los datos de la relación a crear
traceData	CCSV_3.5.0_Manual de integración#TraceData 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

Anchor

	ResultAddAgentRelationship
	ResultAddAgentRelationship

ResultAddAgentRelationship(hereda de ResultError)

Códigos de error

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio.
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU .
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultAddAgentRelationships addAgentRelationships(ParamAddAgentRelationships paramAddAgentRelationships)

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamAddAgentRelationship(hereda de 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 AgentRelationship[]	Contiene todos los datos de la relación a crear
traceData	CCSV_3.5.0_Manual de integración#TraceData TraceData	Datos sobre la traza de la creación de nuevas relaciones para el documento.

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultAddAgentRelationships
	ResultAddAgentRelationships

ResultAddAgentRelationships(hereda de ResultError)

Códigos de error

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio.
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU .
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteAgentRelationship deleteAgentRelationship(ParamDeleteAgentRelationship paramDeleteAgentRelationship);

Parámetros de invocación

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

Anchor

	ResultDeleteAgentRelationship
	ResultDeleteAgentRelationship

ResultDeleteAgentRelationship(hereda de ResultError)

Códigos de error

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
183	ERROR_AGENTRELATIONSHIPIDNULO	Debe especificar el identificador dentro del parámetro agentRelationship
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
185	ERROR_AGENTRELATIONSHIP_NOEXIST	No existe para el documento indicado esa relación agente
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio.
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU .
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultUpdateAgentRelationship updateAgentRelationship(ParamUpdateAgentRelationship paramUpdateAgentRelationship);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateAgentRelationship(hereda de 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 AgentRelationship	Si	Contiene todos los datos de la relación a borrar
traceData	CCSV_3.5.0_Manual de integración#TraceData TraceData	Si	Datos sobre la traza del borrado de la relación.

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultUpdateAgentRelationship
	ResultUpdateAgentRelationship

ResultUpdateAgentRelationship(hereda de ResultError)

Códigos de error

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
182	ERROR_AGENTRELATIONSHIPNULO	Debe especificar algún agentRelationship con los datos de la relación de agente
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
158	ERROR_VERIFY_NOT_VALUELIST	Debe especificar el identificador dentro del parámetro agentRelationship.
191	ERROR_INTEGRATIONAPPLICATION	Error al recuperar la información de la integración de aplicaciones.
190	ERROR_INTERNALACCESS_NOTALLOWED	No está permitido el acceso del nif solicitante al documento indicado.
189	ERROR_INTERNALACCESSCONTROL_NIFINVALID	Debe especificar el nif del solicitante del servicio.
192	ERROR_CONEXION_PAU	Se ha producido un error al realizar la conexión con PAU.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU .
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGetAgentRelationship getAgentRelationship(ParamGetAgentRelationship paramGetAgentRelationship);;

Parámetros de invocación

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

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

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetAgentRelationship
	ResultGetAgentRelationship

ResultGetAgentRelationship(hereda de ResultError)

agentRelationship

CCSV_3.5.0_Manual de integración#AgentRelationship AgentRelationship

Objeto AgentRelationship con el contenido de la relación agente recuperado

Códigos de error

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
184	ERROR_ADD_ROLEORIDENTIFICATIONNUMBER	Debe especificar otro criterio de búsqueda, ya que existen varias relaciones que cumplen el indicado
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGetAgentRelationships getAgentRelationships(ParamGetAgentRelationships paramGetAgentRelationships)

Parámetros de invocación

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

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetAgentRelationships
	ResultGetAgentRelationships

ResultGetAgentRelationships (hereda de ResultError)

agentRelationships

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

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO.
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.
733	ERROR_DOCUMENTO_SUSTITUIDO	El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT
732	ERROR_DOCUMENTO_ANULADO	No se puede recuperar un documento anulado

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGenerateIframeToken generateIframeToken(ParamGenerateIframeToken paramGenerateIframeToken)

Parámetros de invocación

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

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGenerateIframeToken
	ResultGenerateIframeToken

ResultGenerateIframeToken (hereda de ResultError)

token

String

Token que se genera a partir de los datos que se facilitan

Códigos de error

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

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

Ejemplo de invocación

Invocación

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultValidateIframeToken validateIframeToken(ParamValidateIframeToken paramValidateIframeToken);

Parámetros de invocación

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultValidateIframeToken
	ResultValidateIframeToken

ResultValidateIframeToken(hereda de ResultError)

Códigos de error

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

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

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList);

Parámetros de invocación

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

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentSubtypeList (hereda de ResultError)
documentSubtypeList	List<CCSV_3.5.0_Manual de integración#DocumentSubtypeList 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

language	java

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)

...

Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el csv y ademas además podemos indicar los datos que queremos que se nos devuelvan.

...

Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el csv y ademas además podemos indicar los datos que queremos que se nos devuelvan en este caso pasando el atributo addContent como true.

...

Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el id y ademas además podemos indicar los datos que queremos que se nos devuelvan.

...

Se recomienda usar el método getDocument que devuelve los mismos datos si rellenamos el id y ademas además podemos indicar los datos que queremos que se nos devuelvan en este caso pasando el atributo addContent como true.

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#updateDocument updateDocument ya que en caso de querer actualizar los metadatos marcaremos el atributo updateMetadata como true.

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#updateDocument ya updateDocument ya que en caso de querer actualizar los metadatos marcaremos el atributo updateContent como true.

...

Se recomienda usar el método createAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#updateAndVerifySignature updateAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.

...

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

Método 'getRepetitiveSimpleMetadata'

...

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

Método 'getRepetitiveSimpleMetadata'

...

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

Método 'updateSimpleMetadata'

...

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

...

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

...

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

...

Expand

title	Ver detalles

Signatura

ResultCreateDocumentXml createDocumentXml(ParamCreateDocumentXml paramCreateDocumentXml).

Parámetros de invocación

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultCreateDocumentXml
	ResultCreateDocumentXml

ResultCreateDocumentXml(hereda de ResultError)

csv

String

Código csv asociado al documento que se ha creado.

name

String

Nombre del documento que se ha creado.

extension

String

Extension Extensión 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#ResultCreateDocumentXmlen 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

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultCreateIndexXml createIndexXml(ParamCreateIndexXml paramCreateIndexXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateIndexXml (hereda de ParamBase)
xml	DataHandler	Si	Xml del indice.
agent	CCSV_3.5.0_Manual de integración#Agent 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

Anchor

	ResultCreateIndexXml
	ResultCreateIndexXml

ResultCreateIndexXml (hereda de 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.

Anchor

	ResultCreateIndexXml
	ResultCreateIndexXml

Códigos de error

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

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

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

void prepareXmlToInside(ParamPrepareXmlToInside paramPrepareXmlToInside)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamPrepareXmlToInside (hereda de ParamBase)
expedienteCSV	String	Si	CSV del Expediente
codigoDir3	String	Si	Código dir3.
userNif	String	Si	Nif de la persona que realiza la petición.
asunto	String	No	Asunto del xml que se prepara para enviar. Máximo 150 caracteres
adjuntoCSV	String	No	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 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#ResultGetAdministrativeFileResultGetAdministrativeFile

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

language	java

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());
}

...

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

Anchor

	RespuestaAccesoIndiceExpedienteType
	RespuestaAccesoIndiceExpedienteType

RespuestaAccesoIndiceExpedienteType

Códigos de error

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

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

language	java

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

...

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

Anchor

	RespuestaAccesoDocumentoExpedienteType
	RespuestaAccesoDocumentoExpedienteType

RespuestaAccesoDocumentoExpedienteType

Códigos de error

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

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

language	java

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());

...

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

Anchor

	CsvBrokerResultGetDocument
	CsvBrokerResultGetDocument

ResultGetDocument

csvBrokerDocument

CCSV_3.5.0_Manual de integración#CsvBrokerDocument CsvBrokerDocument

Estructura de datos que contiene los datos obtenidos del documento o bien la lista de organismos que pueden contener al organismo asociado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocument

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

Ejemplo de invocación

Invocación

Code Block

language	java

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

...

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.

...

Clase donde se almacena la información de los documentos electrónicos rebida recibida a través de CSVBroker.

Nombre	Tipo	Descripción
documentName	String	Nombre del documento.
documentMime	String	Mime-type del documento
documentContent	byte[]	Contenido del documento
organizationList	List<String>	Lista de organismos que pueden contener el documento asociado al CSV.

...

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

Nombre	Tipo	Descripción
metadata	HashMap<String,Object>	Almacena las propiedades o metadatos de un documento.

...

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

...

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

...

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 Agent	Relación con metadato estructurado de tipo agente.
additionalMetadata	HashMap<String, Object>	Metadatos adicionales.

...

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 AgentContactData[]	Campo que almacenar los datos de contacto del agente.

...

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 Agent	Metadato estructurado para almacenar el agente relacionado
additionalMetadata	HashMap<String, Object>	Metadatos adicionales

...

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

...

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

...

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

...

Nombre	Tipo	Descripción
documentFilterList	CCSV_3.5.0_Manual de integración#DocumentFilter 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.

...

Nombre	Tipo	Descripción
document	Document	Contiene los metadatos asociados al documento
documentRelation	CCSV_3.5.0_Manual de integración#DocumentRelation DocumentRelation	Contiene la relación del documento con el documento con el padre.
documentTreeNodes	CCSV_3.5.0_Manual de integración#DocumentTreeNode DocumentTreeNode[]	Contiene el resto de nodos documentales asociados al actual.

...

Page Comparison

Versions Compared

Old Version 8

New Version 9

Key

Servicio IDocumentMetadataSignatureServicePortType

Métodos de manejo de documentos.

Método 'createFolder'

Invocación

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

Método 'createDocumentLink'

Invocación

Métodos de búsqueda.

Método 'search'

Invocación

Métodos de gestión de metadatos.

Método AnchorinitializeDocumentMetadatainitializeDocumentMetadata'initializeDocumentMetadata'

Invocación

Métodos de gestión de relaciones.

Método 'createRelationship'

Invocación

Invocación

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

Método 'addAgentRelationship'

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Métodos obsoletos

Método 'getRepetitiveSimpleMetadata'

Método 'getRepetitiveSimpleMetadata'

Método 'updateSimpleMetadata'

Servicio ISendAdminFileCloudWSPortType

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Método
Anchor
initializeDocumentMetadata
initializeDocumentMetadata
'initializeDocumentMetadata'